---
title: "Docker Registry Login"
method: POST
path: "/api/clusters/{clusterName}/docker/actions/registry-connect"
tags: ["Docker"]
---

# Docker Registry Login

`POST /api/clusters/{clusterName}/docker/actions/registry-connect`

## Request

- The document declares no server URL.
- Auth: none declared. Required headers: `Authorization`

Logs in to a Docker registry using the provided credentials.

## Path parameters

- `clusterName` string, required

## Headers

- `Authorization` string, required

## Request body

- ServerDockerRegistryLoginForm
  - `authType` string: "password" or "token"
  - `password` string
  - `private` boolean: true if private registry, false if public
  - `template` string: Optional template for the registry, e.g., "docker.io" or "quay.io"
  - `update` boolean: true if updating existing credentials, false if new credentials
  - `url` string
  - `username` string

## Response `200`

Docker registry login successful

- string

## Other responses

- `400`: Error decoding request body
- `403`: No valid ACL
- `500`: Error creating request" or "Error making request to Docker registry" or "Docker registry login failed

## Changes

- **2026-07-17** `7465ea0ee21a`: 1 info
  - endpoint added
- **2023-03-31** `b57fc7b9446e`: 1 breaking
  - api path removed without deprecation

[Operation history](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/changes/api/clusters/:clusterName/docker/actions/registry-connect/post.md)

---

[API](https://skmtc.dev/signal18/apis/signal-18-dashboard-api.md) - [All operations](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signal18/apis/signal-18-dashboard-api/revisions/8ee8a1e31294?raw)