Get SSF stream status

GET

/v1/signals/status

curl --request GET \
  --url 'http://localhost:8693/v1/signals/status?stream_id=example'

• Plaintext (dev mode)
• mTLS (production)

Returns the health status of an SSF stream.

Parameters

Query Parameters

stream_id

required

string

Responses

200

Stream status

Media type application/json

object

stream_id

string

status

string

subject

string

Example ^generated

{
  "stream_id": "example",
  "status": "example",
  "subject": "example"
}

400

Missing stream_id

Media type application/json

object

error

required

Error code (RFC 8693 compatible)

string

Allowed values: invalid_request unsupported_grant_type access_denied server_error not_implemented not_found method_not_allowed

error_description

Human-readable error detail

string

Example

{
  "error": "invalid_request"
}

404

Stream not found

Media type application/json

object

error

required

Error code (RFC 8693 compatible)

string

Allowed values: invalid_request unsupported_grant_type access_denied server_error not_implemented not_found method_not_allowed

error_description

Human-readable error detail

string

Example

{
  "error": "invalid_request"
}