To create a container registry, you should be aware of available locations where you can create your container registry.

Request

curl --location \
    --request GET \
    'https://api.ionos.com/containerregistries/locations' \
--header 'Authorization: Basic am9obkBleGFtcGxlLmNvbTphYmMxMjM=' \
--data-raw ''

Response

200 OK - Successfully received the locations of a registry

{
   "id": "locations",
   "type": "collection",
   "href": "",
   "items": [
       {
           "id": "de/fra"
       }
   ]
}

Response Fields

The IONOS Cloud Container Registry service allows you to manage Docker and OCI compatible registries for use by your managed Kubernetes clusters. Use a container registry to make sure you have a private registry to effectively support pulling images.

Quick Links:

ContainerRegistry API - OpenAPI Specification

Endpoint: https://api.ionos.com/containerregistries

To make authenticated requests to the API, you must include a few fields in the request headers. Please find relevant descriptions below:

Request parameter headers

Examples

We use curl in our examples, as this tool is available on Windows 10, Linux and macOS. Please refer to our blogpost about curl on Windows if you encounter any problems:

Once you have all the information about the available locations, you can check out the name of existing registries. The name you choose should be available and must not be already in use.

You can retrieve all the existing registries to check out the available names.

Request

curl --location  \
--request GET 'https://api.ionos.com/containerregistries/registries?limit=5' \
--header 'Authorization: Basic am9obkBleGFtcGxlLmNvbTphYmMxMjM=''  \
--data-raw ''

Query Parameters:

You can update the limit value to get specific registries.

Response

200 OK - Successfully showed the list of registries

{
   "id": "registries",
   "type": "collection",
   "href": "",
   "items": [
       {
           "id": "34341cbe-c06a-4f5f-8773-4ae677d85ba8",
           "type": "registry",
           "href": "",
           "metadata": {
               "createdBy": "samplel@ionos.com",
               "createdByUserId": "7ee77dcf-093f-48e6-9a14-161c73568589",
               "createdDate": "2022-09-05T17:44:52Z",
               "state": "Running"
           },
           "properties": {
               "name": "tue1608es",
               "location": "es/vit",
               "maintenanceWindow": {
                   "days": [
                       "Monday"
                   ],
                   "time": "01:23:00+00:00"
               },
               "garbageCollectionSchedule": {
                   "days": [
                       "Sunday",
                       "Saturday"
                   ],
                   "time": "19:30:00+00:00"
               },
               "storageUsage": {
                   "bytes": 0,
                   "updatedAt": "2022-09-05T17:46:06Z"
               },
               "hostname": "tue1608es.cr.es-vit.ionos.com"
           }
       }
   ],
   "limit": 5,
   "nextPageToken": "",
   "_links": {
       "next": "",
       "self": "/registries?limit=5",
       "previous": ""
   }
}

Response Fields

Once you have fetched your required information, you can now create a new registry. For the registry, you can alter the days and time. You can also update the location based on the available container registry locations.

We assume the following prerequisites:

With the POST request, you can create a container registry.

Request

Input Parameters

You can update the limit value to get specific registries based on the limit value being passed.

Response

200 OK - Successfully showed the list of registries

Response Fields

400 Bad Request - The request made is invalid or corrupted

To delete your container registry, destroying all container image data stored in it. The registryId must be provided. You can get it through .

Delete the registry using the following curl command:

Request

Path parameter

Response

204 - No Content

The request was successfully fulfilled and there is no content in the body.

404 Bad Request - Not Found

This way you can delete the registry completely.

This section shows you how to create a registry token. We assume the following prerequisite:

In this guide, we used test named repository to create registry tokens. Therefore, it is important that the you know your container registry name.

With the POST request, you get the registry token. You will need to provide registry ID:

Request

Response

200 OK - Successfully showed the list of registries

Response Fields

409 - Conflict

Docker CLI

If you want to push your local images to docker repository, you need to login to it using:

You need to enter the following options to login:

• Hostname

• Username

• Password

You can push the images to your registry by providing all required information. You can query registries and look at images manifest, discover tags, delete layers and delete manifest etc. In the Docker API calls:

• You can use the name of registry

• Authenticate the API calls with a token

To delete your token, the registryId and tokenId to be deleted must be provided.

You can get registryId through and .

Delete the information about the token using the following curl command:

Request

Path parameters:

Response

204 - No Content

The action was successful and the response body is empty.

400 Bad Request - The request made is invalid or corrupted

404 Bad Request - Not Found

This way you can delete a particular token.

Once you have created a repository using the and performed all operations you can delete the repository completely. Since does not allow to delete the entire repository, you can use IONOS Container Registry's API call for deleting the repository.

To delete your repository, the registryId and repository name for the repository to be deleted must be provided.

You can get registryId through .

Delete the repository using the following curl command:

Request

Path parameters

Response

204 - No Content

The request was successfully fulfilled and there is no content in the body.

You can get the information for a particular container registry. At this point, a hostname will be allocated to your registry. The registry hostname becomes a part of your image or your manifest or the repository name.

With the GET request, you can fetch the registry information by ID. The registryId must be provided. You can get it through GET Registries API call.

Request

curl --location  \
    --request GET 'https://api.ionos.com/containerregistries/registries/:789f8e3c-d5c8-4359-8f85-c200fb89e97c' \
    --header 'Authorization: Basic am9obkBleGFtcGxlLmNvbTphYmMxMjM=' \
--data-raw ''

Path parameters:

Response

200 OK - Successful operation

{
   "id": "8fb59000-494c-11ed-0242ac120002,
   "type": "registry",
   "href": "",
   "metadata": {
       "createdBy": "sample@test.com",
       "createdByUserId": "a5af0375-1c1d-4387-9ef1-6ee95d30e54a",
       "createdDate": "2022-10-07T14:30:06Z",
       "state": "Running"
   },
   "properties": {
       "name": "demo",
       "location": "de/fra",
       "garbageCollectionSchedule": {
           "days": [
               "Sunday",
               "Saturday"
           ],
           "time": "19:30:00+00:00"
       },
       "storageUsage": {
           "bytes": 0,
           "updatedAt": "2022-10-07T14:40:20Z"
       },
       "hostname": "demo.cr.de-fra.test.com"
   }
}
 

Response Fields

400 Bad Request - The request made is invalid or corrupted

{
 "httpStatus": 400,
 "messages": [
   {
     "errorCode": "123",
     "message": "ad velit dolor dolore laboris"
   },
   {
     "errorCode": "123",
     "message": "tempor"
   }
 ]
}

404 Not Found - The server did not find anything matching the request

{
 "httpStatus": 400,
 "messages": [
   {
     "errorCode": "123",
     "message": "ad velit dolor dolore laboris"
   },
   {
     "errorCode": "123",
     "message": "tempor"
   }
 ]
}