API overview

Understand resources, pagination, and request conventions.

The Northstar API follows REST conventions and exchanges JSON. Resource URLs are stable within a major API version.

Base URL

text

https://api.northstar.example/v1

Core resources

Resource	Description
/projects	Applications managed by Northstar
/deployments	Immutable deployment attempts
/environments	Deployment targets and variables
/webhooks	Event delivery destinations

Pagination

List endpoints use cursor pagination:

http

GET /v1/projects?limit=25&after=prj_01J8YQ2N7F

json

{
  "data": [],
  "page": {
    "next": "prj_01J8Z1B4M2",
    "has_more": true
  }
}

The default page size is 20 and the maximum is 100.

Dates and identifiers

Timestamps use ISO 8601 in UTC. Resource identifiers have readable prefixes such as prj_, dep_, and wh_; treat them as opaque strings.

Rate limits

Rate-limit headers report the request limit, remaining capacity, and reset time. When the API returns 429, wait for the retry-after duration before retrying.

Authentication

Endpoint examples