2026.10

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 the headers that a GET request would return for ESP servers associated with this deployment.

deploymentId

The maximum number of records to be returned.

limit

The number of the first record to be returned.

start

When set to `true`, only ESP servers that are not running in a cluster are returned.

excludeClusterServers

When set to `true`, details of ESP servers and projects are not included.

noDetails

When this parameter is set to `removal`, only ESP servers that do not have projects are returned.

suitableFor

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

ContentType

Last-Modified

An example of a `400 Bad Request` error response.

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

errorResponse

The request was invalid. Additional information is available in the application logs if the environment variable `LOGGING_LEVEL_ORG_SPRINGFRAMEWORK` is set to `DEBUG`.

An example of a `404 Not Found` error response.

No resource exists at the requested path.

Get headers for deployment assets

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

containerImageData

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

deploymentServerCollectionRepresentation

engineProgressRepresentation

equipmentRepresentation

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

esmEspServerRepresentation

espProjectRepresentation

failedTaskRepresentation

A description of a request that generates the Arm64 dependencies.

generateArmDependenciesRequest

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 description of a job that was used to create the project container that is to be updated.

projectContainerCreateJobPatchRepresentation

A description of a job that creates a project container.

projectContainerCreateJobRequest

The schema for initiating the creation of a project container.

projectContainerCreateJobResponse

Identifies a container image to be promoted or demoted by one level.

projectContainerImagePromoteOrDemoteTarget

Describes a container image and the status to set for it.

projectContainerImageSetStatus

projectContainerJobRepresentation

A response representation for a container registry.

projectContainerRegistryRepresentation

The representation to identify an ESP project to run in a Kubernetes cluster.

projectMinimalRepresentation

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

projectStats

projectStatsResponse

projectVersionHistoryDetails

projectVersionHistoryRepresentation

The schema for returning container images.

resourceCollectionContainerImageData

resourceCollectionDeploymentRepresentation

resourceCollectionEsmEspServerRepresentation

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

resourceCollectionEspProjectRepresentation

resourceCollectionProjectContainerJobRepresentation

resourceCollectionProjectContainerRegistryRepresentation

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

A representation of the status of a running project.

runningProjectStatusRepresentation

runningQueryRepresentation

A representation of a window in a running project.

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 is used to associate ESP servers with the deployment.


excludeClusterServers	boolean	false	When set to `true`, only ESP servers that are not running in a cluster are returned. Default: false
limit	integer<int32>	false	The maximum number of records to be returned. >= 1<= 10000 Default: 50
noDetails	boolean	false	When set to `true`, details of ESP servers and projects are not included. Default: false
start	integer<int64>	false	The number of the first record to be returned. >= 0 Default: 0
suitableFor	string	false	When this parameter is set to `removal`, only ESP servers that do not have projects are returned. Default:

Status	Meaning	Description
200	OK	The request succeeded.	Headers
400	Bad Request	The request was invalid. Additional information is available in the application logs if the environment variable `LOGGING_LEVEL_ORG_SPRINGFRAMEWORK` is set to `DEBUG`.		Schema
404	Not Found	No resource exists at the requested path.		Schema

Get headers for deployment assets

Request Samples

Path Parameters

Query Parameters

Responses