Platform API Reference

The Encore Platform provides an API for programmatic access to control certain parts of the platform.

We're working on expanding the set of features available over the API. Please reach out to us on Discord if you have use cases where additional API functionality would be useful.

The Base URL for the Encore Platform API is https://api.encore.dev.

Authentication

All API calls require valid authentication, which is provided by sending an access token in the Authorization header, in the format Authorization: Bearer ${ACCESS_TOKEN}.

You can retrieve an API access token from the OAuth Token endpoint, using an OAuth Client. An API access token expires after one hour. For continuous access, shortly before an API access token expires, request a new API access token from the Encore Platform's OAuth token endpoint.

OAuth client libraries in popular programming languages can handle the API access token generation and renewal.

See the OAuth Clients for more information on creating OAuth Clients.

OAuth

Method: POST
Path: /api/oauth/token

Query Parameters

Response

The API responds with a 2xx status code on successful creation of an API access token.

type Token = {
  // The access token itself.
  "access_token": string;

  // The access token expires after 1 hour (3600 seconds).
  "expires_in": 3600;

  // The actor the token belongs to, in this case the OAuth2 client id.
  actor: string;


  // Indicates the access token should be passed as a "Bearer" token in the Authorization header.
  "token_type": "Bearer";
}

Rollouts

The Encore Platform's deployment system consists of several phases:

• A build phase
• An infrastructure provisioning phase
• A deployment phase

These phases are combined into a unified entity called a Rollout. A rollout represents the coordinated process of rolling out a specific version of an Encore application.

We use the term rollout to disambiguate from the deployment phase, which specifically refers to the last phase of the rollout process (where the version is being deployed onto the provisioned infrastructure).

The Rollout Object

The Rollout object represents the state of a rollout.

// The representation of a rollout.
type Rollout = {
  // Unique id of the rollout.
  id: string;

  // The current status of the rollout.
  status: "pending" | "queued" | "running" | "completed";

  // What the conclusion was of the rollout (when status is "completed").
  // If the status is not "completed" the conclusion is "pending".
  conclusion: "pending" | "canceled" | "failure" | "success";

  // When the rollout was queued, started, and completed.
  queued_at: Date | null;
  started_at: Date | null;
  completed_at: Date | null;

  // Information about the various rollout phases.
  // See type definitions below.
  build: RolloutPhase<BuildStatus, BuildConclusion>;
  infra: RolloutPhase<InfraStatus, InfraConclusion>;
  deploy: RolloutPhase<DeployStatus, DeployConclusion>;
}

// Common structure of the various rollout phases.
type RolloutPhase<Status, Conclusion> = {
  // Unique id of the phase.
  id: string;

  // The current status of the rollout phase.
  status: Status;

  // What the conclusion was of the phase.
  conclusion: Conclusion;

  // When the phase was queued, started, and completed.
  queued_at: Date | null;
  started_at: Date | null;
  completed_at: Date | null;
}

// The current status and conclusion of a build.
// If the status is not "completed" the conclusion is "unknown".
type BuildStatus = "queued" | "running" | "completed";
type BuildConclusion = "unknown" | "canceled" | "failure" | "success";

// The current status and conclusion of an infra change.
// The "proposed" status means the change is awaiting human approval.
// The "rejected" conclusion means a human rejected the proposed infra change.
type InfraStatus = "pending" | "proposed" | "queued" | "running" | "completed";
type InfraConclusion = "unknown" | "canceled" | "failure" | "rejected" | "success";

// The current status and conclusion of a deploy.
// If the status is not "completed" the conclusion is "unknown".
type DeployStatus = "queued" | "running" | "completed";
type DeployConclusion = "unknown" | "canceled" | "failure" | "success";

Triggering a rollout

Method: POST
Path: /api/apps/${APP_ID}/envs/${ENV_NAME}/rollouts

Path Parameters

JSON Request Body

A rollout can be triggered either with a commit sha or the name of a branch, depending on the JSON field passed in. Exactly one of these must be provided.

{
  // The commit hash to trigger a deploy for.
  "sha": string;
} | {
  // Name of the branch to trigger a deploy from.
  "branch": string;
}

Response

The API responds with a 2xx status code on successful creation of a new rollout.

On success it returns a Rollout object as its JSON response payload, representing the current state of the newly created rollout.