---
title: "Test registry connection"
method: POST
path: "/registries/ping"
tags: ["registries"]
---

# Test registry connection

`POST /registries/ping`

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

## Request body

- RegistriesRegistryPingPayload
  - `Password` string — Password used to authenticate against this registry
  - `TLS` boolean — Use TLS
  - `Type` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8, required
  - `URL` string, required — URL or IP address of the Docker registry
  - `Username` string — Username used to authenticate against this registry

## Response `200`

Success

- RegistriesRegistryPingResponse
  - `message` string — Message provides details about the connection test result
  - `success` boolean — Success indicates if the registry connection was successful

## Other responses

- `400` — Invalid request
- `500` — Server error

---

[API](https://skmtc.net/portainer/apis/portainerce-api.md) · [All operations](https://skmtc.net/portainer/apis/portainerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portainer/portainerce-api/versions/ec51a8194ac0/schema)
