List signals.

Required capabilities: subscribeSignalsAcl:READ

List all signals for a sink.

Securityoidc-token or oauth2-client-credentials or oauth2-open-industrial-data or oauth2-auth-code
Request
header Parameters
cdf-version
string

cdf version header. Use this to specify the requested CDF release.

Example: alpha
Request Body schema: application/json
required

Filter for signals to list.

required
EmailSinkId (object) or UserSinkId (object) or CurrentUserSinkId (object) (RefSinkId)
topic
string (SupportedTopics)

Topics supported by the service. The cognite_sandbox topic is a permissive topic intended for prototyping and testing, not for production traffic.

Enum: "cognite_integrations" "cognite_workflows" "cognite_hosted_extractors" "cognite_sandbox" "cognite_comment_notifications"
cursor
string

Cursor for pagination. This cursor is temporary hence should not be saved.

limit
integer [ 1 .. 1000 ]
Default: 100

Maximum number of signals to return.

Responses
200

A list of signals available for the sink.

400

The response for a bad request.

422

Validation Error

post/processes/signals/list
Request samples
application/json
{
  • "sink": {
    • "type": "email",
    • "externalId": "my.known.id"
    },
  • "topic": "cognite_integrations",
  • "cursor": "string",
  • "limit": 100
}
Response samples
application/json
{
  • "items": [
    • {
      }
    ],
  • "nextCursor": "string"
}
➔ Next to List sinks