API reference

Use your workspace API key to manage projects, services, deployments, and configuration. Start with authentication or download the OpenAPI specification.

The interactive playground sends requests to your real Openstead workspace. Review the endpoint, identifiers, and request body before sending a request.

CatalogCopy Anchor Link

• Get supported configuration and runtime capabilities
• Get this public core API contract

WorkspacesCopy Anchor Link

• Get a workspace

CanvasCopy Anchor Link

• Get scoped service topology and shared layout
• Save the shared visual layout

ProjectsCopy Anchor Link

• List projects
• Create a project and its Production environment
• Delete an empty project
• Get a project
• Update a project

ServicesCopy Anchor Link

• List services
• Create a service
• Delete a service or queue infrastructure deletion
• Get service configuration and runtime state
• Update service configuration
• Queue a service action
• Archive service configuration
• Get service operation progress
• Restore archived service configuration

DeploymentsCopy Anchor Link

• List deployments, newest first
• Queue a deployment
• Get deployment progress
• Request deployment cancellation
• Queue a rollback to a successful release

LogsCopy Anchor Link

• Read or tail service logs

VariablesCopy Anchor Link

• List masked variable metadata
• Create an encrypted variable
• Delete a variable
• Update a variable name or encrypted value
• Reveal a variable with an audit event