Get Registries

Get Registries
Get registries in an organization

Return a paginated list of registries ordered by name for an organization. The id of the organization is fetched from CSP token

Request
URI
GET
https://api.app-catalog.vmware.com/v1/registries
COPY
Query Parameters
boolean
removed
Optional

It filters registries removed or not

string
provider
Optional

It filters registries by a provider

provider example
HARBOR
boolean
hosted
Optional

It filters registries automatically hosted by Bitnami Secure Images

boolean
vmware_managed
Optional

It filters registries manually hosted by Bitnami Secure Images

boolean
shared
Optional

Objects are private to the organization in the request (shared=false) or shared between organizations (shared=true)

boolean
owned
Optional

Object is owned by the organization in the request (owned=true)

integer
page
Optional
Constraints: minimum: 1 default: 1

An integer that identifies the page number for a paged response

integer
page_size
Optional
Constraints: minimum: 1 maximum: 100 default: 20

An integer that identifies the maximum page size for a paged response

Authentication
This operation uses the following authentication methods.
Responses
200

Paginated list of registries in an organization

Returns RegistriesPage of type(s) application/json
This response body class contains all of the following: InlineRegistriesPage0 , InlineRegistriesPage1 
{
    "page": 1,
    "page_size": 5,
    "total_size": 10,
    "total_pages": 2,
    "items": [
        {
            "id": "549cfa79-352c-4555-9d28-4442de551829",
            "name": "Harbor registry for my org",
            "url": "https://harbor.mydomain.com",
            "healthy": true,
            "last_checked_at": "2023-03-03T00:59:52.762Z",
            "description": "Registry for storing container releases",
            "hosted": false,
            "vmware_managed": false,
            "shared": false,
            "owned": false,
            "provider": "HARBOR",
            "created_at": "2023-03-03T00:59:52.762Z",
            "created_by": "johndoe",
            "updated_at": "2023-03-03T00:59:52.762Z",
            "updated_by": "johndoe",
            "removed_at": "2023-03-03T00:59:52.762Z",
            "removed_by": "johndoe",
            "application_count": 2,
            "credentials_limit": 10,
            "unhealthy_cause": "Get \"https://myregistry.org\": dial tcp 11.11.11.22:443: connect: no route to host",
            "_links": {
                "credentials": {
                    "href": "/v1/registries/cddcfa79-352c-4555-9d28-4442de559876/credentials"
                }
            }
        }
    ]
}

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 get the 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 -H 'Authorization: <value>' https://{api_host}/v1/registries
On This Page
Registries Operations
GET
Get Registries
POST
Create Private Registry
GET
Get Registry
DELETE
Delete Private Registry
PATCH
Update Private Registry
GET
Get Managed Registry Credentials
POST
Create Managed Registry Credential
GET
Get Managed Registry Credential
DELETE
Delete Managed Registry Credential