Get Products

Get Products

Return a paginated list of products supported in TAC.

Request
URI
GET
https://{api_host}/v1/products
COPY
Query Parameters
boolean
supports_customization
Optional

Filter by products that support customization

string
name
Optional

Return products that matches any part of the name

name example 
apache
string
order_field
Optional
Constraints: default: NAME

Name of the field to order the products: NAME (default), KEY, CATEGORY

order_field example 
NAME
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 supported products

Returns ProductBasicInfoPage of type(s) application/json
This response body class contains all of the following: InlineProductBasicInfoPage0 , InlineProductBasicInfoPage1 
{
    "page": 1,
    "page_size": 5,
    "total_size": 10,
    "total_pages": 2,
    "items": [
        {
            "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
        }
    ]
}

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 
"ConstraintsViolationsError Object"
array of object
violations
Required

It represents a constraints violation error


403

The requesting user is not authorized to get the products

Returns Error403 of type(s) application/problem+json
This response body class contains all of the following: InlineError4030 
"Error403 Object"

500

An internal server error object

Returns Error500 of type(s) application/problem+json
This response body class contains all of the following: InlineError5000 
"Error500 Object"

503

The server is temporarily unavailable

Returns Error503 of type(s) application/problem+json
This response body class contains all of the following: InlineError5030 
"Error503 Object"

Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/v1/products
On This Page
Products Operations
GET
Get Products