API Overview
The Coalesce APIs use REST to allow you to integrate with Coalesce and scale your application. Use the API to run Jobs and get information about your Nodes and Environments.
Postman Collection
If you're already familiar with the Coalesce API, grab our Postman Collection.
Available Endpoints
| Endpoint | Description |
|---|---|
| get List Environments /api/v1/environments | Returns a list of all Environments for the Project. |
| get Get Environment /api/v1/environments/:environmentID | Returns information about a specific Environment. |
| get List all Environment Nodes /api/v1/environments/:environmentID/nodes | Returns a list of all Nodes in an Environment |
| get Get a Environment Node /api/v1/environments/:environmentID/nodes/:nodeID | Returns information about a specific Node in an Environment. |
| get List Workspace Nodes /api/v1/workspaces/:workspaceID/nodes | Get a collection of Nodes for a Workspace. |
| get Get Node /api/v1/workspaces/:workspaceID/nodes/:nodeID | Returns information about a specific Node in an Environment. |
| put Set Node api/v1/workspaces/:workspaceID/nodes/:nodeID | Replace all fields of an existing Node in a Workspace. |
| get List Runs /api/v1/runs | Returns information about a deploy or refresh. |
| get Get Run /api/v1/runs/:runID | Returns information about a specific deploy or refresh. |
| get List Run Results /api/v1/runs/:runID/results | Get the status of a finished deploy or refresh. |
| post Start a Job /scheduler/startRun | Start a Job. |
| get Get Job Status /scheduler/runStatus | Get the status of an in progress or completed Job. |
| post Re-run Job /scheduler/rerun | Re-run a Job |
| post Cancel Running Job /scheduler/cancelRun | Cancel a running Job. |