Get Base Images

Get Base Images

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_host}/v1/base-images
COPY
Query Parameters
boolean
shared
Optional

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

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.
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 
"BaseImagesPage Object"

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

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/base-images
On This Page
Base Images Operations
GET
Get Base Images
POST
Create Base Image
GET
Get Base Image
DELETE
Delete Base Image
PATCH
Update Base Image