Scaleway logo
Annotations API
Annotations API

Keys

Download schema

Manage keys.

List all keys, sorted alphabetically by name.

GET
https://api.scaleway.com
/annotations/v1/keys

List all keys, sorted alphabetically by name. › query Parameters

organization_id
​string · required

ID of the organization. (UUID format)

page
​integer · int32

Page number.

page_size
​integer · uint32

Maximum number of keys on the page.

List all keys, sorted alphabetically by name. › Responses

200
scaleway.annotations.v1.ListKeysResponse

List of keys for an organization, sorted alphabetically by name.

total_count
​integer · uint64

Total number of keys returned.

Create an annotation key.

POST
https://api.scaleway.com
/annotations/v1/keys

Create an annotation key. › Request Body

organization_id
​string

ID of the organization. (UUID format)

name
​string · pattern: ^[_\pL][_\pL0-9]*$

Name of the annotation key.

description
​string

Description of the annotation key.

Create an annotation key. › Responses

200
scaleway.annotations.v1.Key
id
​string

ID of the annotation key. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the annotation key.

name
​string

Name of the annotation key.

description
​string

Description of the annotation key.

Retrieve a specific key.

GET
https://api.scaleway.com
/annotations/v1/keys/{key_id}

Retrieve a specific key. › path Parameters

key_id
​string · required

ID of the key to retrieve. (UUID format)

Retrieve a specific key. › Responses

200
scaleway.annotations.v1.Key
id
​string

ID of the annotation key. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the annotation key.

name
​string

Name of the annotation key.

description
​string

Description of the annotation key.

Update name or description. All associated resources will immediately display the new name.

PATCH
https://api.scaleway.com
/annotations/v1/keys/{key_id}

Update name or description. All associated resources will immediately display the new name. › path Parameters

key_id
​string · required

ID of the key to update. (UUID format)

Update name or description. All associated resources will immediately display the new name. › Request Body

name
​string | null · pattern: ^[_\pL][_\pL0-9]*$

New name of the key.

description
​string | null

New description of the key.

Update name or description. All associated resources will immediately display the new name. › Responses

200
scaleway.annotations.v1.Key
id
​string

ID of the annotation key. (UUID format)

srn
​string · pattern: ^srn://annotations\.…

SRN of the annotation key.

name
​string

Name of the annotation key.

description
​string

Description of the annotation key.

Delete a key definition. Fails if the key has any associated values.

DELETE
https://api.scaleway.com
/annotations/v1/keys/{key_id}

Delete a key definition. Fails if the key has any associated values. › path Parameters

key_id
​string · required

ID of the key to delete. (UUID format)

Delete a key definition. Fails if the key has any associated values. › Responses

No data returned
Values