Public API

Base URL

https://api.orizon.ng/api/v1

Authentication

Create a platform API key in the dashboard and send it as a Bearer token. Keys are org-scoped and either full (read + write) or read (GET only). The key looks like orz_pk_… and the secret is shown once — store it safely.

curl https://api.orizon.ng/api/v1/projects \
  -H "Authorization: Bearer orz_pk_your_key_here"

Deploy a project

Trigger a build of the connected repository. Pass a branch, a specific commitSha, or a sourceTarballUrl (from the /uploads endpoint) to deploy local code.

curl -X POST https://api.orizon.ng/api/v1/projects/proj_123/deployments \
  -H "Authorization: Bearer orz_pk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"branch":"main"}'

Tail deployment logs

curl https://api.orizon.ng/api/v1/deployments/dep_123/logs \
  -H "Authorization: Bearer orz_pk_your_key_here"

Set environment variables

PUTreplaces the project's variables with the map you send and triggers a redeploy so the new values take effect.

curl -X PUT https://api.orizon.ng/api/v1/projects/proj_123/env \
  -H "Authorization: Bearer orz_pk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{"variables":{"NODE_ENV":"production","API_URL":"https://api.example.com"}}'

Endpoints

Every public-API endpoint, grouped by resource. This list is generated from the OpenAPI spec, so it always matches the live API. Endpoints marked (write) require a full key.