Streams v3beta1
Use the Streams service to perform create, read, update, and delete (CRUD) operations on your data pipeline. The Streams service also has metrics and preview session endpoints and gives you full control over your data pipeline.
API Base URL
https://{host}:31000/default/streams/v3beta1
Copy to clipboardRequired Scope
streams.connections.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
Query Parameters
Name | Description |
---|---|
connectorId array | |
functionId string | |
createUserId string | |
name string | |
offset integer | |
pageSize integer | |
sortField string | |
sortDir string | Specify either ascending ('asc') or descending ('desc') sort order for a given field (sortField), which must be set for sortDir to apply. Defaults to 'asc'. |
showSecretNames string |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/connections" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns a list of connections. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PaginatedResponseOfConnectionResponse
items: [
{ConnectionResponse
], activePipelinesUsing: [],
connectorId: "<string>",
connectorName: "<string>",
createDate: <integer>,
createUserId: "<string>",
id: "<string>",
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
versions: []
} total: <integer>
}Required Scope
streams.connections.create
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/connections" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"connectorId": "<string>",
"data": {},
"description": "<string>",
"name": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{ConnectionRequest }, }
// The ID of the parent connector.
connectorId*: "<string>", // The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
data*: { // The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
<key>: <any> // The description of the connection.
description*: "<string>", // The name of the connection.
name*: "<string>" Responses
Code | Description |
---|---|
201 | The connection was created successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{ConnectionSaveResponse
connectorId: "<string>",
createDate: <integer>,
createUserId: "<string>",
data: {
<key>: <any>
}, description: "<string>",
id: "<string>",
name: "<string>",
version: <integer>
}Required Scope
streams.connections.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
connectionId string | Connection ID |
cURL
HTTP
curl -X PUT "https://{host}:31000/{tenant}/streams/v3beta1/connections/{connectionId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"data": {},
"description": "<string>",
"name": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{ConnectionPutRequest }, }
// The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
data*: { // The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
<key>: <any> // The description of the connection.
description*: "<string>", // The name of the connection.
name*: "<string>" Responses
Code | Description |
---|---|
200 | The connection was updated successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{ConnectionSaveResponse
connectorId: "<string>",
createDate: <integer>,
createUserId: "<string>",
data: {
<key>: <any>
}, description: "<string>",
id: "<string>",
name: "<string>",
version: <integer>
}Required Scope
streams.connections.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
connectionId string | Connection ID |
cURL
HTTP
curl -X PATCH "https://{host}:31000/{tenant}/streams/v3beta1/connections/{connectionId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"data": {},
"description": "<string>",
"name": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{ConnectionPatchRequest }, }
// The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
data*: { // The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded.
<key>: <any> // The description of the connection.
description*: "<string>", // The name of the connection.
name*: "<string>" Responses
Code | Description |
---|---|
200 | The connection was modified successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{ConnectionSaveResponse
connectorId: "<string>",
createDate: <integer>,
createUserId: "<string>",
data: {
<key>: <any>
}, description: "<string>",
id: "<string>",
name: "<string>",
version: <integer>
}Required Scope
streams.connections.delete
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
connectionId string | Connection ID |
cURL
HTTP
curl -X DELETE "https://{host}:31000/{tenant}/streams/v3beta1/connections/{connectionId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
204 | The connection was deleted successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema
Empty
Required Scope
streams.connections.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/connectors" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns a list of connectors. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PaginatedResponseOfConnectorResponse
items: [
{ConnectorResponse
], config: {},
connectorType: "<string>",
description: "<string>",
functions: [],
hidden: true | false,
id: "<string>",
name: "<string>",
panelUrl: "<string>",
tag: "<string>"
} total: <integer>
}Required Scope
streams.files.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/files" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns files metadata. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{FilesMetaDataResponse
files: [
} {UploadFile
] createdDate: <integer>,
createdUserId: "<string>",
filename: "<string>",
id: "<string>",
sha256: "<string>",
tenantId: "<string>"
}Required Scope
streams.files.create
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/files" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"file": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{}
// Upload file
file*: "<string>" Responses
Code | Description |
---|---|
201 | Upload a file. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{UploadFile
createdDate: <integer>,
createdUserId: "<string>",
filename: "<string>",
id: "<string>",
sha256: "<string>",
tenantId: "<string>"
}Required Scope
streams.files.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
fileId string | File ID |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/files/{fileId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns files metadata. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{UploadFile
createdDate: <integer>,
createdUserId: "<string>",
filename: "<string>",
id: "<string>",
sha256: "<string>",
tenantId: "<string>"
}Required Scope
streams.files.delete
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
fileId string | File ID |
cURL
HTTP
curl -X DELETE "https://{host}:31000/{tenant}/streams/v3beta1/files/{fileId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
204 | File deleted successfully |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema
Empty
Required Scope
streams.license.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/license" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns the existing license. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{LicenseResponse
license: {
} <key>: <any>
} Required Scope
streams.license.upload
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/license" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"licenseFile": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{}
// license file
licenseFile*: "<string>" Responses
Code | Description |
---|---|
201 | The license was uploaded successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{LicenseResponse
license: {
} <key>: <any>
} Required Scope
streams.lookups.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
connectionId string | Connection ID |
Query Parameters
Name | Description |
---|---|
size integer | size |
offset integer | offset |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/lookups/{connectionId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns lookup table results. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{LookupTableResponse
data: [
{
], <key>: <any>
} types: {
} <key>: "<string>"
} Required Scope
streams.pipelines.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
Query Parameters
Name | Description |
---|---|
offset integer | offset |
pageSize integer | pageSize |
sortField string | sortField |
sortDir string | sortDir |
activated boolean | activated |
createUserId string | createUserId |
name string | name |
includeData boolean | includeData |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/pipelines" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns a list of pipelines. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PaginatedResponseOfPipelineResponse
items: [
{PipelineResponse
], activatedDate: <integer>,
activatedUserId: "<string>",
activatedVersion: <integer>,
createDate: <integer>,
createUserId: "<string>",
currentVersion: <integer>,
data: {Pipeline },
description: "<string>",
id: "<string>",
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
status: "CREATED" | "ACTIVATED" | "FAILED" | "RESTARTING" | "FINISHED",
statusMessage: "<string>",
streamingConfigurationId: <integer>,
tenantId: "<string>",
validationMessages: [],
version: <integer>
} total: <integer>
}Required Scope
streams.pipelines.create
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/pipelines" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"data": {
"edges": [
{
"sourceNode": "<string>",
Copy to clipboard
...
Request Body Schema (json)
{PipelineRequest }
data*: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} // The name of the pipeline.
name*: "<string>", // Set to true to bypass initial pipeline validation upon creation. The pipeline still needs to be validated before activation. Defaults to false.
bypassValidation: true | false, // The description of the pipeline. Defaults to null.
description: "<string>" Responses
Code | Description |
---|---|
201 | The pipeline was created successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PipelineResponse
activatedDate: <integer>,
activatedUserId: "<string>",
activatedVersion: <integer>,
createDate: <integer>,
createUserId: "<string>",
currentVersion: <integer>,
data: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} description: "<string>",
id: "<string>",
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
status: "CREATED" | "ACTIVATED" | "FAILED" | "RESTARTING" | "FINISHED",
statusMessage: "<string>",
streamingConfigurationId: <integer>,
tenantId: "<string>",
validationMessages: [
"<string>"
], version: <integer>
}Required Scope
streams.pipelines.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/compile" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"spl": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{SplCompileRequest }
// The SPL2 representation of a pipeline or function parameters.
spl*: "<string>", // A boolean flag to indicate whether the pipeline should be validated.
validate: true | false Responses
Code | Description |
---|---|
200 | Returns the compiled pipeline. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge
], sourceNode: "<string>",
sourcePort: "<string>",
targetNode: "<string>",
targetPort: "<string>"
} // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // A unique identifier for the function.
id*: "<string>", // The operation name.
op*: "<string>", // Function arguments keyed by argument name.
arguments: {}, // For internal use only. This field is ignored.
attributes: {}, // The identifier describing the operation name and required argument types. This field is ignored.
resolvedId: "<string>", // If present, creates a named statement when decompiling to SPL2. For example, "$events = | from splunk_firehose();".
statementName: "<string>" // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
} canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} Required Scope
streams.pipelines.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/decompile" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"upl": {
"edges": [
{
"sourceNode": "<string>",
Copy to clipboard
...
Request Body Schema (json)
{DecompileRequest
upl*: {Pipeline },
} // A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
} canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} Responses
Code | Description |
---|---|
200 | Returns the compiled pipeline. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{DecompileResponse
spl: "<string>"
}Required Scope
streams.pipelines.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/input-schema" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"nodeUuid": "<string>",
"targetPortName": "<string>",
"uplJson": {
"edges": [
Copy to clipboard
...
Request Body Schema (json)
{GetInputSchemaRequest
// The function ID.
nodeUuid*: "<string>", // The name of the input port.
targetPortName*: "<string>", uplJson*: {Pipeline },
} // A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
} canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} Responses
Code | Description |
---|---|
200 | Returns the input schema for a specified function. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{UplType
fieldName: "<string>",
parameters: [
{ UplType }
], type: "<string>"
}Required Scope
streams.pipelines.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/output-schema" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"uplJson": {
"edges": [
{
"sourceNode": "<string>",
Copy to clipboard
...
Request Body Schema (json)
{GetOutputSchemaRequest }
uplJson*: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} // The function ID. If omitted, returns the output schema for all functions.
nodeUuid: "<string>", // The name of the output port. Deprecated.
sourcePortName: "<string>" Responses
Code | Description |
---|---|
200 | Returns the output schema for a specified function. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{
<key>: {UplType
} fieldName: "<string>",
parameters: [
{ UplType }
], type: "<string>"
}Required Scope
streams.pipelines.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
Query Parameters
Name | Description |
---|---|
local boolean | local |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/registry" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns a list of functions. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{RegistryModel
categories: [
"<string>"
], functions: [
} {FunctionModel
] arguments: [],
attributes: {},
op: "<string>",
outputs: [],
resolvedId: "<string>"
}Required Scope
streams.pipelines.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
Query Parameters
Name | Description |
---|---|
offset integer | offset |
pageSize integer | pageSize |
sortField string | sortField |
sortDir string | sortDir |
activated boolean | activated |
createUserId string | createUserId |
name string | name |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/status" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns the current status of the pipeline. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PaginatedResponseOfPipelineJobStatus
items: [
{PipelineJobStatus
], jobId: "<string>",
jobStatus: "<string>",
pipelineId: "<string>"
} total: <integer>
}Required Scope
streams.pipelines.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/validate" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"upl": {
"edges": [
{
"sourceNode": "<string>",
Copy to clipboard
...
Request Body Schema (json)
{ValidateRequest
upl*: {Pipeline },
} // A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
} canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} Responses
Code | Description |
---|---|
200 | The pipeline is valid. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{ValidateResponse
nodeId: "<string>",
spl: "<string>",
success: true | false,
validationMessages: [
} "<string>"
] Required Scope
streams.pipelines.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
id string | Pipeline ID |
Query Parameters
Name | Description |
---|---|
version string | version |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/{id}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns the pipeline with the specified id. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PipelineResponse
activatedDate: <integer>,
activatedUserId: "<string>",
activatedVersion: <integer>,
createDate: <integer>,
createUserId: "<string>",
currentVersion: <integer>,
data: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} description: "<string>",
id: "<string>",
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
status: "CREATED" | "ACTIVATED" | "FAILED" | "RESTARTING" | "FINISHED",
statusMessage: "<string>",
streamingConfigurationId: <integer>,
tenantId: "<string>",
validationMessages: [
"<string>"
], version: <integer>
}Required Scope
streams.pipelines.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
id string | Pipeline ID |
cURL
HTTP
curl -X PUT "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/{id}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"data": {
"edges": [
{
"sourceNode": "<string>",
Copy to clipboard
...
Request Body Schema (json)
{PipelineRequest }
data*: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} // The name of the pipeline.
name*: "<string>", // Set to true to bypass initial pipeline validation upon creation. The pipeline still needs to be validated before activation. Defaults to false.
bypassValidation: true | false, // The description of the pipeline. Defaults to null.
description: "<string>" Responses
Code | Description |
---|---|
200 | The pipeline was updated successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PipelineResponse
activatedDate: <integer>,
activatedUserId: "<string>",
activatedVersion: <integer>,
createDate: <integer>,
createUserId: "<string>",
currentVersion: <integer>,
data: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} description: "<string>",
id: "<string>",
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
status: "CREATED" | "ACTIVATED" | "FAILED" | "RESTARTING" | "FINISHED",
statusMessage: "<string>",
streamingConfigurationId: <integer>,
tenantId: "<string>",
validationMessages: [
"<string>"
], version: <integer>
}Required Scope
streams.pipelines.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
id string | Pipeline ID |
cURL
HTTP
curl -X PATCH "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/{id}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"bypassValidation": true,
"createUserId": "<string>",
"data": {
"edges": [
Copy to clipboard
...
Request Body Schema (json)
{PipelinePatchRequest }
// Set to true to bypass initial pipeline validation upon creation. The pipeline still needs to be validated before activation. Defaults to false.
bypassValidation*: true | false, // The user that created the pipeline. Deprecated.
createUserId*: "<string>", data*: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} // The description of the pipeline. Defaults to null.
description*: "<string>", // The name of the pipeline.
name*: "<string>" Responses
Code | Description |
---|---|
200 | The pipeline was modified successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PipelineResponse
activatedDate: <integer>,
activatedUserId: "<string>",
activatedVersion: <integer>,
createDate: <integer>,
createUserId: "<string>",
currentVersion: <integer>,
data: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} description: "<string>",
id: "<string>",
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
status: "CREATED" | "ACTIVATED" | "FAILED" | "RESTARTING" | "FINISHED",
statusMessage: "<string>",
streamingConfigurationId: <integer>,
tenantId: "<string>",
validationMessages: [
"<string>"
], version: <integer>
}Required Scope
streams.pipelines.delete
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
id string | Pipeline ID |
cURL
HTTP
curl -X DELETE "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/{id}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
204 | The pipeline was deleted successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema
Empty
Required Scope
streams.pipelines.activate
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
id string | Pipeline ID |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/{id}/activate" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"activateLatestVersion": true,
"allowNonRestoredState": true,
"skipRestoreState": true
}'
Copy to clipboard
Request Body Schema (json)
{ActivatePipelineRequest }
// Set to true to activate the latest version of the pipeline. Set to false to use the previously activated version of the pipeline. Defaults to true.
activateLatestVersion*: true | false, // Set to true to allow the pipeline to ignore any unused progress states. In some cases, when a data pipeline is changed, the progress state will be stored for functions that no longer exist, so this must be set to activate a pipeline in this state. Defaults to false.
allowNonRestoredState*: true | false, // Set to true to start reading from the latest input rather than from where the pipeline's previous run left off, which can cause data loss. Defaults to false.
skipRestoreState*: true | false Responses
Code | Description |
---|---|
200 | The pipeline was activated successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Response }
// Only set for /activate endpoint
activated: "<string>", // Only set for /deactivate endpoint
deactivated: "<string>" Required Scope
streams.pipelines.deactivate
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
id string | Pipeline ID |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/{id}/deactivate" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"skipSavepoint": true
}'
Copy to clipboard
Request Body Schema (json)
{DeactivatePipelineRequest }
// Set to true to skip saving the state of a deactivated pipeline. When the pipeline is later activated, it will start with the newest data and skip any data that arrived after this deactivation, which can cause data loss. Defaults to false.
skipSavepoint*: true | false Responses
Code | Description |
---|---|
200 | The pipeline was deactivated successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Response }
// Only set for /activate endpoint
activated: "<string>", // Only set for /deactivate endpoint
deactivated: "<string>" Required Scope
streams.pipelines.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
id string | Pipeline ID |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/{id}/metrics/latest" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns the latest metrics for a specified pipeline. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{MetricsResponse
nodes: {
} <key>: {NodeMetrics
} metrics: {}
}Required Scope
streams.pipelines.activate
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
id string | Pipeline ID |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/pipelines/{id}/reactivate" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"allowNonRestoredState": true,
"skipRestoreState": true
}'
Copy to clipboard
Request Body Schema (json)
{ReactivatePipelineRequest }
// Set to true to allow the pipeline to ignore any unused progress states. In some cases, when a data pipeline is changed, the progress state will be stored for functions that no longer exist, so this must be set to reactivate a pipeline in this state. Defaults to false.
allowNonRestoredState*: true | false, // Set to true to start reading from the latest input rather than from where the pipeline's previous run left off, which can cause data loss. Defaults to false.
skipRestoreState*: true | false Responses
Code | Description |
---|---|
200 | The pipeline was reactivated successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PipelineReactivateResponse
currentlyActiveVersion: <integer>,
pipelineId: "<string>",
pipelineReactivationStatus: "activated" | "currentVersionInvalid" | "failedToDeactivateCurrentVersion" | "notActivated" | "rolledBack" | "rolledBackError"
}Required Scope
streams.plugins.read
Query Parameters
Name | Description |
---|---|
offset integer | offset |
pageSize integer | pageSize |
sortField string | sortField |
sortDir string | sortDir |
cURL
HTTP
curl -X GET "https://{host}:31000/system/streams/v3beta1/plugins" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns all the plugins. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PaginatedResponseOfPlugin
items: [
{Plugin
], description: "<string>",
isDeleted: true | false,
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
pluginId: "<string>",
tenantId: "<string>"
} total: <integer>
}Required Scope
streams.plugins.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
Query Parameters
Name | Description |
---|---|
offset integer | offset |
pageSize integer | pageSize |
sortField string | sortField |
sortDir string | sortDir |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/plugins" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns all the plugins. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PaginatedResponseOfPlugin
items: [
{Plugin
], description: "<string>",
isDeleted: true | false,
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
pluginId: "<string>",
tenantId: "<string>"
} total: <integer>
}Required Scope
streams.plugins.create
cURL
HTTP
curl -X POST "https://{host}:31000/system/streams/v3beta1/plugins" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"description": "<string>",
"name": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{PluginRequest }
// Plugin description
description*: "<string>", // Plugin name
name*: "<string>" Responses
Code | Description |
---|---|
201 | The plugin was registered successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Plugin
description: "<string>",
isDeleted: true | false,
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
pluginId: "<string>",
tenantId: "<string>"
}Required Scope
streams.plugins.create
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/plugins" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"description": "<string>",
"name": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{PluginRequest }
// Plugin description
description*: "<string>", // Plugin name
name*: "<string>" Responses
Code | Description |
---|---|
201 | The plugin was registered successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Plugin
description: "<string>",
isDeleted: true | false,
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
pluginId: "<string>",
tenantId: "<string>"
}Required Scope
streams.plugins.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
pluginId string | Plugin ID |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/plugins/{pluginId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns a plugin for the specified id. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Plugin
description: "<string>",
isDeleted: true | false,
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
pluginId: "<string>",
tenantId: "<string>"
}Required Scope
streams.plugins.update
Path Variables
Name | Description |
---|---|
pluginId string | Plugin ID |
cURL
HTTP
curl -X PUT "https://{host}:31000/system/streams/v3beta1/plugins/{pluginId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"description": "<string>",
"name": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{PluginRequest }
// Plugin description
description*: "<string>", // Plugin name
name*: "<string>" Responses
Code | Description |
---|---|
200 | The plugin was updated successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Plugin
description: "<string>",
isDeleted: true | false,
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
pluginId: "<string>",
tenantId: "<string>"
}Required Scope
streams.plugins.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
pluginId string | Plugin ID |
cURL
HTTP
curl -X PUT "https://{host}:31000/{tenant}/streams/v3beta1/plugins/{pluginId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"description": "<string>",
"name": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{PluginRequest }
// Plugin description
description*: "<string>", // Plugin name
name*: "<string>" Responses
Code | Description |
---|---|
200 | The plugin was updated successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Plugin
description: "<string>",
isDeleted: true | false,
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
pluginId: "<string>",
tenantId: "<string>"
}Required Scope
streams.plugins.update
Path Variables
Name | Description |
---|---|
pluginId string | Plugin ID |
cURL
HTTP
curl -X PATCH "https://{host}:31000/system/streams/v3beta1/plugins/{pluginId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"description": "<string>",
"name": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{PluginPatchRequest }
// Plugin description
description*: "<string>", // Plugin name
name*: "<string>" Responses
Code | Description |
---|---|
200 | The plugin was modified successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Plugin
description: "<string>",
isDeleted: true | false,
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
pluginId: "<string>",
tenantId: "<string>"
}Required Scope
streams.plugins.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
pluginId string | Plugin ID |
cURL
HTTP
curl -X PATCH "https://{host}:31000/{tenant}/streams/v3beta1/plugins/{pluginId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"description": "<string>",
"name": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{PluginPatchRequest }
// Plugin description
description*: "<string>", // Plugin name
name*: "<string>" Responses
Code | Description |
---|---|
200 | The plugin was modified successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{Plugin
description: "<string>",
isDeleted: true | false,
lastUpdateDate: <integer>,
lastUpdateUserId: "<string>",
name: "<string>",
pluginId: "<string>",
tenantId: "<string>"
}Required Scope
streams.plugins.delete
Path Variables
Name | Description |
---|---|
pluginId string | Plugin ID |
cURL
HTTP
curl -X DELETE "https://{host}:31000/system/streams/v3beta1/plugins/{pluginId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | OK |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
"<string>"
Required Scope
streams.plugins.delete
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
pluginId string | Plugin ID |
cURL
HTTP
curl -X DELETE "https://{host}:31000/{tenant}/streams/v3beta1/plugins/{pluginId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
204 | The plugin was deleted successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema
Empty
Required Scope
streams.plugins.create
Path Variables
Name | Description |
---|---|
pluginId string | Plugin ID |
cURL
HTTP
curl -X POST "https://{host}:31000/system/streams/v3beta1/plugins/{pluginId}/upload" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"pluginJar": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{}
// Plugin JAR
pluginJar*: "<string>" Responses
Code | Description |
---|---|
201 | The plugin was uploaded successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PluginResponse
createDate: <integer>,
createUserId: "<string>",
description: "<string>",
jarLocation: "<string>",
name: "<string>",
pluginId: "<string>",
version: <integer>
}Required Scope
streams.plugins.create
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
pluginId string | Plugin ID |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/plugins/{pluginId}/upload" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"pluginJar": "<string>"
}'
Copy to clipboard
Request Body Schema (json)
{}
// Plugin JAR
pluginJar*: "<string>" Responses
Code | Description |
---|---|
201 | The plugin was uploaded successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PluginResponse
createDate: <integer>,
createUserId: "<string>",
description: "<string>",
jarLocation: "<string>",
name: "<string>",
pluginId: "<string>",
version: <integer>
}Required Scope
streams.plugins.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
pluginId string | pluginId |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/plugins/{pluginId}/versions" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns available versions of the plugin. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PluginVersionInfo
versionInfo: [
} {VersionInfo
] createDate: <integer>,
version: <integer>
}Required Scope
streams.pipelines.preview
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
previewSessionId string | Preview Session ID |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/preview-data/{previewSessionId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns a stream of data for preview. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PreviewData
currentNumberOfRecords: <integer>,
nodes: {
<key>: {PreviewNode
}, nodeName: "<string>",
records: []
} previewId: "<string>",
recordsPerPipeline: <integer>,
ruleMetrics: [
{RuleMetrics
], matchCount: <integer>,
matchPercentage: <integer>,
name: "<string>"
} tenantId: "<string>"
}Required Scope
streams.pipelines.preview
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/preview-session" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"upl": {
"edges": [
{
"sourceNode": "<string>",
Copy to clipboard
...
Request Body Schema (json)
{PreviewSessionStartRequest }
upl*: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} // The maximum number of events per function. Defaults to 100.
recordsLimit: <integer>, // The maximum number of events per pipeline. Defaults to 10000.
recordsPerPipeline: <integer>, // The maximum lifetime of a session, in milliseconds. Defaults to 300,000.
sessionLifetimeMs: <integer> Responses
Code | Description |
---|---|
201 | The preview sessions was started successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PreviewStartResponse
previewId: <integer>
}Required Scope
streams.pipelines.preview
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
previewSessionId string | Preview Session ID |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/preview-session/{previewSessionId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns the state of a preview session. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PreviewState
activatedDate: <integer>,
createdDate: <integer>,
currentNumberOfRecords: <integer>,
jobId: "<string>",
previewId: <integer>,
recordsPerPipeline: <integer>
}Required Scope
streams.pipelines.preview
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
previewSessionId string | Preview Session ID |
cURL
HTTP
curl -X DELETE "https://{host}:31000/{tenant}/streams/v3beta1/preview-session/{previewSessionId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
204 | The preview session was stopped successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema
Empty
Required Scope
streams.pipelines.preview
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
previewSessionId string | Preview Session ID |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/preview-session/{previewSessionId}/metrics/latest" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns the latest preview session metrics. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{MetricsResponse
nodes: {
} <key>: {NodeMetrics
} metrics: {}
}Required Scope
streams.templates.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
Query Parameters
Name | Description |
---|---|
offset integer | offset |
pageSize integer | pageSize |
sortField string | sortField |
sortDir string | sortDir |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/templates" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns a list of templates. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{PaginatedResponseOfTemplateResponse
items: [
{TemplateResponse
], createDate: <integer>,
createUserId: "<string>",
data: {Pipeline },
description: "<string>",
name: "<string>",
ownerTenantId: "<string>",
templateId: "<string>",
version: <integer>
} total: <integer>
}Required Scope
streams.templates.create
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
cURL
HTTP
curl -X POST "https://{host}:31000/{tenant}/streams/v3beta1/templates" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"data": {
"edges": [
{
"sourceNode": "<string>",
Copy to clipboard
...
Request Body Schema (json)
{TemplateRequest }
data*: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} // Template description
description*: "<string>", // Template name
name*: "<string>" Responses
Code | Description |
---|---|
201 | The template was created successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{TemplateResponse
createDate: <integer>,
createUserId: "<string>",
data: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} description: "<string>",
name: "<string>",
ownerTenantId: "<string>",
templateId: "<string>",
version: <integer>
}Required Scope
streams.templates.read
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
templateId string | Template ID |
Query Parameters
Name | Description |
---|---|
version integer | Template version |
cURL
HTTP
curl -X GET "https://{host}:31000/{tenant}/streams/v3beta1/templates/{templateId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
200 | Returns the template for a specified id. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{TemplateResponse
createDate: <integer>,
createUserId: "<string>",
data: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} description: "<string>",
name: "<string>",
ownerTenantId: "<string>",
templateId: "<string>",
version: <integer>
}Required Scope
streams.templates.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
templateId string | Template ID |
cURL
HTTP
curl -X PUT "https://{host}:31000/{tenant}/streams/v3beta1/templates/{templateId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"data": {
"edges": [
{
"sourceNode": "<string>",
Copy to clipboard
...
Request Body Schema (json)
{TemplatePutRequest }
data*: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} // Template description
description*: "<string>", // Template name
name*: "<string>" Responses
Code | Description |
---|---|
200 | The template was updated successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{TemplateResponse
createDate: <integer>,
createUserId: "<string>",
data: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} description: "<string>",
name: "<string>",
ownerTenantId: "<string>",
templateId: "<string>",
version: <integer>
}Required Scope
streams.templates.update
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
templateId string | Template ID |
cURL
HTTP
curl -X PATCH "https://{host}:31000/{tenant}/streams/v3beta1/templates/{templateId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json" \
-d '{
"data": {
"edges": [
{
"sourceNode": "<string>",
Copy to clipboard
...
Request Body Schema (json)
{TemplatePatchRequest }
data*: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} // Template description
description*: "<string>", // Template name
name*: "<string>" Responses
Code | Description |
---|---|
200 | OK |
204 | The template was modified successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema (json)
{TemplateResponse
createDate: <integer>,
createUserId: "<string>",
data: {Pipeline },
// A list of links between the output of one pipeline function and the input of another pipeline function.
edges*: [ {PipelineEdge }
], // The functions in your entire pipeline, including each function's operations, attributes, and properties.
nodes*: [ {PipelineNode }
], // Optional metadata specified by client. Not to be interpreted by the platform
attributes: { // Optional metadata specified by client. Not to be interpreted by the platform
<key>: <any> migrationInfo: {PipelineMigrationInfo
}, canMigrate: true | false,
createApiVersion: <integer>,
targetApiVersion: <integer>
} description: "<string>",
name: "<string>",
ownerTenantId: "<string>",
templateId: "<string>",
version: <integer>
}Required Scope
streams.templates.delete
Path Variables
Name | Description |
---|---|
tenant string | The tenant name. |
templateId string | Template ID |
cURL
HTTP
curl -X DELETE "https://{host}:31000/{tenant}/streams/v3beta1/templates/{templateId}" \
-H "Authorization: Bearer <accessToken>" \
-H "Content-Type: application/json"
Copy to clipboard
Responses
Code | Description |
---|---|
204 | The template was deleted successfully. |
400 | The request isn't well-formed or is incorrect. |
401 | The user isn’t authenticated. |
403 | The operation isn’t authorized. |
404 | The resource wasn’t found. |
409 | There is a conflict with the existing state of your resource. |
415 | The media type isn't supported. |
422 | The provided fields aren't valid |
500 | An internal service error has occurred. |
Response Body Schema
Empty