List data stream configurations of your organization

[
  {
    "id": "689d97ba",
    "destination": {
      "connection_type": "AwsKinesis",
      "format": "Json",
      "credentials": {
        "region": "eu-west-1",
        "role_arn": "arn:aws:iam::123456789012:role/my-data-stream",
        "stream_name": "my-data-stream"
      }
    },
    "filters": [],
    "data_stream_type": {
      "description": "Usage",
      "id": 1
    },
    "relation_resolution": {
      "description": "Both",
      "id": 3
    },
    "status": {
      "description": "Running",
      "id": 1
    }
  },
  {
    "id": "123bc456",
    "destination": {
      "connection_type": "RestAPI",
      "format": "Json",
      "credentials": {
        "size": 3000,
        "url": "https://example.com"
      }
    },
    "filters": [],
    "data_stream_type": {
      "description": "Usage",
      "id": 1
    },
    "relation_resolution": {
      "description": "Own",
      "id": 1
    },
    "status": {
      "description": "Paused",
      "id": 2
    }
  }
]

DataStream + List

Roles: Administrator User Observer

Authentication

AuthorizationBearer

An auth_token should be provided to authenticate a session.

To obtain an auth_token, see the /api/v1/authenticate POST request.

Response

List of data stream with their current status

idstringOptional

ID of the data stream

namestringOptional

Descriptive name or purpose of the data stream

destinationobjectOptional

filterslist of objectsOptional

Conditions to filter the streamed data.

data_stream_typeanyOptional

relation_resolutionanyOptional

statusanyOptional

Errors

401

Unauthorized Error

403

Forbidden Error