Integrations /
Get registry
Views a set of registry credential data.
Required permission
Account > Credentials > General > Read Encrypted
Path parameters
credentialId
string requiredID of the registry credential
Response body
- {object}Response object.
data
{object} requiredResult data.id
string requiredID of the docker credentialsmin length3max length39pattern^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$name
string requiredThe name of the docker credentials.min length3max length39pattern^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$provider
string requiredThe provider of the docker registry.one ofacr, ecr, gar, dockerhub, github, gitlab, custom, legacyregistryUrl
stringThe URL of the docker registry.aws
{object}region
stringThe region of the docker registry.gcp
{object}projectId
stringThe project ID of the GCP docker registry.azure
{object}resourceGroup
stringThe resource group of the Azure docker registry.integrationId
stringIntegration to use for this registry.pattern^((org|team)\/)?[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$credentials
{object}username
stringUsername for the docker registry. Required when `integrationId` is provided.password
stringPassword for the docker registry. Required when `integrationId` is provided.scope
{object} requiredpull
booleanWhether the credentials can pull images.push
booleanWhether the credentials can push images.restrictions
{object}restricted
boolean requiredWhether access to this credential is restricted.projects
[array]List of projects that have access to this credential.- string
updatedAt
stringtime of updatecreatedAt
stringtime of creation
API
CLI
JS Client
GET /v1/integrations/registries/{credentialId}
Example response
200 OK
Data about the registry credentials.
JSON
{
"data": {
"id": "example-credentials",
"name": "Example Docker Credentials"
}
}