Create a Private Container Registry Token

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

• A Private Container Registry

In this guide, we used test named repository to create Private Container Registry tokens. Therefore, it is important that you know your Private Container Registry name.

With the POST request, you get the Private Container Registry token. You must provide the Private Container Registry ID:

Request

Note: The sample requestID is 789f8e3c-d5c8-4359-8f85-c200fb89e97c.

curl --location  \
--request POST 'https://api.ionos.com/containerregistries/registries/:789f8e3c-d5c8-4359-8f85-c200fb89e97c/tokens' \
--header 'Authorization: Bearer ${TOKEN}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "properties": {
    "name": "test",
    "expiryDate": null,
    "scopes": [
      {
        "name": "*",
        "actions": [
          "pull", "push", "delete"
        ],
        "type": "repository"
      }
    ]
  }
}'

Response

200 OK - Successfully showed the list of Private Container Registries

{
    "id": "8fb592e4-494c-11ed-b878-0242ac120002",
    "type": "token",
    "href": "",
    "metadata": {
        "createdBy": "[e-mail]",
        "createdByUserId": "8hb792e4-494c-11ed-b878-0242ac120002",
        "createdDate": "2022-10-08T15:56:04Z",
        "state": "enabled"
    },
    "properties": {
        "name": "test",
        "scopes": [
            {
                "actions": [
                    "pull",
                    "push",
                    "delete"
                ],
                "name": "*",
                "type": "repository"
            }
        ],
        "expiryDate": null,
        "status": "enabled",
        "credentials": {
            "username": "test",
            "password": "<your-password>"
        }
    }
}

Response fields

Field	Type	Description	Example
id	string	The id of the created token.	8fb592e4-494c-11ed-b878-0242ac120002
createdBy	string	The user who created the token.	[e-mail]
createdByUserId	string	The ID of the user or service account that initiated the operation.	8fb59000-494c-11ed-0242ac120002
state	string	The status of the Private Container Registry.	Running
hostname	string	The allocated hostname for the particular Private Container Registry.	demo.cr.de-fra.test.com

Note:

• Your values will differ from those in the sample code. Your response will have a different id for your token.
• Save the username and password in the response sample for using the Docker commands.

409 - Conflict

{
   "httpStatus": 409,
   "messages": [
       {
           "errorCode": "0",
           "message": "already exists: name is not available"
       }
   ]
}

Docker CLI

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

docker login [OPTIONS] [SERVER]

You need to enter the following options to login:

• Hostname
• Username
• Password

For more information, refer to the the Docker Commands.

You can push the images to your Private Container Registry by providing all required information. You can query Private Container 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 Private Container Registry
• Authenticate the API calls with a token

To know more, explore the Docker Documentation. The Data Center Designer (DCD) also uses an easy to opt passthrough feature which as discussed uses Basic Auth feature, so you do not need to use a separate authentication method for the DCD.