← All tags

Private-Registries API Reference

Manage private registry configurations.

6 endpoints tagged private-registries, each listing its parameters and possible responses. Search or scroll the index below to jump to a specific endpoint.

No endpoints match your search.

List private registries for an organization

GET /orgs/{org}/private-registries

Lists all private registry configurations available at the organization-level without revealing their encrypted

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.
`per_page`	query	no	The number of results per page (max 100). For more information, see "Using pagination in the REST API."
`page`	query	no	The page number of the results to fetch. For more information, see "Using pagination in the REST API."

Responses

Status	Description	Has JSON body
200	Response	yes
400	Bad Request	yes
404	Resource not found	yes

Create a private registry for an organization

POST /orgs/{org}/private-registries

Creates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
201	The organization private registry configuration	yes
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes

Get private registries public key for an organization

GET /orgs/{org}/private-registries/public-key

Gets the org public key, which is needed to encrypt private registry secrets. You need to encrypt a secret before you can create or update secrets.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.

Responses

Status	Description	Has JSON body
200	Response	yes
404	Resource not found	yes

Get a private registry for an organization

GET /orgs/{org}/private-registries/{secret_name}

Get the configuration of a single private registry defined for an organization, omitting its encrypted value.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.
`secret_name`	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
200	The specified private registry configuration for the organization	yes
404	Resource not found	yes

Update a private registry for an organization

PATCH /orgs/{org}/private-registries/{secret_name}

Updates a private registry configuration with an encrypted value for an organization. Encrypt your secret using LibSodium. For more information, see "Encrypting secrets for the REST API."

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.
`secret_name`	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
204	Response	no
404	Resource not found	yes
422	Validation failed, or the endpoint has been spammed.	yes

Delete a private registry for an organization

DELETE /orgs/{org}/private-registries/{secret_name}

Delete a private registry configuration at the organization-level.

Parameters

Name	In	Required	Description
`org`	path	yes	The organization name. The name is not case sensitive.
`secret_name`	path	yes	The name of the secret.

Responses

Status	Description	Has JSON body
204	Response	no
400	Bad Request	yes
404	Resource not found	yes