Skip to main content
GET
Get a server's notes

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Path Parameters

server
string | null
required

The server uuid short

Example:

"ecc6f4f1"

Response

The record, as a JSON object. There is no envelope.

The server's notes, written by the customer or posted by the app installed on it.

notes
string | null
required

Markdown text, or null when there are none.

Example:

"Notes"

app_name
string | null
required

The app installed on the server, or null for a plain operating system.

Example:

"App name"

awaiting_app_details
boolean
required

Whether the app can still post its details. They replace the notes when it does.

Example:

true