Values

Download schema

Manage values.

List all values, sorted alphabetically by name.

GET

https://api.scaleway.com

/annotations/v1/values

List all values, 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 values on the page.

key_id

string

ID of the key to list the values for. (UUID format)

List all values, sorted alphabetically by name. › Responses

200

scaleway.annotations.v1.ListValuesResponse

scaleway.annotations.v1.Value[]

List of values for a key, sorted alphabetically by name.

total_count

integer · uint64

Total number of values returned.

Add a value definition to a key.

POST

https://api.scaleway.com

/annotations/v1/values

Add a value definition to a key. › Request Body

key_id

string

ID of the key the value will be bound to. (UUID format)

name

string

Name of the value.

description

string

Description of the value.

Add a value definition to a key. › Responses

200

scaleway.annotations.v1.Value

id

string

ID of the value. (UUID format)

srn

string

SRN of the annotation value.

key_id

string

ID of the key the value is associated to. (UUID format)

name

string

Name of the value (e.g. "production" for a key "environment").

description

string

Description of the value.

Retrieve a specific value.

GET

https://api.scaleway.com

/annotations/v1/values/{value_id}

Retrieve a specific value. › path Parameters

value_id

string · required

ID of the value to retrieve. (UUID format)

Retrieve a specific value. › Responses

200

scaleway.annotations.v1.Value

id

string

ID of the value. (UUID format)

srn

string

SRN of the annotation value.

key_id

string

ID of the key the value is associated to. (UUID format)

name

string

Name of the value (e.g. "production" for a key "environment").

description

string

Description of the value.

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

DELETE

https://api.scaleway.com

/annotations/v1/values/{value_id}

Delete a value definition. Fails if the value is currently bound to any resource. › path Parameters

value_id

string · required

ID of the value to delete. (UUID format)

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

No data returned

Update name or description.

PATCH

https://api.scaleway.com

/annotations/v1/values/{value_id}

Update name or description. › path Parameters

value_id

string · required

ID of the value to update. (UUID format)

Update name or description. › Request Body

name

string | null

New name of the value.

description

string | null

New description of the value.

Update name or description. › Responses

200

scaleway.annotations.v1.Value

id

string

ID of the value. (UUID format)

srn

string

SRN of the annotation value.

key_id

string

ID of the key the value is associated to. (UUID format)

name

string

Name of the value (e.g. "production" for a key "environment").

description

string

Description of the value.

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

DELETE

https://api.scaleway.com

/annotations/v1/values/delete-all-matching-key

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

key_id

string · required

ID of the key for which to delete all values. (UUID format)

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

200

scaleway.annotations.v1.DeleteAllValuesMatchingKeyResponse

total_deleted

integer · uint64

Total number of values deleted.

Keys Keys and values