integrations

Get data stream statuses

<Info icon="fa-light fa-lock" className="permission-callout"> <div className="permission-callout__header"><span className="permission-callout__title"><span className="permission-callout__label">Required permissions</span> <span className="fern-docs-badge small blue subtle rounded-full permission-callout__beta">Beta</span></span> <span className="permission-callout__learn-more">[Learn more](/developers/api-guidelines/permissions#how-permissions-work)</span></div>

DataStream.Status + List

<div className="permission-callout__roles"><span className="permission-callout__roles-label">Roles:</span> <Badge intent="info">Administrator</Badge> <Badge intent="info">User</Badge> <Badge intent="info">Observer</Badge></div> </Info>

Lists possible data stream statuses.

(1) is the normal Running state meaning your data stream is active and streams data.

(2) indicates a Paused data stream. It will not send messages to your destination. However, messages meant for this data stream are routed and will be stored up to 7 days. You will first receive historic data once you resume a paused streamer after longer pausing.

(3) indicates that an Error has occurred. This might be problems in the configuration (e.g. missing permissions) or your destination has been unavailable for a longer period of time and the data stream exceeded maximum retries. You may restart the streamer in order to fix a temporary problem, misconfigured streamers will continue to fail.

(4) is a Pending state. Your data stream has not been initialized, yet. This state may occur for a very short time.

get/api/v2/data_stream/status

Request

  • Base URL: https://cdn.emnify.net
  • URL: https://cdn.emnify.net/api/v2/data_stream/status
  • Auth: HTTP bearer

Response

Possible connection statuses

idnumber double

Enum item identifier

descriptionstring

Enum item description

Changes

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