List subscriptions

GET/subscriptions

Send to the stream’s endpoint, https://<stream_id>.k2.cloudflarestorage.com. List the subscriptions on the stream, oldest first. Requires an API token with K2 consume permission. To also see each subscription’s consumer lag, use List subscriptions with consumer lag.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

Query ParametersExpand Collapse

name: optional string

Filters by the exact subscription name, so the list has at most one subscription.

ReturnsExpand Collapse

errors: array of object { message, code }

message: string

code: optional number

messages: array of object { message, code }

message: string

code: optional number

result: array of object { id, created_at, modified_at, 2 more }

id: string

Specifies the ID of the subscription.

created_at: string

formatdate-time

modified_at: string

formatdate-time

name: string

start_at: object { type }

type: "earliest" or "latest"

One of the following:

"earliest"

"latest"

success: boolean

Indicates whether the API call was successful.

List subscriptions

curl "https://{stream_id}.k2.cloudflarestorage.com/subscriptions" \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN"

{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": [
    {
      "id": "7c1e9b2a4d6f4e8a9b0c1d2e3f4a5b6c",
      "created_at": "2019-12-27T18:11:19.117Z",
      "modified_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "start_at": {
        "type": "earliest"
      }
    }
  ],
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "messages": [
    {
      "message": "message",
      "code": 0
    }
  ],
  "result": [
    {
      "id": "7c1e9b2a4d6f4e8a9b0c1d2e3f4a5b6c",
      "created_at": "2019-12-27T18:11:19.117Z",
      "modified_at": "2019-12-27T18:11:19.117Z",
      "name": "name",
      "start_at": {
        "type": "earliest"
      }
    }
  ],
  "success": true
}