Skip to main content
GET
/
streams
/
{streamId}
Retrieve stream
curl --request GET \
  --url https://{cluster}.cognitedata.com/api/v1/projects/{project}/streams/{streamId} \
  --header 'Authorization: Bearer <token>'
{
  "externalId": "test1",
  "createdTime": 1730204346000,
  "createdFromTemplate": "ImmutableTestStream",
  "type": "Immutable",
  "settings": {
    "lifecycle": {
      "retainedAfterSoftDelete": "P42D",
      "dataDeletedAfter": "P1Y"
    },
    "limits": {
      "maxRecordsTotal": {
        "provisioned": 1000,
        "consumed": 999
      },
      "maxGigaBytesTotal": {
        "provisioned": 1000,
        "consumed": 999
      },
      "maxFilteringInterval": "P1Y"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Path Parameters

​
streamId
string
required

An identifier of the stream where the records are stored.

Required string length: 1 - 100
Pattern: ^[a-z]([a-z0-9_-]{0,98}[a-z0-9])?$
Example:

"test1"

Query Parameters

​
includeStatistics
boolean

If set to true, usage statistics will be returned together with stream settings.

Response

Stream retrieved.

Stream object.

​
externalId
string
required

Stream identifier.

Example:

"test1"

​
createdTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
createdFromTemplate
string
required

Name of the template used for creating this stream. Note: This value is for information only. The template might have been modified or even entirely deleted after the stream has been created.

Example:

"ImmutableTestStream"

​
type
enum<string>
default:Immutable
required

Defines type of the stream. Both Immutable and Mutable streams are available.

Records in an Immutable stream cannot be updated or deleted by the user. Instead, depending on the specific template, they can have a limited life span and be automatically deleted once dataDeletedAfter interval has passed. Immutable streams allow ingestion of very large amounts of data. These streams are most suitable for event or log type data or as a "staging area" for data that needs to be normalized before ingestion into a more permanent storage. Immutable streams are optimized for long-term retention and high-volume ingestion, which results in lower query performance compared to mutable streams.

Records in a Mutable stream can be updated and deleted by the user, but total number of records that can be ingested into such a stream is limited. Mutable streams provide better query performance.

Available options:
Immutable,
Mutable
Example:

"Immutable"

​
settings
settings · object
required

Stream settings.

Last modified on April 23, 2026