Streams service endpoint descriptions
Data Stream Processing REST API lets you perform Create, Read, Update, and Delete (CRUD) operations on your data pipeline. This API features metrics and preview sessions endpoints as well as full control over your data pipeline. API base URL: https://<DSP_HOST>:31000/default/streams/v2beta1
/default/streams/v2beta1/connections
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/connections
Returns a list of connections (latest versions only) by tenant ID.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Response values schema (JSON)
{ items: [ { activePipelinesUsing: [], connectorId: "<string>", connectorName: "<string>", createDate: <integer>, createUserId: "<string>", id: "<string>", isScheduled: true | false, lastUpdateDate: <integer>, lastUpdateUserId: "<string>", versions: [] } ], total: <integer> }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/connections
Create a new DSP connection.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Response values schema (JSON)
{ // The ID of the parent connector. connectorId: "<string>", // The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded. data: { // The key-value pairs of configurations for this connection. Connectors may have some configurations that are required, which all connections must provide values for. For configuration values of type BYTES, the provided values must be Base64 encoded. <key>: <any> }, // The description of the connection. description: "<string>", // The name of the connection. name: "<string>" }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
DELETE
https://<DSP_HOST>:31000/default/streams/v2beta1/connections/{connectionId}
Delete all versions of a connection by its id.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
connectionId | ID of the connection |
Responses
Code | Description |
---|---|
200 | OK |
204 | No content |
401 | Unauthorized |
403 | Forbidden |
/default/streams/v2beta1/pipelines
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines
Get all pipelines.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Response values schema (JSON)
[ { PipelineResponse activatedDate: "<string>", activatedUserId: "<string>", activatedVersion: "<string>", createDate: "<string>", createUserId: "<string>", currentVersion: "<integer>, data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: {}, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", id: "<string>", lastUpdateDate: <integer>, lastUpdateUserId: "<string>", name: "<string>", status: "CREATED" | "ACTIVATED", statusMessage: "<string>", streamingConfigurationId: <integer>, tenantId: "<string>", validationMessages: [], version: <integer> } ], total: <integer> }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines
Create a new pipeline.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ bypassValidation: true | false, createUserId: "<string>", data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>" }
Returned values schema (JSON)
{ activatedDate: <integer>, activatedUserId: "<string>", activatedVersion: <integer>, createDate: <integer>, createUserId: "<string>", currentVersion: <integer>, data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", id: "<string>", lastUpdateDate: <integer>, lastUpdateUserId: "<string>", name: "<string>", status: "CREATED" | "ACTIVATED", statusMessage: "<string>", streamingConfigurationId: <integer>, tenantId: "<string>", validationMessages: [ "<string>" ], version: <integer> }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/pipelines/{id}/activate
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/{id}/activate
Activate pipeline(s).
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ activateLatestVersion: true | false, allowNonRestoredState: true | false, skipRestoreState: true | false }
For information about activateLatestVersion, allowNonRestoredState, and skipRestoreState, see using activation checkpoints to save your pipeline.
Response body schema (JSON)
{ <key>: [ "<string>" ] }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/pipelines/compile-dsl
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/compile-dsl
Compile streams DSL and returns the streams JSON AST.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ dsl: "<string>" }
Response body schema (JSON)
{ edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/pipelines/{id}/deactivate
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/{id}/deactivate
Deactivate pipeline(s).
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ skipSavepoint: true | false }
For information about skipSavepoint, see using activation checkpoints to save your pipeline.
Response body schema (JSON)
{ <key>: [ "<string>" ] }
Responses
Code | Description |
---|---|
200 | Successful HTTP response. |
201 | Created. |
401 | Unauthorized. |
403 | Forbidden. |
404 | Not Found. |
/default/streams/v2beta1/pipelines/input-schema
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/input-schema
Returns the input schema for a function in your pipeline.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ nodeUuid: "<string>", targetPortName: "<string>", uplJson: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> } }
Response body schema (JSON)
{ baseType: true | false, fieldNameSet: [ "<string>" ], fieldNames: [ "<string>" ], fields: { <key>: { baseType: true | false, name: "<string>", nullType: true | false, typeVariable: true | false, unknownType: true | false } }, name: "<string>", nullType: true | false, reified: true | false, type: { baseType: true | false, name: "<string>", nullType: true | false, typeVariable: true | false, unknownType: true | false }, typeVariable: true | false, types: [ { baseType: true | false, name: "<string>", nullType: true | false, typeVariable: true | false, unknownType: true | false } ], unknownType: true | false }
Responses
Code | Description |
---|---|
200 | Successful HTTP response. |
201 | Created. |
401 | Unauthorized. |
403 | Forbidden. |
404 | Not Found. |
/default/streams/v2beta1/pipelines/merge
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/merge
Merges two streams JSON programs.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ inputTree: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, mainTree: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, targetNode: "<string>", targetPort: "<string>" }
Response body schema (JSON)
{ edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/pipelines/output-schema
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/output-schema
Returns the output schema for the specified function or the output schemas for all functions, if no function id is specified, in your pipeline.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ nodeUuid: "<string>", sourcePortName: "<string>", uplJson: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> } }
Response body schema (JSON)
{ <key>: { baseType: true | false, fieldNameSet: [ "<string>" ], fieldNames: [ "<string>" ], fields: { <key>: { baseType: true | false, name: "<string>", nullType: true | false, typeVariable: true | false, unknownType: true | false } }, name: "<string>", nullType: true | false, reified: true | false, type: { baseType: true | false, name: "<string>", nullType: true | false, typeVariable: true | false, unknownType: true | false }, typeVariable: true | false, types: [ { baseType: true | false, name: "<string>", nullType: true | false, typeVariable: true | false, unknownType: true | false } ], unknownType: true | false } }
Responses
Code | Description |
---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/pipelines/registry
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/registry
Returns all functions in JSON format.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Response body schema (JSON)
{ categories: [ { id: <integer>, name: "<string>" } ], functions: [ { arguments: { <key>: { element-type: { <key>: <any> }, type: "<string>" } }, attributes: { <key>: <any> }, categories: [ <integer> ], id: "<string>", isVariadic: true | false, op: "<string>", output: { element-type: { <key>: <any> }, type: "<string>" }, resolvedId: "<string>" } ], types: [ { fieldName: "<string>", parameters: [ { } ], type: "<string>" } ] }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/pipelines/status
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/status
Get status of pipelines from the underlying streaming system
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Response body schema (JSON)
{ items: [ { jobId: "<string>", jobStatus: "<string>", pipelineId: "<string>" } ], total: <integer> }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/pipelines/validate
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/validate
Verify if the Streams JSON is valid.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ upl: { edges: [ {} ], nodes: [ {} ], root-node: [ "<string>" ], version: <integer> } }
Response body schema (JSON)
{ success: true | false, validationMessages: [ "<string>" ] }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/pipelines/{id}
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/{id}
Get an individual pipeline by version.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
id | id of the pipeline to get |
Response body schema (JSON)
{ activatedDate: <integer>, activatedUserId: "<string>", activatedVersion: <integer>, createDate: <integer>, createUserId: "<string>", currentVersion: <integer>, data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", id: "<string>", lastUpdateDate: <integer>, lastUpdateUserId: "<string>", name: "<string>", status: "CREATED" | "ACTIVATED", statusMessage: "<string>", streamingConfigurationId: <integer>, tenantId: "<string>", validationMessages: [ "<string>" ], version: <integer> }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
PUT
https://api.splunkbeta.com/{tenant}/streams/v2beta1/templates/{templateId}
Update an existing pipeline.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
templateid | id of the template |
Request body schema (JSON)
{ data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>" }
Response body schema (JSON)
{ createDate: <integer>, createUserId: "<string>", data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>", ownerTenantId: "<string>", templateId: "<string>", version: <integer> }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
DELETE
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/{id}
Delete a pipeline.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
id | id of the pipeline to delete |
Request body schema (JSON)
{ couldDeactivate: true | false, running: true | false }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
204 | No Content |
401 | Unauthorized |
403 | Forbidden |
/default/streams/v2beta1/pipelines/{id}/metrics/latest
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/{id}/metrics/latest
Get latest metrics for a single pipeline.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
id | ID of the pipeline to get metrics for |
Request body schema (JSON)
{ nodes: { <key>: { metrics: { <key>: <any> } } } }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/pipelines/{id}/reactivate
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/pipelines/{id}/reactivate
Reactivate a pipeline.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
id | Pipeline UUID to reactivate |
Response body schema (JSON)
{ currentlyActiveVersion: <integer>, pipelineId: "<string>", pipelineReactivationStatus: "activated" | "alreadyActivatedWithCurrentVersion" | "currentVersionInvalid" | "failedToDeactivateCurrentVersion" | "rolledBack" | "rolledBackError" }
Responses
Code | Description |
---|---|
200 | Successful HTTP response |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/preview-data/{previewSessionId}
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/preview-data/{previewSessionId}
Get preview data for a session.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
previewSessionId | ID of the preview session |
Response body schema (JSON)
{ currentNumberOfRecords: <integer>, nodes: { <key>: { nodeName: "<string>", records: [ { array: true | false, bigDecimal: true | false, bigInteger: true | false, binary: true | false, boolean: true | false, containerNode: true | false, double: true | false, float: true | false, floatingPointNumber: true | false, int: true | false, integralNumber: true | false, long: true | false, missingNode: true | false, nodeType: "ARRAY" | "BINARY" | "BOOLEAN" | "MISSING" | "NULL" | "NUMBER" | "OBJECT" | "POJO" | "STRING", null: true | false, number: true | false, object: true | false, pojo: true | false, short: true | false, textual: true | false, valueNode: true | false } ] } }, pipelineId: "<string>", previewId: "<string>", recordsPerPipeline: <integer> }
Responses
Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/preview-session
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/preview-session
Start a preview session for a pipeline.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ recordsLimit: <integer>, recordsPerPipeline: <integer>, sessionLifetimeMs: <integer>, streamingConfigurationId: <integer>, upl: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, useNewData: true | false }
Response body schema (JSON)
{ pipelineId: "<string>", previewId: <integer> }
Responses
Code | Description |
---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
DELETE
https://<DSP_HOST>:31000/default/streams/v2beta1/preview-session/{previewSessionId}
Stop a preview session.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
previewSessionId | ID of the preview session |
Response body schema (JSON)
"<string>"
Responses
Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/templates
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/templates
Get a list of the latest templates.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ items: [ { createDate: <integer>, createUserId: "<string>", data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: {}, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>", ownerTenantId: "<string>", templateId: "<string>", version: <integer> } ], total: <integer> }
Responses
Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/templates
Create a new template for a tenant.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
Request body schema (JSON)
{ data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>" }
Response body schema (JSON)
{ createDate: <integer>, createUserId: "<string>", data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>", ownerTenantId: "<string>", templateId: "<string>", version: <integer> }
Responses
Code | Description |
---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/templates/{templateId}
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/templates/{templateId}
Get an individual template by version.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
templateID | ID of the template |
Response body schema (JSON)
{ createDate: <integer>, createUserId: "<string>", data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>", ownerTenantId: "<string>", templateId: "<string>", version: <integer> }
Responses
Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
PUT
https://<DSP_HOST>:31000/default/streams/v2beta1/templates/{templateId}
Update an existing template.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
templateID | ID of the template to delete. |
Request body schema (JSON)
{ data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>" }
Response body schema (JSON)
{ createDate: <integer>, createUserId: "<string>", data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>", ownerTenantId: "<string>", templateId: "<string>", version: <integer> }
Responses
Code | Description |
---|---|
200 | OK |
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
PATCH
https://<DSP_HOST>:31000/default/streams/v2beta1/templates/{templateId}
Partially update an existing template.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
templateID | ID of the template to delete |
Request body schema (JSON)
{ data: { edges: [ { attributes: {}, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>" }
Response body schema (JSON)
{ createDate: <integer>, createUserId: "<string>", data: { edges: [ { attributes: { <key>: <any> }, sourceNode: "<string>", sourcePort: "<string>", targetNode: "<string>", targetPort: "<string>" } ], nodes: [ { attributes: { <key>: <any> }, id: "<string>", op: "<string>" } ], root-node: [ "<string>" ], version: <integer> }, description: "<string>", name: "<string>", ownerTenantId: "<string>", templateId: "<string>", version: <integer> }
Responses
Code | Description |
---|---|
200 | OK |
204 | No Content |
401 | Unauthorized |
403 | Forbidden |
DELETE
https://<DSP_HOST>:31000/default/streams/v2beta1/templates/{templateId}
Delete a template with a specific ID.
Path variables
Name | Description |
---|---|
tenant | The tenant name |
templateID | ID of the template to delete |
Response body schema
None.
Responses
Code | Description |
---|---|
200 | OK |
204 | No Content |
401 | Unauthorized |
403 | Forbidden |
/default/streams/v2beta1/plugins
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/plugins
Get all plugins for a given tenant.
Response body schema (JSON)
{ "items": [ { "description": "string", "isDeleted": true, "lastUpdateDate": 0, "lastUpdateUserId": "string", "name": "string", "pluginId": "string", "tenantId": "string" } ], "total": 0 }
Responses
Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/plugins
Register a new plugin
Request body schema (JSON)
{ "description": "string", "name": "string" }
Response body schema (JSON)
{ "description": "string", "isDeleted": true, "lastUpdateDate": 0, "lastUpdateUserId": "string", "name": "string", "pluginId": "string", "tenantId": "string" }
Responses
Code | Description |
---|---|
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
/default/streams/v2beta1/plugins/{pluginId}
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/plugins/{pluginId}
Get an individual plugin.
Path variables
Name | Description |
---|---|
pluginId | Id of the plugin |
Response body schema (JSON)
{ "description": "string", "isDeleted": true, "lastUpdateDate": 0, "lastUpdateUserId": "string", "name": "string", "pluginId": "string", "tenantId": "string" }
Responses
Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
DELETE
https://<DSP_HOST>:31000/default/streams/v2beta1/plugins/{pluginId}
Delete an individual plugin.
Path variables
Name | Description |
---|---|
pluginId | The plugin id. |
cURL example
curl -X DELETE --header 'Accept: application/json' -H 'Authorization: Bearer <token>' 'http://<DSP_HOST>:31000/default/streams/v2beta1/plugins/d8b7a21c-235d-454d-9e83-310018adc961'
Responses
Code | Description |
---|---|
204 | The plugin was removed successfully. |
401 | Unauthorized |
403 | Forbidden |
PATCH
https://<DSP_HOST>:31000/default/streams/v2beta1/plugins/{pluginId}
Partially update an existing plugin.
Path variables
Name | Description |
---|---|
pluginId | Id of the plugin |
Request body schema (JSON)
{ "description": "string", "name": "string" }
Response body schema (JSON)
{ "description": "string", "isDeleted": true, "lastUpdateDate": 0, "lastUpdateUserId": "string", "name": "string", "pluginId": "string", "tenantId": "string" }
Responses
Code | Description |
---|---|
204 | OK |
401 | Unauthorized |
403 | Forbidden |
PUT
https://<DSP_HOST>:31000/default/streams/v2beta1/plugins/{pluginId}
Updates an existing plugin.
Path variables
Name | Description |
---|---|
pluginId | Id of the plugin |
Request body schema (JSON)
{ "description": "string", "name": "string" }
Response body schema (JSON)
{ "description": "string", "isDeleted": true, "lastUpdateDate": 0, "lastUpdateUserId": "string", "name": "string", "pluginId": "string", "tenantId": "string" }
Responses
Code | Description |
---|---|
201 | Created |
401 | Unauthorized |
403 | Forbidden |
404 | Not found |
/default/streams/v2beta1/plugins/{pluginId}/upload
POST
https://<DSP_HOST>:31000/default/streams/v2beta1/plugins/{pluginId}
Upload a new plugin.
Parameters
Name | Description |
---|---|
pluginId | The plugin id. |
pluginJar | The jar file to upload. |
cURL example
curl -X POST --header 'Content-Type: multipart/form-data' --header 'Accept: application/json' -F 'pluginJar=@/path/to/local/jar/file' 'http://<DSP_HOST>:31000/default/streams/v2beta1/plugins/0613b04d-9269-4e4c-a240-9f415f5514ca/upload'
Response body schema (JSON)
{ "createDate": 0, "createUserId": "string", "description": "string", "jarLocation": "string", "name": "string", "pluginId": "string", "version": 0 }
Responses
Code | Description |
---|---|
201 | The plugin was uploaded. |
401 | Unauthorized |
403 | Forbidden |
404 | Not found. |
/default/streams/v2beta1/plugins/{pluginId}/versions
GET
https://<DSP_HOST>:31000/default/streams/v2beta1/plugins/{pluginId}
Retrieve all available versions of a plugin.
Path variables
Name | Description |
---|---|
pluginId | The plugin id. |
Response body schema (JSON)
{ "versionInfo": [ { "createDate": 0, "version": 0 } ] }
Responses
Code | Description |
---|---|
200 | OK |
401 | Unauthorized |
403 | Forbidden |
404 | Not Found |
This documentation applies to the following versions of Splunk® Data Stream Processor: 1.1.0
Feedback submitted, thanks!