Pink Narwhal has a REST API for managing servers, backups, and restores programmatically. All requests use Bearer token authentication and return JSON in a { data: ... } envelope.
Base URL: https://pinknarwhal.com/api/v1
Rate limit: 60 requests per minute.
API access requires a Pro or Network plan. Starter plans do not have API access.
Every request needs an Authorization header:
Authorization: Bearer your-api-key-here
Manage your API keys from the API page in the dashboard (admin role required). You can create multiple keys and revoke them individually.
When you create a key, the full token is shown exactly once. Copy it. Store it somewhere safe. We cannot show it to you again.
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/servers | List all servers |
| GET | /api/v1/servers/:id | Get server details |
| PATCH | /api/v1/servers/:id | Update server settings |
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/servers/:id/backups | List backups for a server |
| POST | /api/v1/servers/:id/backups | Trigger a manual backup |
| GET | /api/v1/backups/:id | Get backup details |
| Method | Endpoint | Description |
|---|---|---|
| POST | /api/v1/backups/:id/restore | Start a restore |
| GET | /api/v1/restores/:id | Get restore status |
| Method | Endpoint | Description |
|---|---|---|
| GET | /api/v1/usage | Get storage and server count usage |
List your servers:
curl -H "Authorization: Bearer pk_live_abc123" \
https://pinknarwhal.com/api/v1/servers
Trigger a manual backup:
curl -X POST \
-H "Authorization: Bearer pk_live_abc123" \
https://pinknarwhal.com/api/v1/servers/abc123/backups
Check restore status:
curl -H "Authorization: Bearer pk_live_abc123" \
https://pinknarwhal.com/api/v1/restores/rst_456
All responses follow the same envelope format: { "data": ... }. Errors include a message field explaining what went wrong.
Was this article helpful?
On this page