Streams
Cancel
API Documentation
Schemas
- Egress
- Export
- Websocket
- Webhook
- HTTP Gateway
- Errors
Authentication
Gateway
Webhooks
Export
Stream configuration
Processor
Streams
Cancel
Cancels a stream. This operation can be performed by a gateway, on behalf of the user
PUT
/
stream-service
/
api
/
v1
/
streams
/
{streamId}
/
cancel
curl --request PUT \
--url https://stream-service.vatis.tech/stream-service/api/v1/streams/{streamId}/cancel \
--header 'Authorization: Bearer <token>'
{
"streamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"configuration": {
"streamConfigurationTemplateId": "<string>",
"dataSource": {
"topic": "<string>",
"messageSchema": "<string>",
"connectionOptions": {},
"headers": {},
"messageHeaders": {},
"subscriptions": {}
},
"dataSinks": {},
"processors": [
{
"id": "<string>",
"source": {
"subscription": "<string>",
"topic": "<string>",
"messageSchema": "<string>",
"connectionOptions": {},
"headers": {}
},
"destination": {
"topic": "<string>",
"messageSchema": "<string>",
"connectionOptions": {},
"headers": {},
"messageHeaders": {},
"subscriptions": {}
},
"clusterDomainName": "<string>",
"podsDiscoveryClusterDomainName": "<string>",
"propertiesSchema": "<string>",
"properties": {},
"egress": {
"persist": true,
"sink": true,
"tags": [
"<string>"
]
}
}
],
"dynamicWebhookEndpoints": [
{
"id": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"enabled": true,
"description": "<string>"
}
]
},
"createdTimestamp": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"groupCreatorId": "<string>",
"state": "READY",
"stateDescription": "<string>",
"finalizedTimestamp": "2023-11-07T05:31:56Z"
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Stream canceled successfully
Available options:
READY
, COMPLETED
, FAILED
, EXPIRED
curl --request PUT \
--url https://stream-service.vatis.tech/stream-service/api/v1/streams/{streamId}/cancel \
--header 'Authorization: Bearer <token>'
{
"streamId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"configuration": {
"streamConfigurationTemplateId": "<string>",
"dataSource": {
"topic": "<string>",
"messageSchema": "<string>",
"connectionOptions": {},
"headers": {},
"messageHeaders": {},
"subscriptions": {}
},
"dataSinks": {},
"processors": [
{
"id": "<string>",
"source": {
"subscription": "<string>",
"topic": "<string>",
"messageSchema": "<string>",
"connectionOptions": {},
"headers": {}
},
"destination": {
"topic": "<string>",
"messageSchema": "<string>",
"connectionOptions": {},
"headers": {},
"messageHeaders": {},
"subscriptions": {}
},
"clusterDomainName": "<string>",
"podsDiscoveryClusterDomainName": "<string>",
"propertiesSchema": "<string>",
"properties": {},
"egress": {
"persist": true,
"sink": true,
"tags": [
"<string>"
]
}
}
],
"dynamicWebhookEndpoints": [
{
"id": "<string>",
"url": "<string>",
"events": [
"<string>"
],
"enabled": true,
"description": "<string>"
}
]
},
"createdTimestamp": "2023-11-07T05:31:56Z",
"creatorId": "<string>",
"groupCreatorId": "<string>",
"state": "READY",
"stateDescription": "<string>",
"finalizedTimestamp": "2023-11-07T05:31:56Z"
}