Skip to main content
POST
/
metadata
/
{siteId}
/
notes
Create a site note
curl --request POST \
  --url https://v1.api.altostrat.io/metadata/{siteId}/notes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Installation Instructions",
  "body": "### Step 1\nConnect the primary WAN interface."
}
'
{
  "type": "invalid_request_error",
  "code": "parameter_missing",
  "message": "The 'name' parameter is required for this request.",
  "doc_url": "https://docs.altostrat.io/errors/parameter_missing"
}

Authorizations

​
Authorization
string
header
required

A bearer token is required for all API requests.

Path Parameters

​
siteId
string
required

The unique identifier for the site.

Body

application/json

The content of the note.

​
name
string
required

A title for the note. This will be used to generate the filename.

Example:

"Installation Instructions"

​
body
string
required

The full content of the note in Markdown format.

Example:

"### Step 1\nConnect the primary WAN interface."

Response

The note was created successfully.