Cloud Providers /
Create docker registry
Creates a new docker registry.
Required permission
Account > Cloud > Registries > Create
Request body
- {object}
name
string requiredThe name of the cloud provider registry.min length3max length39pattern^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$description
stringThe description of the integration.max length200pattern^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$uid
stringUnique id of the registry.provider
string requiredCloud provider to be used for the selected resourceone ofaws, azure, civo, gcp, oci, cloudflare, byokregion
string requiredintegrationId
stringIntegration to use for this registry.pattern^((org|team)\/)?[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$restrictions
{object}BYOC restrictions configuration for controlling team accessenabled
boolean requiredEnable or disable BYOC restrictions for this entityteams
[array]List of teams that have access to this BYOC cluster- {object}
teamId
string requiredThe ID of the team that has access to this BYOC clusterupdatedAt
stringtime of updatecreatedAt
stringtime of creation
Response body
- {object}Response object.
data
{object} requiredResult data.name
string requiredThe name of the cloud provider registry.min length3max length39pattern^[a-zA-Z]((-|\s)?[a-zA-Z0-9]+((-|\s)[a-zA-Z0-9]+)*)?$description
stringThe description of the integration.max length200pattern^[a-zA-Z0-9.,?\s\\/'"()[\];`%^&*\-_:!]+$uid
stringUnique id of the registry.provider
string requiredCloud provider to be used for the selected resourceone ofaws, azure, civo, gcp, oci, cloudflare, byokregion
string requiredintegrationId
stringIntegration to use for this registry.pattern^((org|team)\/)?[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$restrictions
{object}BYOC restrictions configuration for controlling team accessenabled
boolean requiredEnable or disable BYOC restrictions for this entityteams
[array]List of teams that have access to this BYOC cluster- {object}
teamId
string requiredThe ID of the team that has access to this BYOC clusterupdatedAt
stringtime of updatecreatedAt
stringtime of creation
API
CLI
JS Client
POST /v1/cloud-providers/docker-registries
Example request
Request body
curl
curl --header "Content-Type: application/json" \
--header "Authorization: Bearer NORTHFLANK_API_TOKEN" \
--request POST \
--data '{"name":"Example Registry","description":"This is a new cloud provider registry.","uid":"nf-n7xyvdn4","provider":"gcp","region":"eu-west-1","integrationId":"gcp-integration"}' \
https://api.northflank.com/v1/cloud-providers/docker-registries
Example response
200 OK
Details about the created docker registry.
JSON
{
"data": {
"name": "Example Registry",
"description": "This is a new cloud provider registry.",
"uid": "nf-n7xyvdn4",
"provider": "gcp",
"region": "eu-west-1",
"integrationId": "gcp-integration"
}
}