Annotations API
​string · required​integer · int32​integer · uint32​integer · uint64
​string​string​string​string​string​string
​string · required​string | null​string | null​string​string​string
Keys
Manage keys.
List all keys, sorted alphabetically by name.
GET
https://api.scaleway.com
/annotations/v1/keys
query Parameters
organization_idID of the organization. (UUID format)
pagePage number.
page_sizeMaximum number of keys on the page.
List all keys, sorted alphabetically by name. › Responses
200
List of keys for an organization, sorted alphabetically by name.
total_countTotal number of keys returned.
Create an annotation key.
POST
https://api.scaleway.com
/annotations/v1/keys
Create an annotation key. › Request Body
organization_idID of the organization. (UUID format)
nameName of the annotation key.
descriptionDescription of the annotation key.
Create an annotation key. › Responses
200
idID of the annotation key. (UUID format)
nameName of the annotation key.
descriptionDescription of the annotation key.
Retrieve a specific key.
GET
https://api.scaleway.com
/annotations/v1/keys/{key_id}
Update name or description. All associated resources will immediately display the new name.
PATCH
https://api.scaleway.com
/annotations/v1/keys/{key_id}
path Parameters
key_idID of the key to update. (UUID format)
Update name or description. All associated resources will immediately display the new name. › Request Body
nameNew name of the key.
descriptionNew description of the key.
Update name or description. All associated resources will immediately display the new name. › Responses
200
idID of the annotation key. (UUID format)
nameName of the annotation key.
descriptionDescription of the annotation key.