Partner API

curl --silent --show-error --include --request GET "$API_BASE_URL/me" \
  --header "Authorization: Bearer $API_KEY"

{
  "partner": {
    "id": 42,
    "status": "active",
    "tenant_key": "partner-42"
  },
  "inflight": {
    "current": 0,
    "max": 20
  },
  "servers": {
    "count": 1,
    "max": 300
  },
  "limits": {
    "max_inflight": 20,
    "max_servers": 300,
    "credit_limit": "1000.00"
  },
  "credit": {
    "limit": "1000.00",
    "unbilled": "2.40",
    "available": "997.60",
    "breakdown": {
      "usage_month_to_date": "2.40",
      "closed_uninvoiced": "0.00",
      "open_invoices": "0.00",
      "credit_balance": "0.00"
    },
    "degraded": false,
    "as_of": "2026-09-10T00:00:00.000Z",
    "snapshot_as_of": "2026-09-10T00:00:00.000Z"
  },
  "key": {
    "key_id": "a1b2c3d4e5f6",
    "label": "Provisioning integration"
  }
}

curl --silent --show-error --include --request GET "$API_BASE_URL/plans" \
  --header "Authorization: Bearer $API_KEY"

{
  "plans": [
    {
      "code": "standard-2",
      "name": "Standard 2",
      "hourly_price": "0.1000",
      "monthly_price": "67.20",
      "monthly_cap_hours": 672,
      "backups": {
        "enabled": true
      },
      "specs": null
    }
  ]
}

curl --silent --show-error --include --request GET "$API_BASE_URL/regions" \
  --header "Authorization: Bearer $API_KEY"

{
  "regions": [
    {
      "code": "chicago",
      "name": "Chicago"
    }
  ]
}

curl --silent --show-error --include --request GET "$API_BASE_URL/images" \
  --header "Authorization: Bearer $API_KEY"

{
  "images": [
    {
      "code": "ubuntu-24.04",
      "name": "Ubuntu 24.04 LTS",
      "cloud_init": true
    }
  ]
}

curl --silent --show-error --include --request GET "$API_BASE_URL/servers" \
  --header "Authorization: Bearer $API_KEY"

{
  "servers": [
    {
      "id": "srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3",
      "name": "web-01",
      "status": "active",
      "failure": null,
      "plan": "standard-2",
      "region": "chicago",
      "image": "ubuntu-24.04",
      "ipv4": "203.0.113.10",
      "ipv6": null,
      "locked": false,
      "external_id": "customer-4711",
      "batch": null,
      "backups": {
        "enabled": true
      },
      "created_at": "2026-09-09T00:00:00.000Z",
      "active_at": "2026-09-09T00:00:30.000Z",
      "ssh_reachable_at": "2026-09-09T00:01:00.000Z",
      "destroy_requested_at": null,
      "version": 3,
      "updated_at": "2026-09-09T00:01:00.000Z",
      "cost": {
        "hourly": "0.1000",
        "month_to_date": "2.40",
        "projected": "52.80"
      }
    }
  ],
  "next_after": null
}

curl --silent --show-error --include --request POST "$API_BASE_URL/servers" \
  --header "Authorization: Bearer $API_KEY" \
  --header "Idempotency-Key: $IDEMPOTENCY_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "web-01",
  "plan": "standard-2",
  "region": "chicago",
  "image": "ubuntu-24.04",
  "ssh_keys": [
    123
  ],
  "external_id": "customer-4711"
}'

{
  "server": {
    "id": "srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3",
    "name": "web-01",
    "status": "provisioning",
    "failure": null,
    "plan": "standard-2",
    "region": "chicago",
    "image": "ubuntu-24.04",
    "ipv4": null,
    "ipv6": null,
    "locked": false,
    "external_id": "customer-4711",
    "batch": null,
    "backups": {
      "enabled": true
    },
    "created_at": "2026-09-10T00:00:00.000Z",
    "active_at": null,
    "ssh_reachable_at": null,
    "destroy_requested_at": null,
    "version": 1,
    "updated_at": "2026-09-10T00:00:00.000Z",
    "cost": {
      "hourly": "0.1000",
      "month_to_date": "0.00",
      "projected": "50.40"
    }
  },
  "price": {
    "hourly": "0.1000",
    "monthly_max": "67.20",
    "monthly_price": "67.20"
  },
  "password_generated": false
}

curl --silent --show-error --include --request GET "$API_BASE_URL/servers/srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3" \
  --header "Authorization: Bearer $API_KEY"

{
  "server": {
    "id": "srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3",
    "name": "web-01",
    "status": "active",
    "failure": null,
    "plan": "standard-2",
    "region": "chicago",
    "image": "ubuntu-24.04",
    "ipv4": "203.0.113.10",
    "ipv6": null,
    "locked": false,
    "external_id": "customer-4711",
    "batch": null,
    "backups": {
      "enabled": true
    },
    "created_at": "2026-09-09T00:00:00.000Z",
    "active_at": "2026-09-09T00:00:30.000Z",
    "ssh_reachable_at": "2026-09-09T00:01:00.000Z",
    "destroy_requested_at": null,
    "version": 3,
    "updated_at": "2026-09-09T00:01:00.000Z",
    "cost": {
      "hourly": "0.1000",
      "month_to_date": "2.40",
      "projected": "52.80"
    }
  }
}

curl --silent --show-error --include --request PATCH "$API_BASE_URL/servers/srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3" \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "locked": true
}'

{
  "server": {
    "id": "srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3",
    "name": "web-01",
    "status": "active",
    "failure": null,
    "plan": "standard-2",
    "region": "chicago",
    "image": "ubuntu-24.04",
    "ipv4": "203.0.113.10",
    "ipv6": null,
    "locked": true,
    "external_id": "customer-4711",
    "batch": null,
    "backups": {
      "enabled": true
    },
    "created_at": "2026-09-09T00:00:00.000Z",
    "active_at": "2026-09-09T00:00:30.000Z",
    "ssh_reachable_at": "2026-09-09T00:01:00.000Z",
    "destroy_requested_at": null,
    "version": 4,
    "updated_at": "2026-09-10T00:00:00.000Z",
    "cost": {
      "hourly": "0.1000",
      "month_to_date": "2.40",
      "projected": "52.80"
    }
  }
}

curl --silent --show-error --include --request DELETE "$API_BASE_URL/servers/srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3" \
  --header "Authorization: Bearer $API_KEY"

{
  "server": {
    "id": "srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3",
    "name": "web-01",
    "status": "destroying",
    "failure": null,
    "plan": "standard-2",
    "region": "chicago",
    "image": "ubuntu-24.04",
    "ipv4": "203.0.113.10",
    "ipv6": null,
    "locked": false,
    "external_id": "customer-4711",
    "batch": null,
    "backups": {
      "enabled": true
    },
    "created_at": "2026-09-09T00:00:00.000Z",
    "active_at": "2026-09-09T00:00:30.000Z",
    "ssh_reachable_at": "2026-09-09T00:01:00.000Z",
    "destroy_requested_at": "2026-09-10T00:00:00.000Z",
    "version": 4,
    "updated_at": "2026-09-10T00:00:00.000Z",
    "cost": {
      "hourly": "0.1000",
      "month_to_date": "2.40",
      "projected": "2.40"
    }
  }
}

curl --silent --show-error --include --request POST "$API_BASE_URL/servers/srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3/actions" \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "action": "reboot"
}'

{
  "task": {
    "id": 90210,
    "action": "reboot",
    "status": "pending"
  }
}

curl --silent --show-error --include --request GET "$API_BASE_URL/ssh-keys" \
  --header "Authorization: Bearer $API_KEY"

{
  "ssh_keys": [
    {
      "id": 123,
      "name": "deploy",
      "body": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB [email protected]"
    }
  ]
}

curl --silent --show-error --include --request POST "$API_BASE_URL/ssh-keys" \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "name": "deploy",
  "body": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB [email protected]"
}'

{
  "ssh_key": {
    "id": 123,
    "name": "deploy",
    "body": "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIAEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEBAQEB [email protected]"
  }
}

curl --silent --show-error --include --request DELETE "$API_BASE_URL/ssh-keys/123" \
  --header "Authorization: Bearer $API_KEY"

curl --silent --show-error --include --request GET "$API_BASE_URL/servers/srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3/backups" \
  --header "Authorization: Bearer $API_KEY"

{
  "backups": [
    {
      "id": 7,
      "status": "created",
      "created_at": "2026-09-09T06:00:00.000Z",
      "size": 1073741824
    }
  ]
}

curl --silent --show-error --include --request POST "$API_BASE_URL/servers/srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3/backups" \
  --header "Authorization: Bearer $API_KEY"

{
  "task": {
    "id": null,
    "action": "vm-backup",
    "status": "pending"
  }
}

curl --silent --show-error --include --request POST "$API_BASE_URL/servers/srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3/backups/7/restore" \
  --header "Authorization: Bearer $API_KEY"

{
  "task": {
    "id": 90212,
    "action": "vm-restore",
    "status": "pending"
  }
}

curl --silent --show-error --include --request GET "$API_BASE_URL/tasks/90210" \
  --header "Authorization: Bearer $API_KEY"

{
  "task": {
    "id": 90210,
    "action": "vm-restart",
    "status": "done",
    "server_id": "srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3"
  }
}

curl --silent --show-error --include --request GET "$API_BASE_URL/events" \
  --header "Authorization: Bearer $API_KEY"

{
  "events": [
    {
      "id": 1042,
      "type": "server.active",
      "at": "2026-09-09T00:00:30.000Z",
      "server_id": "srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3",
      "data": {
        "ipv4": "203.0.113.10",
        "seconds_since_request": 30
      }
    }
  ],
  "next_after": null
}

curl --silent --show-error --include --request GET "$API_BASE_URL/webhook" \
  --header "Authorization: Bearer $API_KEY"

{
  "webhook": {
    "url": "https://hooks.example.com/infra",
    "configured_at": "2026-09-10T00:00:00.000Z"
  }
}

curl --silent --show-error --include --request PUT "$API_BASE_URL/webhook" \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "url": "https://hooks.example.com/infra"
}'

{
  "webhook": {
    "url": "https://hooks.example.com/infra",
    "secret": "whsec_example_not_a_valid_secret",
    "note": "secret shown once; queued deliveries were dead-lettered, replay via /v1/events"
  },
  "dead_lettered": 0
}

curl --silent --show-error --include --request POST "$API_BASE_URL/webhook/test" \
  --header "Authorization: Bearer $API_KEY"

{
  "status": 204,
  "latency_ms": 82,
  "ok": true
}

curl --silent --show-error --include --request GET "$API_BASE_URL/usage" \
  --header "Authorization: Bearer $API_KEY" \
  --get \
  --data-urlencode 'month=2026-09'

{
  "month": "2026-09",
  "as_of": "2026-09-10T00:00:00.000Z",
  "plans": [
    {
      "code": "standard-2",
      "hours": 24,
      "capped_hours": 24,
      "vm_months": 0.0357,
      "monthly_price": "67.20",
      "hourly_price": "0.1000",
      "amount": "2.40"
    }
  ],
  "total": "2.40"
}

curl --silent --show-error --include --request GET "$API_BASE_URL/servers/srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3/usage" \
  --header "Authorization: Bearer $API_KEY" \
  --get \
  --data-urlencode 'month=2026-09'

{
  "usage": {
    "server_id": "srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3",
    "month": "2026-09",
    "plan": "standard-2",
    "days": [
      {
        "day": "2026-09-09",
        "hours": 24,
        "closed": true
      }
    ],
    "hours": 24,
    "capped_hours": 24,
    "hourly_price": "0.1000",
    "amount": "2.40"
  }
}

curl --silent --show-error --include --request GET "$API_BASE_URL/billing/estimate" \
  --header "Authorization: Bearer $API_KEY"

{
  "estimate": {
    "period": "2026-09",
    "as_of": "2026-09-10T00:00:00.000Z",
    "month_to_date": {
      "hours": 24,
      "amount": "2.40"
    },
    "projected_month_end": {
      "amount": "52.80",
      "assumes": "current servers run to month end, no creates or destroys"
    },
    "next_invoice": {
      "month": "2026-09",
      "amount": "52.80",
      "issued_on": "2026-10-01",
      "due_on": "2026-10-01"
    },
    "per_plan": [
      {
        "code": "standard-2",
        "hours": 24,
        "capped_hours": 24,
        "vm_months": 0.0357,
        "monthly_price": "67.20",
        "hourly_price": "0.1000",
        "month_to_date": "2.40",
        "projected": "52.80"
      }
    ],
    "per_server": [
      {
        "id": "srv_01J8Z3M4N5P6Q7R8S9T0V1W2X3",
        "name": "web-01",
        "plan": "standard-2",
        "hourly_price": "0.1000",
        "hours": 24,
        "month_to_date": "2.40",
        "projected": "52.80"
      }
    ]
  }
}