Event Stream Manager

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.

Deployment Definition

Contains the operations for creating, editing, and deleting deployments.

Get all deployments

Internal-Use OnlyReturns a list of all deployments, including details of the deployments, such as assigned ESP servers and running projects./deployments

Create a deployment

Internal-Use OnlyCreates a deployment of type edge or cluster, to manage ESP servers and projects./deployments

Delete a deployment

Internal-Use OnlyDeletes a specific deployment identified by its name./deployments/{deploymentName}

Get a deployment

Internal-Use OnlyRetrieves a specific deployment identified by its name./deployments/{deploymentName}

Update a specific deployment

Internal-Use OnlyUpdates a specific deployment identified by its name. An updated deployment representation is returned./deployments/{deploymentName}

Check if a deployment exists

Internal-Use OnlyReturns header information about a specific deployment identified by its name./deployments/{deploymentName}

Cluster Deployment

Contains the operations for managing ESP servers and projects that run in a Kubernetes cluster. The ESP servers and projects are associated with a deployment whose type is cluster.

Deploy a project to the Kubernetes cluster

Internal-Use OnlyDeploys a project to the Kubernetes cluster. An ESP server is created on demand in the Kubernetes cluster. Returns information about the job that processes the request./deployments/{deploymentName}/clusterServers

Get a list of ESP servers that run in the Kubernetes cluster

Internal-Use OnlyReturns a list of ESP servers that run in the Kubernetes cluster and are associated with the specified deployment. The status of each ESP project in the cluster is returned./deployments/{deploymentName}/clusterServers

Check if ESP servers exist in the Kubernetes cluster

Internal-Use OnlyReturns header information about the ESP servers that run in the Kubernetes cluster and are associated with the specified deployment. The deployment status of each ESP project in the cluster is returned./deployments/{deploymentName}/clusterServers

Get a specified project from the Kubernetes cluster

Internal-Use OnlyReturns a specified project from the Kubernetes cluster./deployments/{deploymentName}/clusterServers/{projectName}

Check if the specified project exists in the Kubernetes cluster

Internal-Use OnlyReturns header information about a specified project from the Kubernetes cluster./deployments/{deploymentName}/clusterServers/{projectName}

Delete a project from the Kubernetes cluster

Internal-Use OnlyDeletes a project from the Kubernetes cluster. The ESP server is also deleted from the Kubernetes cluster./deployments/{deploymentName}/clusterServers/{projectName}

Edge Deployment

Contains the operations for managing ESP servers and projects that run on edge servers. The ESP servers and projects are associated with a deployment whose type is edge.

Get ESP servers for the specified deployment

Internal-Use OnlyReturns a list of ESP servers that are associated with the specified deployment./deployments/{deploymentName}/edgeServers

Add ESP servers to the specified deployment

Internal-Use OnlyAdds ESP servers to the specified deployment. Provides a list of names of existing ESP servers to be added./deployments/{deploymentName}/edgeServers

Remove ESP servers from the associated deployment

Internal-Use OnlyRemoves ESP servers from the associated deployment. Provides a list of names of existing ESP servers to be removed./deployments/{deploymentName}/edgeServers

Check if ESP servers exist for the specified deployment

Internal-Use OnlyReturns header information about ESP servers that are associated with the specified deployment./deployments/{deploymentName}/edgeServers

Deploy a project to an ESP server

Internal-Use OnlyDeploys a project to an ESP server. Returns information about the job that processes the request./deployments/{deploymentName}/edgeServers/{serverName}/projects

Get a list of projects that run on an ESP server

Internal-Use OnlyReturns a list of projects that run on the specified ESP server and are associated with the specified deployment./deployments/{deploymentName}/edgeServers/{serverName}/projects

Check if projects exist on an ESP server

Internal-Use OnlyReturns header information about projects that run on the specified ESP server and are associated with the specified deployment./deployments/{deploymentName}/edgeServers/{serverName}/projects

Get a project on the specified ESP server for the specified deployment

Internal-Use OnlyReturns a project that runs on the specified ESP server and is associated with the specified deployment./deployments/{deploymentName}/edgeServers/{serverName}/projects/{projectName}

Check if a project exists on the ESP server

Internal-Use OnlyReturns header information about a project that runs on the specified ESP server and is associated with the specified deployment./deployments/{deploymentName}/edgeServers/{serverName}/projects/{projectName}

Delete a project from the specified ESP server and deployment

Internal-Use OnlyDeletes a project from the specified ESP server and deployment./deployments/{deploymentName}/edgeServers/{serverName}/projects/{projectName}

Project

Contains the operations for returning details of projects.

Get all available projects

Internal-Use OnlyReturns a list of all projects that SAS Event Stream Manager is aware of. The project's XML code is not returned. You can return basic information that includes the project's ID, name, and version number./projects

Get a project

Internal-Use OnlyRetrieves a specific project identified by its name./projects/{projectName}

Check if a project exists

Internal-Use OnlyReturns header information about a specific project identified by its name./projects/{projectName}

Edge Server

Contains the operations for managing ESP servers.

Get ESP servers

Internal-Use OnlyReturns a list of all ESP servers known to SAS Event Stream Manager. An optional filter can be applied./edgeServers

Add ESP server details

Internal-Use OnlyAdds information about an ESP server./edgeServers

Delete ESP server details

Internal-Use OnlyDeletes the information about an ESP server identified by its name. This endpoint is valid only for ESP servers that are running on edge servers and have been manually registered to SAS Event Stream Manager./edgeServers/{serverName}

Get ESP server details

Internal-Use OnlyRetrieves the information about a specific ESP server identified by its name./edgeServers/{serverName}

Check if an ESP server exists

Internal-Use OnlyReturns header information about a specific ESP server identified by its name./edgeServers/{serverName}

Job

Contains the operations for returning details of running jobs.

Get a running job by ID

Internal-Use OnlyReturns a running job given the job's unique identifier. Associated tasks can be filtered out./jobs/{jobId}

Check if a job exists

Internal-Use OnlyReturns header information about a running job given the job's unique identifier. Associated tasks can be filtered out./jobs/{jobId}

Project Promotion

Contains the operations for managing project promotion.

Promote a project

Internal-Use OnlyPromotes a project version to the next promotion level when further promotion levels are available./projects/{projectName}/promotions

Get the promotion history

Internal-Use OnlyReturns the promotion history of a project./projects/{projectName}/promotions

Check if the promotion history exists

Internal-Use OnlyReturns header information about the promotion history of a project./projects/{projectName}/promotions

Pod

Contains the operations for querying pods that are running in a Kubernetes cluster.

Get a snapshot of the health status

Internal-Use OnlyReturns a snapshot of the health status for the ESP project on the given pod./pod/globalHealth/{podName}

Check if the health status exists

Internal-Use OnlyReturns header information about the health status for the ESP project on the given pod./pod/globalHealth/{podName}

Get the performance statistics of a pod

Internal-Use OnlyReturns the performance statistics for the ESP project on the specified pod./pod/performanceStats/{podName}

Check if the performance statistics of a pod exist

Internal-Use OnlyReturns header information about the performance statistics for the ESP project on the given pod./pod/performanceStats/{podName}

Project Container Job

Contains the operations for creating the container job.

Create a container job

Internal-Use OnlyCreates a container job to initiate the creation of a project container. The project container is created some time later./container/job

Get container jobs

Internal-Use OnlyReturns a collection of container jobs, including jobs for project containers that were created, those that are still being created, and those that failed to be created./container/job

Check a container job by ID

Internal-Use OnlyReturns the header information for a container job by ID./container/job/{jobId}

Get a container job

Internal-Use OnlyReturns a container job./container/job/{jobId}

Update a container job

Internal-Use OnlyUpdates a job that was used to create a project container./container/job/{jobId}

Delete a container job

Internal-Use OnlyDeletes a container job./container/job/{jobId}

Project Container Image

Contains the operations for managing container images.

Get default images for the creation of project containers

Internal-Use OnlyReturns the default images that are available for the creation of project containers./container/defaultImages

Check for a default image

Internal-Use OnlyReturns the header information for default image availability for the specified release and architecture./container/defaultImages/{cadenceVersion}/{architecture}

Get default image availability

Internal-Use OnlyReturns information about whether a default image is available for the specified release and architecture./container/defaultImages/{cadenceVersion}/{architecture}

Add a promotion tag to a container image

Internal-Use OnlyPromote a container image by one level. The specified promotion level must exist, and be no higher than the level that this instance of SAS Event Stream Manager is configured to manage./container/image/promote

Add a demotion tag to a container image

Internal-Use OnlyDemote a container image by one level. The specified promotion level must exist, be the highest promotion level for the container image, and be no higher than the level that this instance of SAS Event Stream Manager is configured to manage./container/image/demote

Check available Docker container images for a project

Internal-Use OnlyReturns the header information for the available Docker container images for a project./container/images/{projectName}

Get available Docker container images for a project

Internal-Use OnlyReturns the available Docker container images for a project./container/images/{projectName}

Project Container Registry

Contains the operations for managing container registries.

Create a container registry

Internal-Use OnlyCreates a container registry./container/registry

Update a container registry

Internal-Use OnlyUpdates a container registry./container/registry

Get container registries

Internal-Use OnlyReturns a resource collection of container registries./container/registry

Check if a container registry exists

Internal-Use OnlyReturns the header information for a container registry with the specified name./container/registry/{registryName}

Get a container registry

Internal-Use OnlyReturns a container registry./container/registry/{registryName}

Delete a container registry

Internal-Use OnlyDeletes a container registry./container/registry/{registryName}

Project Container Dependencies

Contains the operations for managing the Arm64 dependencies of project containers.

Create an Arm64 dependencies job

Internal-Use OnlyCreates the job that initiates the creation of the Arm64 dependencies. The images are created some time later./container/dependencies

Check the status of an Arm64 dependencies job

Internal-Use OnlyReturns the header information for an Arm64 dependencies job./container/dependenciesJob/{kubernetesJobId}

Get the status of an Arm64 dependencies job

Internal-Use OnlyReturns the status of an Arm64 dependencies job./container/dependenciesJob/{kubernetesJobId}

Root

Contains the operations for the root resource.

Get a list of top-level links

Internal-Use OnlyReturns a list of links to the top-level collections surfaced through this API./