Scaleway logo
Container Registry API
Container Registry API

Tags

Download schema

Tags allow you to organize your container images. This gives you the possibility of sorting and filtering your images in any organizational pattern of your choice, which in turn helps you arrange, control and monitor your cloud resources. You can assign as many tags as you want to each image.

List tags

GET
https://api.scaleway.com
/registry/v1/regions/{region}/images/{image_id}/tags

List all tags for a given image, specified by region. By default, the tags listed are ordered by creation date in ascending order. This can be modified via the order_by field. You can also define additional parameters for your query, such as the name.

List tags › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
image_id
​string · required

UUID of the image.

List tags › query Parameters

page
​integer · int32

A positive integer to choose the page to display.

page_size
​integer · uint32

A positive integer lower or equal to 100 to select the number of items to display.

Criteria to use when ordering tag listings. Possible values are created_at_asc, created_at_desc, name_asc, name_desc, region, status_asc and status_desc. The default value is created_at_asc.

Enum values:
created_at_asc
created_at_desc
name_asc
name_desc
Default: created_at_asc
name
​string

Filter by the tag name (exact match).

List tags › Responses

200
scaleway.registry.v1.ListTagsResponse

Paginated list of tags that match the selected filters.

total_count
​integer · uint32

Total number of tags that match the selected filters.

Get a tag

GET
https://api.scaleway.com
/registry/v1/regions/{region}/tags/{tag_id}

Retrieve information about a given image tag, specified by its tag_id and region. Full details about the tag, such as name, image_id, status, and digest are returned in the response.

Get a tag › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
tag_id
​string · required

UUID of the tag.

Get a tag › Responses

200
scaleway.registry.v1.Tag
id
​string

UUID of the tag.

name
​string

Tag name, unique to an image.

image_id
​string

Image ID the of the image the tag belongs to.

Tag status.

Enum values:
unknown
ready
deleting
error
locked
Default: unknown
digest
​string

Hash of the tag content. Several tags of a same image may have the same digest.

created_at
​string | null · date-time

Date and time of creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time of last update. (RFC 3339 format)

Delete a tag

DELETE
https://api.scaleway.com
/registry/v1/regions/{region}/tags/{tag_id}

Delete a given image tag. You must specify, in the endpoint, the region and tag_id parameters of the tag you want to delete.

Delete a tag › path Parameters

region
​string · enum · required

The region you want to target

Enum values:
fr-par
nl-ams
pl-waw
tag_id
​string · required

UUID of the tag.

Delete a tag › query Parameters

force
​boolean · deprecated · required

If two tags share the same digest the deletion will fail unless this parameter is set to true (deprecated).

Delete a tag › Responses

200
scaleway.registry.v1.Tag
id
​string

UUID of the tag.

name
​string

Tag name, unique to an image.

image_id
​string

Image ID the of the image the tag belongs to.

Tag status.

Enum values:
unknown
ready
deleting
error
locked
Default: unknown
digest
​string

Hash of the tag content. Several tags of a same image may have the same digest.

created_at
​string | null · date-time

Date and time of creation. (RFC 3339 format)

updated_at
​string | null · date-time

Date and time of last update. (RFC 3339 format)

Images