Get started with the Project API

Overview

The platform API (also called the Project API) creates and manages organisations, projects, domains, rules, Quant Cloud applications and environments, and AI services. It is a different API from the Content API, which pushes and publishes content for one project.

Create a scoped token

Tokens can be generated from your profile in the dashboard (QuantCDN or QuantGov). If you belong to multiple organizations you may scope the token to select organizations only.

The token will inherit your user role and permissions within organizations.

A token belongs to the platform whose dashboard created it. A QuantCDN token does not work on QuantGov, and a QuantGov token does not work on QuantCDN.

The project token that the Content API uses (Quant-Token) does not work on the platform API.

Make a request

Send requests to your dashboard host:

Platform	Platform API base
QuantCDN	`https://dashboard.quantcdn.io/api/v2` and `https://dashboard.quantcdn.io/api/v3`
QuantGov	`https://dash.quantgov.cloud/api/v2` and `https://dash.quantgov.cloud/api/v3`

/api/v2 manages projects and their configuration (rules, domains, custom headers, crawlers, KV stores, purge) and DNS zones.
/api/v3 manages Quant Cloud (applications, environments, compose, backups, commands) and AI services.

The paths are the same on both platforms. Only the host changes.

Provide the generated token as an Authorization: Bearer ... token in the request. An example via curl will look like:

curl https://dashboard.quantcdn.io/api/v2/organizations/[organization]/projects -H "Authorization: Bearer [token]"
curl https://dashboard.quantcdn.io/api/v3/organizations/[organization]/applications -H "Authorization: Bearer [token]"

The Cloud CLI (qc) uses this API too. It signs in through your browser (OAuth), so you do not need a token for qc.

Read the full schema documentation to better understand how to interact with the API. See QuantCDN and QuantGov for the host each tool uses.