Atlas stream

4 endpoints at a glance

Method	Path	Summary
GET	/atlas-stream/status/	Get Status
POST	/atlas-stream/subscriptions/	Create Subscription
DELETE	/atlas-stream/subscriptions/{sub_id}/	Delete Subscription
PATCH	/atlas-stream/subscriptions/{sub_id}/	Patch Subscription

atlas-stream

---

Get Status

GET

/atlas-stream/status/

Upstream connection state + per-scope counters + the persisted
subscription rows. One call drives the admin panel.

Parameters

Header Parameters

authorization

x-api-key

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

GET

/atlas-stream/status/

Playground

Headers

authorization

x-api-key

Samples

---

Create Subscription

POST

/atlas-stream/subscriptions/

Register (idempotent) a scoped result subscription. 400 on an
unscoped scope or unknown sink.

Parameters

Header Parameters

authorization

x-api-key

Request Body

application/json

{

  

"msm_id": 0,

  

"prb_id": 0,

  

"type": "string",

  

"sink": "string",

  

"enabled": true

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

POST

/atlas-stream/subscriptions/

Playground

Headers

authorization

x-api-key

Body

Samples

---

Delete Subscription

DELETE

/atlas-stream/subscriptions/{sub_id}/

Parameters

Header Parameters

authorization

x-api-key

Path Parameters

sub_id*

Type

string

Required

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

DELETE

/atlas-stream/subscriptions/{sub_id}/

Playground

Headers

authorization

x-api-key

Variables

Key

Value

sub_id*

Samples

---

Patch Subscription

PATCH

/atlas-stream/subscriptions/{sub_id}/

Parameters

Header Parameters

authorization

x-api-key

Path Parameters

sub_id*

Type

string

Required

Request Body

application/json

{

  

"enabled": true

}

Responses

Successful Response

Content-Type

application/json

{

  

"additionalProperties": "string"

}

PATCH

/atlas-stream/subscriptions/{sub_id}/

Playground

Headers

authorization

x-api-key

Variables

Key

Value

sub_id*

Body

Samples

---