Jump to

• Request
• Response

List all hosts in a resource pool

get

/api/v2/pools/{poolID}/hosts/

Retrieves a list of all hosts in a specific resource pool. You identity the resource pool using the pool_id parameter.

Note: This endpoint is deprecated and will no longer be available in the future release.

Request

Path Parameters

• poolID: string
  poolID

Security

• Authorization: apiKey
  Type: apiKey

Back to Top

Response

Supported Media Types

• application/json

200 Response

200 Response

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object items

{
    "items":{
        "properties":{
            "host_id":{
                "type":"string"
            },
            "pool_id":{
                "type":"string"
            },
            "tags":{
                "type":"null"
            }
        },
        "required":[
            "host_id",
            "pool_id",
            "tags"
        ],
        "type":"object"
    },
    "type":"array"
}

Nested Schema : items

Type: object

Show Source

• host_id: string
• pool_id: string
• tags: null

{
    "properties":{
        "host_id":{
            "type":"string"
        },
        "pool_id":{
            "type":"string"
        },
        "tags":{
            "type":"null"
        }
    },
    "required":[
        "host_id",
        "pool_id",
        "tags"
    ],
    "type":"object"
}

Default Response

Error Payload

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: string

{
    "items":{
        "type":"string"
    }
}

Back to Top