Images

Download schema

An image represents a container image. A container image is a file that includes all the requirements and instructions of a complete and executable version of an application. When running, it becomes one or multiple instances of that application.

The visibility of an image can be public - when anyone can pull it, private - when only users within your organization can pull it, or inherited from the namespace visibility - which is the default. The visibility of your image can be changed using the update image endpoit.

List images

GET

https://api.scaleway.com

/registry/v1/regions/{region}/images

List all images in a specified region. By default, the images 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 namespace_id and project_id parameters.

List images › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List images › 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.

order_by

scaleway.registry.v1.ListImagesRequest.OrderBy · enum

Criteria to use when ordering image 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

namespace_id

string

Filter by the namespace ID.

name

string

Filter by the image name (exact match).

organization_id

string

Filter by Organization ID.

project_id

string

Filter by Project ID.

List images › Responses

200

scaleway.registry.v1.ListImagesResponse

scaleway.registry.v1.Image[]

Paginated list of images that match the selected filters.

total_count

integer · uint32

Total number of images that match the selected filters.

Get an image

GET

https://api.scaleway.com

/registry/v1/regions/{region}/images/{image_id}

Retrieve information about a given container image, specified by its image_id and region. Full details about the image, such as name, namespace_id, status, visibility, and size are returned in the response.

Get an image › 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.

Get an image › Responses

200

scaleway.registry.v1.Image

id

string

UUID of the image.

name

string

Name of the image, it must be unique within the namespace.

namespace_id

string

UUID of the namespace the image belongs to.

status

scaleway.registry.v1.Image.Status · enum

Status of the image.

Enum values:

unknown

ready

deleting

error

locked

Default: unknown

status_message

string | null

Details of the image status.

visibility

scaleway.registry.v1.Image.Visibility · enum

Set to public to allow the image to be pulled without authentication. Else, set to private. Set to inherit to keep the same visibility configuration as the namespace.

Enum values:

visibility_unknown

inherit

public

private

Default: visibility_unknown

size

integer · uint64

Image size in bytes, calculated from the size of image layers. Image size in bytes, calculated from the size of image layers. One layer used in two tags of the same image is counted once but one layer used in two images is counted twice. (in bytes)

created_at

string | null · date-time

Date and time of image creation. (RFC 3339 format)

updated_at

string | null · date-time

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

tags

string[]

List of docker tags of the image.

Delete an image

DELETE

https://api.scaleway.com

/registry/v1/regions/{region}/images/{image_id}

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

Delete an image › 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.

Delete an image › Responses

200

scaleway.registry.v1.Image

id

string

UUID of the image.

name

string

Name of the image, it must be unique within the namespace.

namespace_id

string

UUID of the namespace the image belongs to.

status

scaleway.registry.v1.Image.Status · enum

Status of the image.

Enum values:

unknown

ready

deleting

error

locked

Default: unknown

status_message

string | null

Details of the image status.

visibility

scaleway.registry.v1.Image.Visibility · enum

Set to public to allow the image to be pulled without authentication. Else, set to private. Set to inherit to keep the same visibility configuration as the namespace.

Enum values:

visibility_unknown

inherit

public

private

Default: visibility_unknown

size

integer · uint64

created_at

string | null · date-time

Date and time of image creation. (RFC 3339 format)

updated_at

string | null · date-time

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

tags

string[]

List of docker tags of the image.

Update an image

PATCH

https://api.scaleway.com

/registry/v1/regions/{region}/images/{image_id}

Update the parameters of a given image, specified by its image_id and region. You can update the visibility parameter.

Update an image › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

image_id

string · required

ID of the image to update.

Update an image › Request Body

visibility

scaleway.registry.v1.Image.Visibility · enum

Set to public to allow the image to be pulled without authentication. Else, set to private. Set to inherit to keep the same visibility configuration as the namespace.

Enum values:

visibility_unknown

inherit

public

private

Default: visibility_unknown

Update an image › Responses

200

scaleway.registry.v1.Image

id

string

UUID of the image.

name

string

Name of the image, it must be unique within the namespace.

namespace_id

string

UUID of the namespace the image belongs to.

status

scaleway.registry.v1.Image.Status · enum

Status of the image.

Enum values:

unknown

ready

deleting

error

locked

Default: unknown

status_message

string | null

Details of the image status.

visibility

scaleway.registry.v1.Image.Visibility · enum

Set to public to allow the image to be pulled without authentication. Else, set to private. Set to inherit to keep the same visibility configuration as the namespace.

Enum values:

visibility_unknown

inherit

public

private

Default: visibility_unknown

size

integer · uint64

created_at

string | null · date-time

Date and time of image creation. (RFC 3339 format)

updated_at

string | null · date-time

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

tags

string[]

List of docker tags of the image.

Namespaces Tags