Coolify Octri Demo
POST/servers/{uuid}/registries

Log in to a registry on a server

Submits registry credentials to run docker login on a server and save the login in the Docker configuration used by deployments. Provide the registry host, username, and password; logging in again to the same registry replaces the saved login. The request requires a token with the write and deploy permissions.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
uuidstringrequired
The UUID of the server on which to log in to the registry.

Registry credentials used to run docker login on the server.

passwordstringrequired
Password or access token. Never returned.
registrystringrequired
Registry host, optionally with a port. Use docker.io for Docker Hub.
usernamestringrequired
The username for the registry.

6 status codes
200Returns a message confirming that the server logged in to the registry.
messagestringoptional
400Returned when the token is invalid.
messagestringoptional
401Returned when the request is unauthenticated.
messagestringoptional
403Returned when the token lacks the `write` or `deploy` permission.
404Returned when the server resource is not found.
messagestringoptional
422Returned when the request fails validation.
errorsobjectoptional
messagestringoptional

Error handling

A 400 is returned for an invalid token, and a 401 is returned when the request is unauthenticated. A 403 is returned if the token lacks the write or deploy permission; a 404 indicates the server resource was not found, and a 422 indicates validation errors. The uuid path parameter must identify a server, and registry, username, and password are required.