Get Base Images | Bitnami Secure Images

Get Base Images

Get base images in an organization

Return a paginated list of base images order by name available for an organization (shared and private ones). The id of the organization is fetched from CSP token

Request

URI

GET

https://api.app-catalog.vmware.com/v1/base-images

COPY

Query Parameters

PackagingType

packaging_type

Optional

Packaging type of an application

string of array

statuses

Optional

Return objects based on status (ACTIVE, DEPRECATED, DELETED)

statuses example

DEPRECATED,DELETED

string

name

Optional

Returns base images matches with the name

name example

centos 7

boolean

with_applications

Optional

Constraints: default: false

Base images whose number of applications is non zero (with_applications=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.

BearerAuth

Responses

200

Paginated list of base images in an organization

Returns BaseImagesPage of type(s) application/json

This response body class contains all of the following: InlineBaseImagesPage0 , InlineBaseImagesPage1

{
    "page": 1,
    "page_size": 5,
    "total_size": 10,
    "total_pages": 2,
    "items": [
        {
            "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
            "name": "Debian 11",
            "description": "Debian 11 base image",
            "container_image": "docker.io/library/debian:11",
            "operating_system": {
                "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
                "name": "Centos 7",
                "distro": "centos",
                "version": "7"
            },
            "healthy": true,
            "last_checked_at": "2023-03-03T00:59:52.762Z",
            "application_count": 2,
            "status": "ACTIVE",
            "packaging_type": "CONTAINER_IMAGE",
            "platforms": [
                {
                    "os_family": "linux",
                    "architecture": "amd64"
                }
            ],
            "pull_registry": {
                "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"
            },
            "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",
            "deprecated_at": "2023-03-03T00:59:52.762Z",
            "_links": {
                "pull_registry": {
                    "href": "/v1/registries/cddcfa79-352c-4555-9d28-4442de559876"
                },
                "operating_system": {
                    "href": "/v1/operating-system/351c1739-ca01-4a74-8124-1b99257cd7c9"
                }
            }
        }
    ]
}

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 base images

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/base-images

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Base Images Operations