Server notes
Endpoint: /api/servers/notes/
Manage notes attached to servers. Notes allow teams to document server configurations, maintenance history, and operational details. Notes support markdown formatting, private visibility, pinning, and user mentions.
List
List notes
Retrieve a paginated list of notes.
Request
GET /api/servers/notes/Query parameters
| Parameter | Type | Description |
|---|---|---|
server | UUID | Filter by server ID |
author | UUID | Filter by author user ID |
private | boolean | Filter by private status |
pinned | boolean | Filter by pinned status |
search | string | Search across content, server name, and author name |
ordering | string | Sort order (e.g., -added_at, pinned). Default: -pinned, -added_at |
page | integer | Page number |
page_size | integer | Results per page (default: 15, max: 100) |
Response
{
"count": 5,
"next": null,
"previous": null,
"results": [
{
"id": "c72e9f01-3a5b-4d8e-9f12-1a2b3c4d5e6f",
"server": {
"id": "7e3984de-49ab-4cc6-bcdf-21fbd35858b8",
"name": "web-server-01",
"os": "Ubuntu 22.04",
"is_connected": true
},
"author": {
"id": 1,
"name": "admin",
"email": "admin@example.com"
},
"content": "Upgraded to Ubuntu 22.04 LTS on 2024-01-15.",
"private": false,
"pinned": true,
"added_at": "2024-01-15T14:30:00Z",
"updated_at": "2024-01-15T14:30:00Z"
}
]
}Example
curl -X GET "https://your-workspace.us1.alpacon.io/api/servers/notes/?server=7e3984de-49ab-4cc6-bcdf-21fbd35858b8&pinned=true" \
-H "Authorization: token=\"alpat-xxxxxxxxxxxxxxxxxx\""Error responses
| Status | Error code | Description |
|---|---|---|
| 400 | note_pin_limit_exceeded | Maximum 3 pinned notes per server |
| 401 | — | Invalid or missing authentication. Uncoded {"detail": "..."} response |
| 403 | — | Insufficient permissions (e.g., editing another user’s private note). Uncoded {"detail": "..."} response |
| 403 | api_token_scope_missing | The API or service token doesn’t hold the note:<action> scope this request needs |
| 404 | — | Note not found. Uncoded {"detail": "..."} response |