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.
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.
path Parameters
regionThe region you want to target
query Parameters
pageA positive integer to choose the page to display.
page_sizeA positive integer lower or equal to 100 to select the number of items to display.
order_byCriteria 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.
organization_idFilter by Organization ID.
project_idFilter by Project ID.
nameFilter by the namespace name (exact match).
List namespaces › Responses
Paginated list of namespaces that match the selected filters.
total_countTotal number of namespaces that match the selected filters.
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.
path Parameters
regionThe region you want to target
Create a namespace › Request Body
nameName of the namespace.
descriptionDescription of the namespace.
project_idProject ID on which the namespace will be created.
is_publicDefines whether or not namespace is public.
organization_idNamespace owner (deprecated).
Create a namespace › Responses
idUUID of the namespace.
nameName of the namespace, unique in a region across all organizations.
descriptionDescription of the namespace.
organization_idOwner of the namespace.
project_idProject of the namespace.
statusNamespace status.
status_messageNamespace status details.
endpointEndpoint reachable by docker.
is_publicDefines whether or not namespace is public.
sizeTotal size of the namespace, calculated as the sum of the size of all images in the namespace. (in bytes)
created_atDate and time of creation. (RFC 3339 format)
updated_atDate and time of last update. (RFC 3339 format)
image_countNumber of images in the namespace.
regionRegion the namespace belongs to.
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.
path Parameters
regionThe region you want to target
namespace_idUUID of the namespace.
Get a namespace › Responses
idUUID of the namespace.
nameName of the namespace, unique in a region across all organizations.
descriptionDescription of the namespace.
organization_idOwner of the namespace.
project_idProject of the namespace.
statusNamespace status.
status_messageNamespace status details.
endpointEndpoint reachable by docker.
is_publicDefines whether or not namespace is public.
sizeTotal size of the namespace, calculated as the sum of the size of all images in the namespace. (in bytes)
created_atDate and time of creation. (RFC 3339 format)
updated_atDate and time of last update. (RFC 3339 format)
image_countNumber of images in the namespace.
regionRegion the namespace belongs to.
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.
path Parameters
regionThe region you want to target
namespace_idUUID of the namespace.
Delete a namespace › Responses
idUUID of the namespace.
nameName of the namespace, unique in a region across all organizations.
descriptionDescription of the namespace.
organization_idOwner of the namespace.
project_idProject of the namespace.
statusNamespace status.
status_messageNamespace status details.
endpointEndpoint reachable by docker.
is_publicDefines whether or not namespace is public.
sizeTotal size of the namespace, calculated as the sum of the size of all images in the namespace. (in bytes)
created_atDate and time of creation. (RFC 3339 format)
updated_atDate and time of last update. (RFC 3339 format)
image_countNumber of images in the namespace.
regionRegion the namespace belongs to.
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.
path Parameters
regionThe region you want to target
namespace_idID of the namespace to update.
Update a namespace › Request Body
descriptionNamespace description.
is_publicDefines whether or not the namespace is public.
Update a namespace › Responses
idUUID of the namespace.
nameName of the namespace, unique in a region across all organizations.
descriptionDescription of the namespace.
organization_idOwner of the namespace.
project_idProject of the namespace.
statusNamespace status.
status_messageNamespace status details.
endpointEndpoint reachable by docker.
is_publicDefines whether or not namespace is public.
sizeTotal size of the namespace, calculated as the sum of the size of all images in the namespace. (in bytes)
created_atDate and time of creation. (RFC 3339 format)
updated_atDate and time of last update. (RFC 3339 format)
image_countNumber of images in the namespace.
regionRegion the namespace belongs to.