Commands

Documentation for `scw registry`

The CLI documentation pages are currently under construction

The content is up to date. We're making improvements to the site over the next few weeks for a better experience.

This API allows you to manage your Container Registry resources.

Image management commands

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.

Delete an image

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

Usage:

Code
scw registry image delete <image-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
image-id	UUID of the image	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`

Get an image

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.

Usage:

Code
scw registry image get <image-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
image-id	UUID of the image	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`

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

Usage:

Code
scw registry image list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	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`.	One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`
namespace-id	Filter by the namespace ID
name	Filter by the image name (exact match)
project-id	Filter by Project ID
organization-id	Filter by Organization ID
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`, `all`

Update an image

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

Usage:

Code
scw registry image update <image-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
image-id	ID of the image to update	Required
visibility	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	One of: `visibility_unknown`, `inherit`, `public`, `private`
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`

Install a local Docker credential helper

This command will install the Docker credential helper for your account.

It will create a new script named docker-credential-scw. This script will be called each time Docker needs the credentials and will return the correct credentials. It avoid running docker login commands.

This command will install the Docker credential helper for your account.

Usage:

Code
scw registry install-docker-helper [arg=value ...]

Arguments:

Name	Description	Argument Specifications
path	Directory in which the Docker helper will be installed. This directory should be in your $PATH	Default: `/usr/local/bin`

This command will run the correct command in order to log you in on the registry with the chosen program. You will need to have the chosen binary installed on your system and in your PATH.

Usage:

Code
scw registry login [arg=value ...]

Arguments:

Name	Description	Argument Specifications
program	Program used to log in to the namespace	Default: `docker` One of: `docker`, `podman`
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`, `it-mil`

Logout of a registry

This command will run the correct command in order to log you out of the registry with the chosen program. You will need to have the chosen binary installed on your system and in your PATH.

Usage:

Code
scw registry logout [arg=value ...]

Arguments:

Name	Description	Argument Specifications
program	Program used to log in to the namespace	Default: `docker` One of: `docker`, `podman`
region	Region to target. If none is passed will use default region from the config	Default: `fr-par`

Namespace management commands

A namespace is a collection of container images, each bearing the unique identifier of that namespace. A namespace can be either public or private, by default.

Each namespace must have a globally unique name within its region. This means no namespaces in the same region can bear the same name.

You can use namespace privacy policies to specify whether everyone has the right to pull an image from a namespace or not. When an image is in a public namespace, anyone is able to pull it. You can set your namespace to private if you want to restrict access.

Create a namespace

Create a new Container Registry namespace. You must specify the namespace name and region in which you want it to be created. Optionally, you can specify the project_id and is_public in the request payload.

Usage:

Code
scw registry namespace create [arg=value ...]

Arguments:

Name	Description	Argument Specifications
name	Name of the namespace	Required Default: `<generated>`
description	Description of the namespace
project-id	Project ID to use. If none is passed the default project ID will be used
is-public	Defines whether or not namespace is public
organization-id	Organization ID to use. If none is passed the default organization ID will be used
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`

Delete a namespace

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

Usage:

Code
scw registry namespace delete <namespace-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
namespace-id	UUID of the namespace	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`

Get a namespace

Retrieve information about a given namespace, specified by its namespace_id and region. Full details about the namespace, such as description, project_id, status, endpoint, is_public, size, and image_count are returned in the response.

Usage:

Code
scw registry namespace get <namespace-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
namespace-id	UUID of the namespace	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`

List namespaces

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

Usage:

Code
scw registry namespace list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	Criteria to use when ordering namespace 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`.	One of: `created_at_asc`, `created_at_desc`, `description_asc`, `description_desc`, `name_asc`, `name_desc`
project-id	Filter by Project ID
name	Filter by the namespace name (exact match)
organization-id	Filter by Organization ID
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`, `all`

Update a namespace

Update the parameters of a given namespace, specified by its namespace_id and region. You can update the description and is_public parameters.

Usage:

Code
scw registry namespace update <namespace-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
namespace-id	ID of the namespace to update	Required
description	Namespace description
is-public	Defines whether or not the namespace is public
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`

Tag management commands

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.

Delete a tag

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

Usage:

Code
scw registry tag delete <tag-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
tag-id	UUID of the tag	Required
timeout	Maximum time to handle the request
~~force~~	If two tags share the same digest the deletion will fail unless this parameter is set to true (deprecated)	Deprecated
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`

Get a tag

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.

Usage:

Code
scw registry tag get <tag-id ...> [arg=value ...]

Arguments:

Name	Description	Argument Specifications
tag-id	UUID of the tag	Required
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`

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.

Usage:

Code
scw registry tag list [arg=value ...]

Arguments:

Name	Description	Argument Specifications
order-by	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`.	One of: `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`
image-id	UUID of the image	Required
name	Filter by the tag name (exact match)
region	Region to target. If none is passed will use default region from the config	Default: `fr-par` One of: `fr-par`, `nl-ams`, `pl-waw`, `all`

Image management commands

Delete an image

Get an image

List images

Update an image

Install a local Docker credential helper

Login to a registry

Logout of a registry

Namespace management commands

Create a namespace

Delete a namespace

Get a namespace

List namespaces

Update a namespace

Tag management commands

Delete a tag

Get a tag

List tags