Get Applications Offering

Get Applications Offering
Get all applications offered in Bitnami Secure Images

Returns a paginated list of applications offering

Request
URI
GET
https://api.app-catalog.vmware.com/v1/applications-offering
COPY
Query Parameters
CatalogId
catalog_id
Optional

A string as the identifier of a catalog

OperatingSystemId
operating_system_id
Optional

A string as the identifier of an operating system

string
operating_system_name
Optional

A string as the name of an operating system

of PackagingType array
packaging_types
Optional

Packaging type of an application

string of array
statuses
Optional

Return objects based on status flag (ENABLED, HIDDEN, DEPRECATED)

statuses example
ENABLED
string
product_name
Optional

Return applications that matches any part of the name

product_name example
apache
string
product_key
Optional

The key name of the product

string
branch
Optional

The branch of the product

string
order_field
Optional
Constraints: default: PRODUCT_NAME

Name of the field to order the applications: PRODUCT_NAME (default), PRODUCT_KEY, STATUS, BRANCH, PACKAGING_TYPE

order_field example
PRODUCT_KEY
string
order_direction
Optional
Constraints: default: ASC

Order to sort by the selected field: ASC (default) or DESC

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 applications offering

Returns ApplicationOfferingPage of type(s) application/json
This response body class contains all of the following: InlineApplicationOfferingPage0 , InlineApplicationOfferingPage1 
{
    "page": 1,
    "page_size": 5,
    "total_size": 10,
    "total_pages": 2,
    "items": [
        {
            "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
            "product": {
                "name": "Argo CD",
                "key": "argo-cd",
                "description": "Argo CD is a declarative, GitOps continuous delivery tool for Kubernetes",
                "long_display_name": "Argo CD packaged by VMware",
                "disclaimer": "Trademarks: This software listing is packaged by VMware. The respective trademarks mentioned in the offering are owned by the respective companies, and use of them does not imply any affiliation or endorsement",
                "category": "Developer Tools",
                "based_on_scratch": true,
                "latest_free": false
            },
            "packaging_type": "HELM_CHART",
            "branch": "2",
            "status": "ENABLED",
            "operating_systems": [
                {
                    "id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
                    "name": "Centos 7",
                    "distro": "centos",
                    "version": "7"
                }
            ],
            "end_of_life_at": "2023-03-03T00:00:00.000Z",
            "_links": {
                "operating_systems": [
                    {
                        "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 applications offering

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/applications-offering
On This Page
Applications Offering Operations
GET
Get Applications Offering Bitnami Summary
GET
Get Applications Offering
GET
Get Application Offering