GET /v2/registry/docker-credentials
In order to access your container registry with the Docker client or from a
Kubernetes cluster, you will need to configure authentication. The necessary
JSON configuration can be retrieved by sending a GET request to
/v2/registry/docker-credentials
.
The response will be in the format of a Docker config.json
file. To use the
config in your Kubernetes cluster, create a Secret with:
kubectl create secret generic docr \
--from-file=.dockerconfigjson=config.json \
--type=kubernetes.io/dockerconfigjson
By default, the returned credentials have read-only access to your registry
and cannot be used to push images. This is appropriate for most Kubernetes
clusters. To retrieve read/write credentials, suitable for use with the Docker
client or in a CI system, read_write may be provided as query parameter. For
example: /v2/registry/docker-credentials?read_write=true
By default, the returned credentials will not expire. To retrieve credentials
with an expiry set, expiry_seconds may be provided as a query parameter. For
example: /v2/registry/docker-credentials?expiry_seconds=3600
will return
credentials that expire after one hour.
Servers
- https://api.digitalocean.com
Query parameters
Name | Type | Required | Description |
---|---|---|---|
expiry_seconds |
Integer | No |
The duration in seconds that the returned registry credentials will be valid. If not set or 0, the credentials will not expire. Default value: 0 |
read_write |
Boolean | No |
By default, the registry credentials allow for read-only access. Set this query parameter to Default value: false |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.