Create Private Registry

Create a private registry in an organization

Create a private registry in a specific provider belonging to an organization. The id of the organization is fetched from CSP token

Request

URI

POST

https://api.app-catalog.vmware.com/v1/registries

COPY

Request Body

It contains details about the registry requested

CreatePrivateRegistryRequest of type(s) application/json

Required

Show optional properties

{
    "name": "My registry",
    "description": "Registry for storing container releases",
    "provider": "HARBOR",
    "url": "https://harbor.mydomain.com",
    "access_secret": "p4ssw0rd1234"
}

{
    "name": "My registry",
    "description": "Registry for storing container releases",
    "provider": "HARBOR",
    "url": "https://harbor.mydomain.com",
    "access_key": "robot$user123",
    "access_secret": "p4ssw0rd1234",
    "containers_organization": "my-containers-org",
    "charts_organization": "my-charts-org"
}

string

name

Required

Name of the registry

string

description

Required

Description of the registry

string

provider

Required

Provider of the registry (platform that hosts it). Supported values are: AMAZON_ELASTIC_CONTAINER_REGISTRY, HARBOR, NEXUS_CONTAINER_REGISTRY, AZURE_CONTAINER_REGISTRY, JFROG_CONTAINER_REGISTRY, GITHUB_CONTAINER_REGISTRY, GOOGLE_ARTIFACT_REGISTRY, DOCKERHUB, IONOS

string

url

Required

Url of the registry

string

access_key

Optional

Access key to authenticate to the registry

string

access_secret

Required

Access secret to authenticate to the registry

string

containers_organization

Optional

Dockerhub organization where the containers will be published (Only for DOCKERHUB registry provider)

string

charts_organization

Optional

Dockerhub organization where the charts will be published (Only for DOCKERHUB registry provider)

Authentication

This operation uses the following authentication methods.

BearerAuth

Responses

201

The private registry has been created

Operation doesn't return any data structure

Response Headers

string

Location

URL to the created private registry

400

An error related to the request

Returns ConstraintsViolationsError of type(s) application/problem+json

This response body class contains all of the following: InlineConstraintsViolationsError0

{
    "type": "https://example.com/probs/validation-error",
    "title": "Validation error",
    "status": 400,
    "detail": "There was an error validating the request",
    "violations": [
        {
            "field": "amount",
            "message": "It should be greater than zero"
        }
    ]
}

array of object

violations

Required

It represents a constraints violation error

403

The requesting user is not authorized to create registries

Returns Error403 of type(s) application/problem+json

This response body class contains all of the following: InlineError4030

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

500

An internal server error object

Returns Error500 of type(s) application/problem+json

This response body class contains all of the following: InlineError5000

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json

This response body class contains all of the following: InlineError5030

{
    "type": "https://example.com/probs/out-of-credit",
    "title": "You do not have enough credit.",
    "status": 403,
    "detail": "Your current balance is 30, but that costs 50",
    "instance": "/account/2217eb9c-f042-11eb-9a03-0242ac130003/msgs/abc"
}

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"access_secret:"string","description:"string","name:"string","provider:"string","url:"string"}' https://{api_host}/v1/registries

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Errors

Registries Operations

GET

Get Registries

POST