1 of 9

API How-Tos

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:

GET Locations

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

Note: The retrieved locations are read-only and cannot be changed.

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

Note:

Your values will differ from those in the sample code. Your response will have different locations.
A location is identified by a combination of the following characters:
- a two-character value in Id represents a country (example: de)
- a three-character value in Id represents a city. The locationId is typically based on the IATA code of the city's airport (example: fra).

GET Registries

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.

Note:

Your chosen name must be available for the registry.
All registry names must be unique.
Make sure the name is suitable for use in the new registry: it only uses the characters "a-z", "0-9" or "-", starts with a letter and ends with a letter or number, and can be from 3 to 63 characters long and is accessible.

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

Note: Your values will differ from those in the sample code. Your response will have a different id and existing registries.

GET Locations

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

Note: The retrieved locations are read-only and cannot be changed.

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

Field

Type

Description

Example

Note:

Your values will differ from those in the sample code. Your response will have different locations.
A location is identified by a combination of the following characters:
- a two-character value in Id represents a country (example: de)
- a three-character value in Id represents a city. The locationId is typically based on the IATA code of the city's airport (example: fra).

GET Registries

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.

Note:

Your chosen name must be available for the registry.
All registry names must be unique.
Make sure the name is suitable for use in the new registry: it only uses the characters "a-z", "0-9" or "-", starts with a letter and ends with a letter or number, and can be from 3 to 63 characters long and is accessible.

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.

Field

Type

Description

Example

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

Field

Type

Description

Example

Note: Your values will differ from those in the sample code. Your response will have a different id and existing registries.