Skip to main content
The Nixopus API lets you manage projects, deployments, domains, and more through HTTP requests.

​
Base URL

https://api.nixopus.com/api/v1/

​
Authentication

All API requests require a Bearer token in the Authorization header. You can use a session token or an API key. 
Authorization: Bearer nxp_your_api_key_here

​
Organization context

Most endpoints require an X-Organization-Id header to scope the request to a specific organization. 
X-Organization-Id: org_abc123

​
Rate limiting

API requests are rate-limited to 1,000 requests per hour per API key. When you hit the limit, the API returns 429 Too Many Requests with a Retry-After header.

​
Response format

All responses are JSON. Successful responses return a 2xx status code. Errors return a 4xx or 5xx status code with a JSON body containing an error field. 
{
  "error": "Organization not found"
}

​
Example request

curl -X GET https://api.nixopus.com/api/v1/deploy/applications \
  -H "Authorization: Bearer nxp_your_api_key_here" \
  -H "X-Organization-Id: org_abc123"

​
Endpoint reference

Explore the full list of available endpoints in the sidebar. The API reference is auto-generated from our OpenAPI spec and includes request/response schemas and an interactive playground.