Skip to main content
Use the Nixopus REST API to integrate deployments into your workflows and tools.

​
Base URL

All API requests should be made to: 
https://api.nixopus.com/v1

​
Authentication

Authenticate API requests using your API key in the Authorization header: 
Authorization: Bearer YOUR_API_KEY
Keep your API key secure. Never commit it to version control or expose it in client-side code.

​
Projects

​
List Projects

Get all projects for your account. 
GET /deploy/applications?page=1&page_size=20

​
Create Project

Create a new project. 
POST /deploy/application/project
Request Body: 
{
  "name": "my-app",
  "repository": "https://github.com/user/repo",
  "branch": "main",
  "environment": "production",
  "build_pack": "dockerfile",
  "port": 3000
}

​
Deploy Project

Trigger a deployment for an existing project. 
POST /deploy/application/project/deploy
Request Body: 
{
  "id": "proj_123"
}

​
Billing

​
Get Billing Status

Get current subscription and usage information. 
GET /billing/status
Response: 
{
  "data": {
    "has_active_subscription": true,
    "usage_stats": {
      "deployments_used": 5,
      "deployments_limit": 10,
      "is_unlimited": false
    }
  }
}

​
Examples

​
Deploy with cURL

curl -X POST https://api.nixopus.com/v1/deploy/application/project/deploy \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"id": "proj_123"}'