Retrieve Private Container Registries

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

Note:

• Your chosen name must be available for the Private Container Registry.
• All Private Container Registry names must be unique.
• Make sure the name is suitable for use in the new Private Container 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.

You can retrieve all the existing Private Container Registries to check out the available names.

Request

curl --location  \
--request GET 'https://api.ionos.com/containerregistries/registries?limit=5' \
--header 'Authorization: Bearer ${TOKEN}'  \
--data-raw ''

Query parameters

You can update the limit value to get specific Private Container Registries.

Field	Type	Description	Example
limit	integer	The limit of the Private Container Registries that have been retrieved	5

Response

200 OK - Successfully showed the list of Private Container Registries

{
   "id": "registries",
   "type": "collection",
   "href": "",
   "items": [
       {
           "id": "34341cbe-c06a-4f5f-8773-4ae677d85ba8",
           "type": "registry",
           "href": "",
           "metadata": {
               "createdBy": "[e-mail]",
               "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
limit	number	The output value if specified in the request.	5
id	string	The ID of the fetched output.	locations
type	string	The type of the resource that has been retrieved.	collection
href	URL (string)	URL to the object representation (absolute path).	https://api.ionos.com/cloudapi/v6/locations
createdBy	string	The ID of the user or service account that initiated the operation.	[e-mail]
createdByUserId	string	The email ID of the user or service account that initiated the operation.	7ee77dcf-093f-48e6-9a14-161c73568589
location	string	The location of the resource.	es/vit
days	array	The days of the week selected.	Monday

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