Get Supervisor Resource By Id

Get Supervisor Resource By Id

Returns a supervisor resource with the specified ID.

Request
URI
GET
https://{api_host}/deployment/api/supervisor-resources/{id}
COPY
Path Parameters
string
id
Required

id

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

OK

Returns SupervisorResource of type(s) application/json 
{
    "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"
    }
}
object
additionalFields
Optional

additionalFields

string
apiVersion
Required

API version of the resource

object
deployment
Optional

Deployment id and name of the deployment to which the supervisor resource belongs

string As uuid As uuid
id
Required

Supervisor resource id

string
kind
Required

The kind of the resource

object
metadata
Required

The metadata of the resource

string
orgId
Required

Supervisor resource org id

object
project
Required

Deployment id and name of the deployment to which the supervisor resource belongs


401

Unauthorized

Returns SupervisorResource of type(s) application/json 
"SupervisorResource Object"
object
additionalFields
Optional

additionalFields

string
apiVersion
Required

API version of the resource

object
deployment
Optional

Deployment id and name of the deployment to which the supervisor resource belongs

string As uuid As uuid
id
Required

Supervisor resource id

string
kind
Required

The kind of the resource

object
metadata
Required

The metadata of the resource

string
orgId
Required

Supervisor resource org id

object
project
Required

Deployment id and name of the deployment to which the supervisor resource belongs


403

Forbidden

Returns SupervisorResource of type(s) application/json 
"SupervisorResource Object"
object
additionalFields
Optional

additionalFields

string
apiVersion
Required

API version of the resource

object
deployment
Optional

Deployment id and name of the deployment to which the supervisor resource belongs

string As uuid As uuid
id
Required

Supervisor resource id

string
kind
Required

The kind of the resource

object
metadata
Required

The metadata of the resource

string
orgId
Required

Supervisor resource org id

object
project
Required

Deployment id and name of the deployment to which the supervisor resource belongs


404

Not Found

Returns SupervisorResource of type(s) application/json 
"SupervisorResource Object"
object
additionalFields
Optional

additionalFields

string
apiVersion
Required

API version of the resource

object
deployment
Optional

Deployment id and name of the deployment to which the supervisor resource belongs

string As uuid As uuid
id
Required

Supervisor resource id

string
kind
Required

The kind of the resource

object
metadata
Required

The metadata of the resource

string
orgId
Required

Supervisor resource org id

object
project
Required

Deployment id and name of the deployment to which the supervisor resource belongs


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