Get Operating Systems
Returns a paginated list of operating systems
Request
URI
GET
https://{api_host}/v1/operating-systems
COPY
Query Parameters
string
status
Optional
Status of the operating system (ACTIVE, DEPRECATED)
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
Responses
200
Paginated list of operating systems
Returns OperatingSystemPage of type(s) application/json
This response body class contains all of the following: InlineOperatingSystemPage0 , InlineOperatingSystemPage1
{
"page": 1,
"page_size": 5,
"total_size": 10,
"total_pages": 2,
"items": [
{
"id": "d16c7f4d-b38a-405b-a1ca-3ac0a79418c1",
"name": "Centos 7",
"distro": "centos",
"version": "7",
"status": "ACTIVE"
}
]
}
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 operating systems
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/operating-systems