Endpoint examples

Explore common project and deployment operations.

These examples cover the most common Northstar workflows. Replace sample identifiers with values from your workspace.

List projects

http

GET /v1/projects?limit=20

bash

curl "https://api.northstar.example/v1/projects?limit=20" \
  --header "Authorization: Bearer $NORTHSTAR_TOKEN"

Create a project

http

POST /v1/projects
Content-Type: application/json

json

{
  "name": "Demo Store",
  "region": "eu-west"
}

A successful request returns 201 Created with the project resource.

Start a deployment

bash

curl --request POST \
  https://api.northstar.example/v1/projects/prj_01J8YQ2N7F/deployments \
  --header "Authorization: Bearer $NORTHSTAR_TOKEN" \
  --header "Content-Type: application/json" \
  --header "Idempotency-Key: release-2026-08-04" \
  --data '{"ref":"main","environment":"production"}'

Cancel a deployment

http

POST /v1/deployments/dep_01J8Z41DQP/cancel

Only deployments in queued or running state can be cancelled. Completed deployments remain available as immutable history.

API overview

Webhooks