registries

Test registry connection

Test connection to a registry with provided credentials Access policy: authenticated

post/registries/ping

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/registries/ping
  • Auth
    • API key in header X-API-KEY
    • or API key in header Authorization

Request body

Passwordstring

Password used to authenticate against this registry

TLSboolean

Use TLS

Type0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 required
URLstring required

URL or IP address of the Docker registry

Usernamestring

Username used to authenticate against this registry

Example request

{
  "Password": "registry_password",
  "TLS": true,
  "URL": "registry-1.docker.io",
  "Username": "registry_user"
}

Response

Success

messagestring

Message provides details about the connection test result

successboolean

Success indicates if the registry connection was successful

Example response

{
  "message": "Registry connection successful",
  "success": true
}

Changes

No recorded changes to this operation across all 21 revisions of this API.