Sign in
Docker

Docker Registry Login

Logs in to a Docker registry using the provided credentials.

post/api/clusters/{clusterName}/docker/actions/registry-connect

Path parameters

clusterNamestring required

Cluster Name

Headers

Authorizationstring required

Insert your access token

Request body

authTypestring

"password" or "token"

passwordstring
privateboolean

true if private registry, false if public

templatestring

Optional template for the registry, e.g., "docker.io" or "quay.io"

updateboolean

true if updating existing credentials, false if new credentials

urlstring
usernamestring

Response

Docker registry login successful

string required

Changes

Changed in 2 of the 5 revisions of this API.11