.conf25 registration is now open!Register today

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 clipboard
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/connections
Copy full endpoint URL to clipboard

Returns a list of connections (latest versions only) by tenant ID.

Required Scope
streams.connections.read
Path Variables
NameDescription
tenant
string
The tenant name.
Query Parameters
NameDescription
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
CodeDescription
200Returns a list of connections.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/connections
Copy full endpoint URL to clipboard

Create a new DSP connection.

Required Scope
streams.connections.create
Path Variables
NameDescription
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
CodeDescription
201The connection was created successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
PUT
/{tenant}tenant (string): The tenant name./streams/v3beta1/connections/{connectionId}connectionId (string): Connection ID
Copy full endpoint URL to clipboard

Updates an existing DSP connection.

Required Scope
streams.connections.update
Path Variables
NameDescription
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
CodeDescription
200The connection was updated successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
PATCH
/{tenant}tenant (string): The tenant name./streams/v3beta1/connections/{connectionId}connectionId (string): Connection ID
Copy full endpoint URL to clipboard

Patches an existing DSP connection.

Required Scope
streams.connections.update
Path Variables
NameDescription
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
CodeDescription
200The connection was modified successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
DELETE
/{tenant}tenant (string): The tenant name./streams/v3beta1/connections/{connectionId}connectionId (string): Connection ID
Copy full endpoint URL to clipboard

Delete all versions of a connection by its id.

Required Scope
streams.connections.delete
Path Variables
NameDescription
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
CodeDescription
204The connection was deleted successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema
Empty
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/connectors
Copy full endpoint URL to clipboard

Returns a list of the available connectors.

Required Scope
streams.connections.read
Path Variables
NameDescription
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
CodeDescription
200Returns a list of connectors.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/files
Copy full endpoint URL to clipboard

Returns files metadata.

Required Scope
streams.files.read
Path Variables
NameDescription
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
CodeDescription
200Returns files metadata.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{FilesMetaDataResponse 
    files: [
        {UploadFile 
            createdDate: <integer>,     
            createdUserId: "<string>",     
            filename: "<string>",     
            id: "<string>",     
            sha256: "<string>",     
            tenantId: "<string>"     
        }
    ]
     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/files
Copy full endpoint URL to clipboard

Upload new file.

Required Scope
streams.files.create
Path Variables
NameDescription
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
CodeDescription
201Upload a file.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{UploadFile 
    createdDate: <integer>,     
    createdUserId: "<string>",     
    filename: "<string>",     
    id: "<string>",     
    sha256: "<string>",     
    tenantId: "<string>"     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/files/{fileId}fileId (string): File ID
Copy full endpoint URL to clipboard

Get file metadata.

Required Scope
streams.files.read
Path Variables
NameDescription
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
CodeDescription
200Returns files metadata.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{UploadFile 
    createdDate: <integer>,     
    createdUserId: "<string>",     
    filename: "<string>",     
    id: "<string>",     
    sha256: "<string>",     
    tenantId: "<string>"     
}
 
DELETE
/{tenant}tenant (string): The tenant name./streams/v3beta1/files/{fileId}fileId (string): File ID
Copy full endpoint URL to clipboard

Delete file.

Required Scope
streams.files.delete
Path Variables
NameDescription
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
CodeDescription
204File deleted successfully
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema
Empty
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/license
Copy full endpoint URL to clipboard

Returns your DSP license.

Required Scope
streams.license.read
Path Variables
NameDescription
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
CodeDescription
200Returns the existing license.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{LicenseResponse 
    license: {
        <key>: <any>
    }
     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/license
Copy full endpoint URL to clipboard

Upload a new license.

Required Scope
streams.license.upload
Path Variables
NameDescription
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
CodeDescription
201The license was uploaded successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{LicenseResponse 
    license: {
        <key>: <any>
    }
     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/lookups/{connectionId}connectionId (string): Connection ID
Copy full endpoint URL to clipboard

Returns lookup table results.

Required Scope
streams.lookups.read
Path Variables
NameDescription
tenant
string
The tenant name.
connectionId
string
Connection ID
Query Parameters
NameDescription
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
CodeDescription
200Returns lookup table results.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{LookupTableResponse 
    data: [
        {
            <key>: <any>
        }
    ]
,     
    types: {
        <key>: "<string>"
    }
     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines
Copy full endpoint URL to clipboard

Returns all pipelines.

Required Scope
streams.pipelines.read
Path Variables
NameDescription
tenant
string
The tenant name.
Query Parameters
NameDescription
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
CodeDescription
200Returns a list of pipelines.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines
Copy full endpoint URL to clipboard

Creates a pipeline.

Required Scope
streams.pipelines.create
Path Variables
NameDescription
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
CodeDescription
201The pipeline was created successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/compile
Copy full endpoint URL to clipboard

Compiles SPL2 and returns streams JSON.

Required Scope
streams.pipelines.update
Path Variables
NameDescription
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
CodeDescription
200Returns the compiled pipeline.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
    }
     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/decompile
Copy full endpoint URL to clipboard

Decompiles UPL and returns SPL.

Required Scope
streams.pipelines.update
Path Variables
NameDescription
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
CodeDescription
200Returns the compiled pipeline.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{DecompileResponse 
    spl: "<string>"     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/input-schema
Copy full endpoint URL to clipboard

Returns the input schema for a function in a pipeline.

Required Scope
streams.pipelines.read
Path Variables
NameDescription
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
CodeDescription
200Returns the input schema for a specified function.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{UplType 
    fieldName: "<string>",     
    parameters: [
        { UplType recursive data-type }
    ]
,     
    type: "<string>"     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/output-schema
Copy full endpoint URL to clipboard

Returns the output schema for a specified function in a pipeline.

Required Scope
streams.pipelines.read
Path Variables
NameDescription
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
CodeDescription
200Returns the output schema for a specified function.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{
    <key>: {UplType 
        fieldName: "<string>",     
        parameters: [
            { UplType recursive data-type }
        ]
,     
        type: "<string>"     
    }
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/registry
Copy full endpoint URL to clipboard

Returns all functions in JSON format.

Required Scope
streams.pipelines.read
Path Variables
NameDescription
tenant
string
The tenant name.
Query Parameters
NameDescription
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
CodeDescription
200Returns a list of functions.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{RegistryModel 
    categories: [
        "<string>"
    ]
,     
    functions: [
        {FunctionModel 
            arguments: [],     
            attributes: {},     
            op: "<string>",     
            outputs: [],     
            resolvedId: "<string>"     
        }
    ]
     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/status
Copy full endpoint URL to clipboard

Returns the status of pipelines from the underlying streaming system.

Required Scope
streams.pipelines.read
Path Variables
NameDescription
tenant
string
The tenant name.
Query Parameters
NameDescription
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
CodeDescription
200Returns the current status of the pipeline.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{PaginatedResponseOfPipelineJobStatus 
    items: [
        {PipelineJobStatus 
            jobId: "<string>",     
            jobStatus: "<string>",     
            pipelineId: "<string>"     
        }
    ]
,     
    total: <integer>     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/validate
Copy full endpoint URL to clipboard

Verifies whether the Streams JSON is valid.

Required Scope
streams.pipelines.update
Path Variables
NameDescription
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
CodeDescription
200The pipeline is valid.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{ValidateResponse 
    nodeId: "<string>",     
    spl: "<string>",     
    success: true | false,     
    validationMessages: [
        "<string>"
    ]
     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/{id}id (string): Pipeline ID
Copy full endpoint URL to clipboard

Returns an individual pipeline by version.

Required Scope
streams.pipelines.read
Path Variables
NameDescription
tenant
string
The tenant name.
id
string
Pipeline ID
Query Parameters
NameDescription
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
CodeDescription
200Returns the pipeline with the specified id.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
PUT
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/{id}id (string): Pipeline ID
Copy full endpoint URL to clipboard

Updates an existing pipeline.

Required Scope
streams.pipelines.update
Path Variables
NameDescription
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
CodeDescription
200The pipeline was updated successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
PATCH
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/{id}id (string): Pipeline ID
Copy full endpoint URL to clipboard

Patches an existing pipeline.

Required Scope
streams.pipelines.update
Path Variables
NameDescription
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
CodeDescription
200The pipeline was modified successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
DELETE
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/{id}id (string): Pipeline ID
Copy full endpoint URL to clipboard

Removes a pipeline.

Required Scope
streams.pipelines.delete
Path Variables
NameDescription
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
CodeDescription
204The pipeline was deleted successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema
Empty
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/{id}id (string): Pipeline ID/activate
Copy full endpoint URL to clipboard

Activates an existing pipeline.

Required Scope
streams.pipelines.activate
Path Variables
NameDescription
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
CodeDescription
200The pipeline was activated successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{Response 
    // Only set for /activate endpoint     
    activated: "<string>",     
    // Only set for /deactivate endpoint     
    deactivated: "<string>"     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/{id}id (string): Pipeline ID/deactivate
Copy full endpoint URL to clipboard

Deactivates an existing pipeline.

Required Scope
streams.pipelines.deactivate
Path Variables
NameDescription
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
CodeDescription
200The pipeline was deactivated successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{Response 
    // Only set for /activate endpoint     
    activated: "<string>",     
    // Only set for /deactivate endpoint     
    deactivated: "<string>"     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/{id}id (string): Pipeline ID/metrics/latest
Copy full endpoint URL to clipboard

Returns the latest metrics for a single pipeline.

Required Scope
streams.pipelines.read
Path Variables
NameDescription
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
CodeDescription
200Returns the latest metrics for a specified pipeline.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{MetricsResponse 
    nodes: {
        <key>: {NodeMetrics 
            metrics: {}     
        }
    }
     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/pipelines/{id}id (string): Pipeline ID/reactivate
Copy full endpoint URL to clipboard

Reactivate a pipeline

Required Scope
streams.pipelines.activate
Path Variables
NameDescription
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
CodeDescription
200The pipeline was reactivated successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{PipelineReactivateResponse 
    currentlyActiveVersion: <integer>,     
    pipelineId: "<string>",     
    pipelineReactivationStatus: "activated" | "currentVersionInvalid" | "failedToDeactivateCurrentVersion" | "notActivated" | "rolledBack" | "rolledBackError"     
}
 
GET
/system/streams/v3beta1/plugins
Copy full endpoint URL to clipboard

Returns all the plugins that are available for all tenants.

Required Scope
streams.plugins.read
Query Parameters
NameDescription
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
CodeDescription
200Returns all the plugins.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/plugins
Copy full endpoint URL to clipboard

Returns all the plugins for a specified tenant id.

Required Scope
streams.plugins.read
Path Variables
NameDescription
tenant
string
The tenant name.
Query Parameters
NameDescription
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
CodeDescription
200Returns all the plugins.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
POST
/system/streams/v3beta1/plugins
Copy full endpoint URL to clipboard

Register a new plugin that's available for all tenants.

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
CodeDescription
201The plugin was registered successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>"     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/plugins
Copy full endpoint URL to clipboard

Register a new plugin.

Required Scope
streams.plugins.create
Path Variables
NameDescription
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
CodeDescription
201The plugin was registered successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>"     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/plugins/{pluginId}pluginId (string): Plugin ID
Copy full endpoint URL to clipboard

Returns a plugin for the specified id.

Required Scope
streams.plugins.read
Path Variables
NameDescription
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
CodeDescription
200Returns a plugin for the specified id.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>"     
}
 
PUT
/system/streams/v3beta1/plugins/{pluginId}pluginId (string): Plugin ID
Copy full endpoint URL to clipboard

Update admin plugin info.

Required Scope
streams.plugins.update
Path Variables
NameDescription
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
CodeDescription
200The plugin was updated successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>"     
}
 
PUT
/{tenant}tenant (string): The tenant name./streams/v3beta1/plugins/{pluginId}pluginId (string): Plugin ID
Copy full endpoint URL to clipboard

Update an existing plugin.

Required Scope
streams.plugins.read
Path Variables
NameDescription
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
CodeDescription
200The plugin was updated successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>"     
}
 
PATCH
/system/streams/v3beta1/plugins/{pluginId}pluginId (string): Plugin ID
Copy full endpoint URL to clipboard

Patch an existing admin plugin.

Required Scope
streams.plugins.update
Path Variables
NameDescription
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
CodeDescription
200The plugin was modified successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>"     
}
 
PATCH
/{tenant}tenant (string): The tenant name./streams/v3beta1/plugins/{pluginId}pluginId (string): Plugin ID
Copy full endpoint URL to clipboard

Patch an existing plugin.

Required Scope
streams.plugins.update
Path Variables
NameDescription
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
CodeDescription
200The plugin was modified successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>"     
}
 
DELETE
/system/streams/v3beta1/plugins/{pluginId}pluginId (string): Plugin ID
Copy full endpoint URL to clipboard

Delete an admin plugin

Required Scope
streams.plugins.delete
Path Variables
NameDescription
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
CodeDescription
200OK
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
"<string>"
 
DELETE
/{tenant}tenant (string): The tenant name./streams/v3beta1/plugins/{pluginId}pluginId (string): Plugin ID
Copy full endpoint URL to clipboard

Delete a plugin.

Required Scope
streams.plugins.delete
Path Variables
NameDescription
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
CodeDescription
204The plugin was deleted successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema
Empty
 
POST
/system/streams/v3beta1/plugins/{pluginId}pluginId (string): Plugin ID/upload
Copy full endpoint URL to clipboard

Upload a new plugin that's available for all tenants.

Required Scope
streams.plugins.create
Path Variables
NameDescription
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
CodeDescription
201The plugin was uploaded successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{PluginResponse 
    createDate: <integer>,     
    createUserId: "<string>",     
    description: "<string>",     
    jarLocation: "<string>",     
    name: "<string>",     
    pluginId: "<string>",     
    version: <integer>     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/plugins/{pluginId}pluginId (string): Plugin ID/upload
Copy full endpoint URL to clipboard

Upload a new plugin.

Required Scope
streams.plugins.create
Path Variables
NameDescription
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
CodeDescription
201The plugin was uploaded successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{PluginResponse 
    createDate: <integer>,     
    createUserId: "<string>",     
    description: "<string>",     
    jarLocation: "<string>",     
    name: "<string>",     
    pluginId: "<string>",     
    version: <integer>     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/plugins/{pluginId}pluginId (string): pluginId/versions
Copy full endpoint URL to clipboard

Retrieve available versions of the plugin.

Required Scope
streams.plugins.read
Path Variables
NameDescription
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
CodeDescription
200Returns available versions of the plugin.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{PluginVersionInfo 
    versionInfo: [
        {VersionInfo 
            createDate: <integer>,     
            version: <integer>     
        }
    ]
     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/preview-data/{pSID}previewSessionId (string): Preview Session ID
Copy full endpoint URL to clipboard

Returns the preview data for a session.

Required Scope
streams.pipelines.preview
Path Variables
NameDescription
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
CodeDescription
200Returns a stream of data for preview.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>"     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/preview-session
Copy full endpoint URL to clipboard

Creates a preview session for a pipeline.

Required Scope
streams.pipelines.preview
Path Variables
NameDescription
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
CodeDescription
201The preview sessions was started successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{PreviewStartResponse 
    previewId: <integer>     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/preview-session/{pSID}previewSessionId (string): Preview Session ID
Copy full endpoint URL to clipboard

Returns information from a preview session.

Required Scope
streams.pipelines.preview
Path Variables
NameDescription
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
CodeDescription
200Returns the state of a preview session.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{PreviewState 
    activatedDate: <integer>,     
    createdDate: <integer>,     
    currentNumberOfRecords: <integer>,     
    jobId: "<string>",     
    previewId: <integer>,     
    recordsPerPipeline: <integer>     
}
 
DELETE
/{tenant}tenant (string): The tenant name./streams/v3beta1/preview-session/{pSID}previewSessionId (string): Preview Session ID
Copy full endpoint URL to clipboard

Stops a preview session.

Required Scope
streams.pipelines.preview
Path Variables
NameDescription
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
CodeDescription
204The preview session was stopped successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema
Empty
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/preview-session/{pSID}previewSessionId (string): Preview Session ID/metrics/latest
Copy full endpoint URL to clipboard

Returns the latest metrics for a preview session.

Required Scope
streams.pipelines.preview
Path Variables
NameDescription
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
CodeDescription
200Returns the latest preview session metrics.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema (json)
{MetricsResponse 
    nodes: {
        <key>: {NodeMetrics 
            metrics: {}     
        }
    }
     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/templates
Copy full endpoint URL to clipboard

Returns a list of all templates.

Required Scope
streams.templates.read
Path Variables
NameDescription
tenant
string
The tenant name.
Query Parameters
NameDescription
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
CodeDescription
200Returns a list of templates.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
POST
/{tenant}tenant (string): The tenant name./streams/v3beta1/templates
Copy full endpoint URL to clipboard

Creates a template for a tenant.

Required Scope
streams.templates.create
Path Variables
NameDescription
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
CodeDescription
201The template was created successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
GET
/{tenant}tenant (string): The tenant name./streams/v3beta1/templates/{templateId}templateId (string): Template ID
Copy full endpoint URL to clipboard

Returns an individual template by version.

Required Scope
streams.templates.read
Path Variables
NameDescription
tenant
string
The tenant name.
templateId
string
Template ID
Query Parameters
NameDescription
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
CodeDescription
200Returns the template for a specified id.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
PUT
/{tenant}tenant (string): The tenant name./streams/v3beta1/templates/{templateId}templateId (string): Template ID
Copy full endpoint URL to clipboard

Updates an existing template.

Required Scope
streams.templates.update
Path Variables
NameDescription
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
CodeDescription
200The template was updated successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
PATCH
/{tenant}tenant (string): The tenant name./streams/v3beta1/templates/{templateId}templateId (string): Template ID
Copy full endpoint URL to clipboard

Patches an existing template.

Required Scope
streams.templates.update
Path Variables
NameDescription
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
CodeDescription
200OK
204The template was modified successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An 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>     
}
 
DELETE
/{tenant}tenant (string): The tenant name./streams/v3beta1/templates/{templateId}templateId (string): Template ID
Copy full endpoint URL to clipboard

Removes a template with a specific ID.

Required Scope
streams.templates.delete
Path Variables
NameDescription
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
CodeDescription
204The template was deleted successfully.
400The request isn't well-formed or is incorrect.
401The user isn’t authenticated.
403The operation isn’t authorized.
404The resource wasn’t found.
409There is a conflict with the existing state of your resource.
415The media type isn't supported.
422The provided fields aren't valid
500An internal service error has occurred.
Response Body Schema
Empty