Scaleway logo
Annotations API
Annotations API

Bindings

Download schema

Manage bindings.

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

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

List all bindings, or filter by Scaleway Resource Name or value ID. Response order by ID. › query Parameters

organization_id
​string · required

ID of the organization. (UUID format)

page
​integer · int32

Page number.

page_size
​integer · uint32

Maximum number of bindings on the page.

target_srn
​string

SRN of the resource for which to list all bindings.

value_id
​string

Value ID for which to list all bindings. (UUID format)

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

200
scaleway.annotations.v1.ListBindingsResponse

List of bindings for the organization. Response order by ID.

total_count
​integer · uint64

Total number of bindings returned.

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

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

Attach a value to a resource. Fails if the resource already has a value for this key. › Request Body

target_srn
​string

SRN of the resource to attach the value to.

value_id
​string

ID of the value to associate. (UUID format)

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

200
scaleway.annotations.v1.Binding
id
​string

ID of the binding. (UUID format)

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

SRN of the binding.

target_srn
​string

SRN of the resource the binding is attached to.

Key associated to the binding.

Value associated to the binding.

Detach an annotation from a resource.

DELETE
https://api.scaleway.com
/annotations/v1/bindings/{binding_id}

Detach an annotation from a resource. › path Parameters

binding_id
​string · required

ID of the binding to delete. (UUID format)

Detach an annotation from a resource. › Responses

No data returned

Delete ALL bindings associated with a Scaleway Resource Name.

DELETE
https://api.scaleway.com
/annotations/v1/bindings/delete-all-matching-srn

Delete ALL bindings associated with a Scaleway Resource Name. › query Parameters

target_srn
​string · required

SRN of the resource for which all bindings should be deleted.

organization_id
​string · required

ID of the organization. (UUID format)

Delete ALL bindings associated with a Scaleway Resource Name. › Responses

200
scaleway.annotations.v1.DeleteAllBindingsMatchingSRNResponse
total_deleted
​integer · uint64

Total number of bindings deleted.

Delete ALL bindings associated with a value.

DELETE
https://api.scaleway.com
/annotations/v1/bindings/delete-all-matching-value

Delete ALL bindings associated with a value. › query Parameters

value_id
​string · required

ID of the value for which all bindings should be deleted. (UUID format)

Delete ALL bindings associated with a value. › Responses

200
scaleway.annotations.v1.DeleteAllBindingsMatchingValueResponse
total_deleted
​integer · uint64

Total number of bindings deleted.

Keys and values