Retrieve an Instance
get
/api/v2/instances/{id}/
Make GET request to this resource to retrieve a single instance record containing the following fields:
id: Database ID for this instance. (integer)type: Data type for this instance. (choice)url: URL for this instance. (string)related: Data structure with URLs of related resources. (object)uuid: (string)hostname: (string)created: Timestamp when this instance was created. (datetime)modified: Timestamp when this instance was last modified. (datetime)capacity_adjustment: (decimal)version: (string)capacity: (integer)consumed_capacity: (field)percent_capacity_remaining: (field)jobs_running: Count of jobs in the running or waiting state that are targeted for this instance (integer)jobs_total: Count of all jobs that target this instance (integer)cpu: (integer)memory: (integer)cpu_capacity: (integer)mem_capacity: (integer)enabled: (boolean)managed_by_policy: (boolean)
Request
Supported Media Types
- application/json
Path Parameters
Query Parameters
-
search(optional): string
A search term.