API REFERENCE · VERSION 1.8

Northstar API

A unified interface for accessing structured data, managing resources and integrating services through a consistent REST API.

Base URL
https://api.northstar.example/v1
All requests use HTTPS and return JSON responses.

Authentication

Requests to protected resources require an API access token. Include the token in the Authorization header using the Bearer scheme.

HTTP HEADERExample

Authorization: Bearer YOUR_API_TOKEN
Accept: application/json
Content-Type: application/json

Making requests

The API follows standard HTTP conventions. Each resource is identified by its endpoint and accessed using the appropriate HTTP method.

REQUESTcURL

curl -X GET \
  https://api.northstar.example/v1/resources \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

API resources

Reference overview of available resource operations.

GET/v1/resourcesList resources

GET/v1/resources/{id}Retrieve resource

POST/v1/querySubmit query

GET/v1/metadataRetrieve metadata

Response format

Successful responses use a consistent JSON structure.

JSONExample response

{
  "success": true,
  "data": {
    "id": "res_8f31a2",
    "type": "resource",
    "created_at": "2026-10-31T12:00:00Z"
  },
  "request_id": "req_71c9e4"
}

Error codes

HTTP CODE	DESCRIPTION
`400`	Invalid request parameters
`401`	Authentication required
`403`	Insufficient permissions
`404`	Resource not found
`429`	Rate limit exceeded
`500`	Internal server error

Rate limits

API clients should implement retry handling and respect rate-limit response headers when integrating with services.

Support

For integration questions, consult the API reference and implementation guidelines provided by your service administrator.