DEdecodable
Stream Operations

Get a list of streams.

Result only includes resources for which the requesting user has permission matching: stream:read:default.<name>.

get/streams

Request

  • Base URL
    https://replace-with-account.api.decodable.co/v1alpha2
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization codehttps://auth.decodable.co/authorize?audience=https://api.decodable.co/
      Token URLhttps://auth.decodable.co/oauth/token
      Scopesread:stream
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Query parameters

page_sizeinteger
Example:100

The maximum number of items to return.

page_tokenstring
Example:token1

A token that indicates the page to fetch.

view'basic' | 'full'

The amount of data to return for the resource(s).

A value of basic returns the standard properties of the resource. It may also produce data that is considered "computationally cheap" to return. Specifying basic is the same as omitting this parameter.

The behavior of full is service-dependent, but generally includes more fields. This can mean additional status or version data, or even expanding references to contained resources. This should be used when the cost of an additional API roundtrip is greater than the overhead of the request.

response_schema_v'v1' | 'v2'

The response schema version to use. Defaults to v1. When v1, the response will include the schema field. When v2, the response will include the schema_v2 field.

A POSIX regular expression pattern used to filter the fetched streams by name.

Response

A list of streams.

next_page_tokenstring

A token that, that when passed to a subsequent call as page_token, will return the next page of results.

Example response

{
  "items": [
    {
      "id": "abcd1234"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.