v13

latestOpenAPI 3.0.0zlibraw.githubusercontent.com2026-08-01265409652.5 KB

endpoints

List Registries on environment

List all registries based on the current user authorizations in current environment. Access policy: authenticated

get/endpoints/{id}/registries

Path parameters

idinteger required

Environment(Endpoint) identifier

Query parameters

namespacestring

required if kubernetes environment, will show registries by namespace

Response

Success

AccessTokenstring

Stores temporary access token

AccessTokenExpiryinteger

Authenticationboolean

Is authentication against this registry enabled

AuthorizedTeamsinteger[]

Deprecated in DBVersion == 18

AuthorizedUsersinteger[]

Deprecated in DBVersion == 18

BaseURLstring

Base URL, introduced for ProGet registry

Idinteger

Registry Identifier

Namestring

Registry Name

Passwordstring

Password or SecretAccessKey used to authenticate against this registry

RegistryAccessesPortainerRegistryAccesses

TeamAccessPoliciesPortainerTeamAccessPolicies

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

URLstring

URL or IP address of the Docker registry

UserAccessPoliciesPortainerUserAccessPolicies

Usernamestring

Username or AccessKeyID used to authenticate against this registry

Example response

[
  {
    "Authentication": true,
    "BaseURL": "registry.mydomain.tld:2375",
    "Ecr": {
      "Region": "ap-southeast-2"
    },
    "Id": 1,
    "ManagementConfiguration": {
      "Ecr": {
        "Region": "ap-southeast-2"
      },
      "TLSConfig": {
        "TLS": true,
        "TLSCACert": "/data/tls/ca.pem",
        "TLSCert": "/data/tls/cert.pem",
        "TLSKey": "/data/tls/key.pem"
      }
    },
    "Name": "my-registry",
    "Password": "registry_password",
    "URL": "registry.mydomain.tld:2375",
    "Username": "registry user"
  }
]