Introduction

The Pantheon Public API is a REST API for managing your Pantheon account, sites, and environments. Use it to build your own scripts, automation, and integrations: look up your sites, create and manage environments, deploy code, run backups, and more.

Who it's for

Any Pantheon user can use the Public API. It's built for developers and teams who want to automate Pantheon tasks from their own tools, such as CI/CD pipelines, internal dashboards, or custom scripts.

How it works

All API requests are made over HTTPS to the following base URL:

Every request is authenticated with a Personal Access Token, sent in the Authorization header. The API acts as you: it can only see and do what your Pantheon account can already see and do. If your account can't perform an action, such as creating a multidev on a particular site, the API can't either.

Many actions, such as creating an environment or deploying code, start a workflow that runs in the background. The API returns the workflow's ID right away, and you poll the workflow to find out when it completes. See Start and monitor workflows for details.

API reference

The complete, interactive API reference is available at api.pantheon.io/v1/docs. The OpenAPI specification is available at api.pantheon.io/v1/openapi.json for use with API clients and code generators.

In this guide

1. Authenticate with the Public API: create a Personal Access Token and make your first request.
2. Get site information: look up a site by its UUID or name.
3. Start and monitor workflows: create a multidev environment and poll for completion.