Cloud API documentation / v1

Build against the cloud API with confidence.

Practical implementation guidance for authentication, core REST endpoints, and your first successful request.

Start building with the API Explore endpoints

01 / Overview

A practical API surface for cloud operations.

Use the platform to securely connect your application to cloud resources through predictable REST endpoints.

Consistent REST resources

Create, inspect, and manage cloud resources with familiar HTTP methods.

Secure by default

Authenticate every request with scoped credentials and clear access boundaries.

Built for integration

Move from first request to production workflow without changing your mental model.

What you can do

  • Provision and retrieve cloud resources from your application.
  • Apply access controls through authenticated, scoped requests.
  • Build repeatable workflows around the endpoint reference.

Access

Authentication

Every API request uses a project API key. Create one once, send it as a Bearer token, and keep it out of source control.

  1. 01

    Create a project API key

    In the dashboard, open your project settings and create a scoped key for the environment you are integrating.

  2. 02

    Send the key with each request

    Pass the key in the Authorization header using the Bearer scheme.

  3. 03

    Store credentials securely

    Load keys from your deployment environment or a secrets manager. Rotate them promptly if access changes.

Do

  • Use separate keys for development and production.
  • Restrict keys to the minimum scopes required.

Don’t

  • Commit keys to repositories or client-side bundles.
  • Share one long-lived key across teams.

Endpoints

A small, consistent API surface.

Core resources follow the same conventions, so teams can move from first request to production integration with less context switching.

Projects

/projects

Create and organize the workspaces that contain your cloud resources.

  • GETList projects
  • POSTCreate project
  • PATCHUpdate project

Deployments

/deployments

Deploy versioned services and follow each release from request to completion.

  • GETList deployments
  • POSTStart deployment
  • GETCheck status

Resources

/resources

Provision, inspect, and manage the infrastructure assigned to a project.

  • GETList resources
  • POSTProvision resource
  • DELETERemove resource

Events

/events

Read operational activity and configure delivery for changes your systems need to know about.

  • GETList events
  • GETFilter activity
  • POSTCreate webhook

Implementation FAQ

Answers before you integrate.

The practical details developers usually need before connecting their first request.

How long does initial setup take?

Most teams can make an authenticated test request in under 15 minutes using the quickstart and a project API key.

How is authentication handled?

Send your API key as a Bearer token over HTTPS. Keep keys server-side and rotate them whenever access changes.

Is there a safe environment for testing?

Yes. Use the sandbox base URL and test credentials to validate requests before pointing your integration at production.

What should we expect from API versioning?

Versions are explicit in the URL. Breaking changes are released as a new version, with migration guidance before retirement dates.

What is the best way to begin?

Create a project, generate a key, then follow the authentication guide to send your first request.

Ready to move from overview to your first call?

Start building with the API