Developer API
CLI Documentation

API docs version: v1.8743.0

Developers

API Documentation
CLI Documentation
Scaleway Learning

Consoles

Scaleway console
Dedibox console

Scaleway

Scaleway.com
Pricing
Blog
Careers

© 1999 - 2026 Scaleway. All rights reserved.

List all keys, sorted alphabetically by name.get

Create an annotation key.post

Retrieve a specific key.get

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

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

List all values, sorted alphabetically by name.get

Add a value definition to a key.post

Retrieve a specific value.get

Delete a value definition. Fails if the value is currently bound to any resource.delete

Update name or description.patch

Delete ALL values associated with a key. Fails if any of these values are currently bound to any resource.delete

Keys and values

List all keys and values for an organization, sorted alphabetically by key name and value name.get

List all bindings, or filter by Scaleway Resource Name or value ID. Response order by ID.get

Attach a value to a resource. Fails if the resource already has a value for this key.post

Detach an annotation from a resource.delete

Delete ALL bindings associated with a Scaleway Resource Name.delete

Delete ALL bindings associated with a value.delete

Annotations API

Annotations API

Keys and values

Download schema

Manage keys and values.

List all keys and values for an organization, sorted alphabetically by key name and value name.

GET

https://api.scaleway.com

/annotations/v1/all-keys-and-values

List all keys and values for an organization, sorted alphabetically by key name and value name. › query Parameters

organization_id

string · required

ID of the organization. (UUID format)

List all keys and values for an organization, sorted alphabetically by key name and value name. › Responses

200

scaleway.annotations.v1.ListAllKeysAndValuesResponse

scaleway.annotations.v1.ListAllKeysAndValuesResponse.Key[]

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

GET/annotations/v1/all-keys-and-values

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/annotations/v1/all-keys-and-values?organization_id=6170692e-7363-616c-6577-61792e636f6d"

Example Responses

{
  "keys": [
    {
      "id": "6170692e-7363-616c-6577-61792e636f6d",
      "name": "name",
      "description": "description",
      "values": [
        {
          "id": "6170692e-7363-616c-6577-61792e636f6d",
          "name": "name",
          "description": "description"
        }
      ]
    }
  ]
}

json

application/json

Values Bindings