retrieve_instances_list
List and filter all Contabo compute instances by name, status, region, IP, or other fields to find and manage instances in your account.
Instructions
List instances [GET /v1/compute/instances] List and filter all instances in your account
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | No | The name of the instance | |
| page | No | Number of page to be fetched. | |
| size | No | Number of elements per page. | |
| region | No | The Region of the instance | |
| search | No | Full text search when listing the instances. Can be searched by `name`, `displayName`, `ipAddress` | |
| status | No | The status of the instance | |
| orderBy | No | Specify fields and ordering (ASC for ascending, DESC for descending) in following format `field:ASC|DESC`. | |
| addOnIds | No | Identifiers of Addons the instances have | |
| ipConfig | No | Filter instances that have an ip config | |
| tenantId | No | Filter by tenant ID | |
| suspended | No | Filter instances by suspension state. When set to false, suspended instances are excluded from the response. Any other value returns all instances (default behavior). | |
| customerId | No | Filter by customer ID | |
| dataCenter | No | The data center of the instance | |
| instanceId | No | The identifier of the instance (deprecated) | |
| productIds | No | Identifiers of the instance products | |
| x-trace-id | No | Identifier to trace group of requests. | |
| displayName | No | The display name of the instance | |
| instanceIds | No | Comma separated instances identifiers | |
| productTypes | No | Comma separated instance's category depending on Product Id |