Get Supervisor Resources

Get Supervisor Resources

Returns a paginated list of supervisor resources. The supported odata fields are kind, name, namespace, and creationTimestamp. OData filtering is not supported

Request
URI
GET
https://{api_host}/deployment/api/supervisor-resources
COPY
Query Parameters
integer
page
Optional
Constraints: minimum: 0 default: 0

Zero-based page index (0..N)

integer
size
Optional
Constraints: minimum: 1 default: 20

The size of the page to be returned

string of array
sort
Optional

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

string of array
projects
Optional

A comma-separated list. Results must be associated with one of these project IDs.

string of array
kinds
Optional

A comma-separated list of kubernetes kinds

string of array
namespaces
Optional

A comma-separated list supervisor namespaces

string
search
Optional

Full-text search on supervisor resource name, namespace, and labels

integer
$top
Optional

Number of records you want

$top example
1
integer
$skip
Optional

Number of records you want to skip

$skip example
1
string
$orderby
Optional

Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

Authentication/Authorization
This operation uses the following authentication methods.
Responses
200

OK

Returns SliceSupervisorResource of type(s) application/json 
{
    "content": [
        {
            "additionalFields": {
                "additionalFields": {}
            },
            "apiVersion": "string",
            "deployment": {
                "id": "string",
                "name": "string"
            },
            "id": "string",
            "kind": "string",
            "metadata": {
                "annotations": {},
                "creationTimestamp": "string",
                "deletionGracePeriodSeconds": 0,
                "deletionTimestamp": "string",
                "labels": {},
                "name": "string",
                "namespace": "string",
                "resourceVersion": "string",
                "uid": "string"
            },
            "orgId": "string",
            "project": {
                "id": "string",
                "name": "string"
            }
        }
    ],
    "empty": false,
    "first": false,
    "last": false,
    "number": 0,
    "numberOfElements": 0,
    "pageable": {
        "offset": 0,
        "pageNumber": 0,
        "pageSize": 0,
        "paged": false,
        "sort": [
            {
                "ascending": false,
                "direction": "string",
                "ignoreCase": false,
                "nullHandling": "string",
                "property": "string"
            }
        ],
        "unpaged": false
    },
    "size": 0,
    "sort": [
        {
            "ascending": false,
            "direction": "string",
            "ignoreCase": false,
            "nullHandling": "string",
            "property": "string"
        }
    ]
}
array of object
content
Optional

A model that represents a resource created on a supervisor/kubernetes cluster

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort


401

Unauthorized

Returns SliceSupervisorResource of type(s) application/json 
"SliceSupervisorResource Object"
array of object
content
Optional

A model that represents a resource created on a supervisor/kubernetes cluster

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort


403

Forbidden

Returns SliceSupervisorResource of type(s) application/json 
"SliceSupervisorResource Object"
array of object
content
Optional

A model that represents a resource created on a supervisor/kubernetes cluster

boolean
empty
Optional

empty

boolean
first
Optional

first

boolean
last
Optional

last

integer As int32 As int32
number
Optional

number

integer As int32 As int32
numberOfElements
Optional

numberOfElements

object
pageable
Optional

pageable

integer As int32 As int32
size
Optional

size

array of object
sort
Optional

sort


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/deployment/api/supervisor-resources
On This Page
Supervisor Resources Operations
GET
Get Supervisor Resources
GET
Get Supervisor Resource By Id