About the Forge REST API

Forge provides a REST API that allows developers to interact programmatically with their sites, deployments, and account settings. Whether you're building custom deployment flows, integrating with CI/CD tools, or managing site configurations remotely, the Forge API gives you the flexibility to automate and extend your workflows.

API Versions

Forge currently supports two versions of its REST API: v1 and v2. These versions are available side-by-side, but we recommend starting with v2 for most new integrations. Here’s an overview of each:

Version 1 (v1): Simple and Internal

The v1 API was originally built to support internal tools like the Forge CLI and early deployment automation. It exposes a limited set of endpoints for user authentication, site listing, and deployment.

While functional, v1 uses a single access token that grants full access to your Forge account. This design is convenient for quick internal use but not ideal for team-based or scoped access.

📘 View full v1 API reference →

Version 2 (v2): Full-featured and Secure

The v2 API is a comprehensive evolution of the platform, designed to expose the full range of Forge features with a more secure and flexible authentication model.

With v2, you can:

• Scope access to specific sites using Site Tokens
• Manage deployments, domains, SSL, and bandwidth settings
• Query account plans and usage data
• Build more granular tooling and workflows

Authentication is more robust: you can still use an Account Token for global access, or use a Site Token for restricted, per-site operations — perfect for collaborative and modular development.

📘 View full v2 API reference →

---

Choosing Between v1 and v2

---

Getting Started

• If you’re building simple scripts or using the CLI, v1 may be sufficient.
• For full site management and secure integrations, we recommend starting with v2.