openapi
Apis
Control

ControlApi

activateVersion

Request

PATCH https://api.dataspray.io/v1/organization/{organizationName}/control/task/{taskId}/activate (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
taskIdPathString[default to null]
versionQueryString[default to null]

Response TaskStatus

delete

Request

DELETE https://api.dataspray.io/v1/organization/{organizationName}/control/task/{taskId}/delete (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
taskIdPathString[default to null]

Response TaskStatus

deleteTopic

Request

DELETE https://api.dataspray.io/v1/organization/{organizationName}/topic/{topicName} (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
topicNamePathString[default to null]
expectedVersionQueryLong[optional] [default to null]

Response Topics

deployVersion

Request

PATCH https://api.dataspray.io/v1/organization/{organizationName}/control/task/{taskId}/deploy/{sessionId} (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
taskIdPathString[default to null]
sessionIdPathString[default to null]
InvocationTypeHeaderString[default to null]
DeployRequestBodyDeployRequest

Response TaskVersion

deployVersionCheck

Request

GET https://api.dataspray.io/v1/organization/{organizationName}/control/task/{taskId}/deploy/{sessionId} (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
taskIdPathString[default to null]
sessionIdPathString[default to null]

Response DeployVersionCheckResponse

getTopicSchema

Request

GET https://api.dataspray.io/v1/organization/{organizationName}/topic/{topicName}/schema (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
topicNamePathString[default to null]

Response TopicSchema

getTopics

Request

GET https://api.dataspray.io/v1/organization/{organizationName}/topics (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]

Response Topics

getVersions

Request

GET https://api.dataspray.io/v1/organization/{organizationName}/control/task/{taskId}/versions (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
taskIdPathString[default to null]

Response TaskVersions

pause

Request

PATCH https://api.dataspray.io/v1/organization/{organizationName}/control/task/{taskId}/pause (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
taskIdPathString[default to null]

Response TaskStatus

resume

Request

PATCH https://api.dataspray.io/v1/organization/{organizationName}/control/task/{taskId}/resume (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
taskIdPathString[default to null]

Response TaskStatus

status

Request

GET https://api.dataspray.io/v1/organization/{organizationName}/control/task/{taskId}/status/ (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
taskIdPathString[default to null]

Response TaskStatus

statusAll

Request

GET https://api.dataspray.io/v1/organization/{organizationName}/control/status (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
cursorQueryString[optional] [default to null]

Response TaskStatuses

updateDefaultTopic

Request

PATCH https://api.dataspray.io/v1/organization/{organizationName}/topic/default (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
UpdateDefaultTopicRequestBodyUpdateDefaultTopicRequest
expectedVersionQueryLong[optional] [default to null]

Response Topics

updateTopic

Request

PATCH https://api.dataspray.io/v1/organization/{organizationName}/topic/{topicName} (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
topicNamePathString[default to null]
TopicBodyTopic
expectedVersionQueryLong[optional] [default to null]

Response Topics

updateTopicSchema

Request

PUT https://api.dataspray.io/v1/organization/{organizationName}/topic/{topicName}/schema (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
topicNamePathString[default to null]
UpdateTopicSchemaRequestBodyUpdateTopicSchemaRequest

Response null (empty response body)

uploadCode

Request

PUT https://api.dataspray.io/v1/organization/{organizationName}/control/code/upload (opens in a new tab)

NameInTypeNotes
organizationNamePathString[default to null]
UploadCodeRequestBodyUploadCodeRequest

Response UploadCodeResponse