2025.12

The Event Stream Manager API provides programmatic access to deployment and monitoring capabilities within SAS Event Stream Manager.  It allows users to perform operations such as creating and deleting deployments, managing ESP servers, and deploying and monitoring projects.

Event Stream Manager

Returns header information about a running job given the job's unique identifier. Associated tasks can be filtered out.

jobId

If set to `false`, then these tasks are not included.

cancelled

completed

completedWithFailures

notStarted

running

The response `Content-Type` header from the service.

ContentType

Check if a job exists

Aggregated running project representation.

aggregatedRunningProjectRepresentation

The list of links to top-level resources and operations available from the root of the API.

A representation of a running ESP project in the Kubernetes cluster.

clusterProjectConfigurationRepresentation

The configuration settings for running the project in a Kubernetes cluster. A representation of the limits for the associated ESP server that runs in the Kubernetes cluster.

clusterProjectServerRepresentation

A user's settings for an ESP server that is running in the Kubernetes cluster.

clusterUserSettings

A representation of the object for a connector.

configurationConnectorRepresentation

A representation of a continuous query's statistics, such as CPU and event count.

contQueryStats

A representation for creating a deployment with the following details: a name, a description, information about whether the deployment is a production deployment, tags, and the deployment's type.

createDeploymentRepresentation

Identifies a project to promote to the next promotion level.

createPromotedProjectRepresentation

A representation for creating an ESP server.

createServerRepresentation

dateTimeRepresentation

The `clusterConfiguration` property is optional when deploying to a deployment of type `cluster`. If the `projectVersion` property is not supplied, then the latest version of the project is used.

deployClusterRepresentation

A representation to run an ESP project on a deployment whose type is `edge`. If the `projectVersion` property is not supplied, then the latest version of the project is used.

deployEdgeRepresentation

A representation for creating a deployment.

deploymentRepresentation

engineProgressRepresentation

equipmentRepresentation

An error response from the API, with details, error codes, and embedded errors.

errorResponse

A representation for an ESP server in SAS Event Stream Manager.

esmEspServerRepresentation

espProjectRepresentation

failedTaskRepresentation

A representation for the health of a running project's pod in a deployment whose type is `cluster`.

globalHealthRepresentation

globalHealthRepresentationProject

jobParameterRepresentation

jobProgressRepresentation

The status of the job used to deploy a project to an ESP server that runs on an edge server.

jobRepresentation

The status of the job used to deploy a project to an ESP server that runs in a Kubernetes cluster.

jobRepresentationCluster

jobTaskRepresentation

jobTemplateRepresentation

link

A representation for the commit details when a new version or level is created, or when a project version is configured.

packagingCommitRepresentation

A representation of the configuration data that is stored for each commit.

projectConfigurationDataRepresentation

A representation of a project's statistics, such as CPU and event count.

projectStats

projectStatsResponse

projectVersionHistoryDetails

projectVersionHistoryRepresentation

resourceCollectionDeploymentRepresentation

resourceCollectionEsmEspServerRepresentation

A list of project representations, excluding the projects' XML code.

resourceCollectionEspProjectRepresentation

A list of running projects that SAS Event Stream Manager is aware of.

resourceCollectionRunningProjectRepresentation

A summary of the details for an ESP server that is running in the Kubernetes cluster.

runningClusterProjectRepresentation

The health, status, and expected status of a running project.

runningProjectBaseRepresentation

runningProjectRepresentation

runningProjectStatusRepresentation

runningQueryRepresentation

runningWindowRepresentation

serverParameterRepresentation

A representation of an ESP server's memory consumption.

serverStats

Updates the following information for a deployment: the deployment's tags, the deployment's description, and whether the deployment is a production deployment.

updateDeploymentRepresentation

Associates ESP servers with a deployment. A list of ESP server names are used to associate ESP servers with the deployment.

Name	Type	Required	Description
cancelled	boolean	false	If set to `false`, then these tasks are not included. Default: true
completed	boolean	false	If set to `false`, then these tasks are not included. Default: true
completedWithFailures	boolean	false	If set to `false`, then these tasks are not included. Default: true
notStarted	boolean	false	If set to `false`, then these tasks are not included. Default: true
running	boolean	false	If set to `false`, then these tasks are not included. Default: true

Check if a job exists

Request Samples

Response Samples

Path Parameters

Query Parameters

Responses