registries

Update a registry

Update a registry Access policy: restricted

put/registries/{id}

Request

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

Path parameters

idinteger required

Registry identifier

Request body

Authenticationboolean required

Is authentication against this registry enabled

BaseURLstring

BaseURL is used for quay registry

Namestring required

Name that will be used to identify this registry

Passwordstring

Password used to authenticate against this registry. required when Authentication is true

RegistryAccessesPortainerRegistryAccesses
URLstring required

URL or IP address of the Docker registry

Usernamestring

Username used to authenticate against this registry. Required when Authentication is true

Example request

{
  "BaseURL": "registry.mydomain.tld:2375",
  "Ecr": {
    "Region": "ap-southeast-2"
  },
  "Name": "my-registry",
  "Password": "registry_password",
  "URL": "registry.mydomain.tld:2375",
  "Username": "registry_user"
}

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"
}

Changes

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