List VM/baremetal instances
Visibility: internal · public ( OpenAPI Custom Extension: x-visibility )
"Virtual machine lifecycle", "Baremetal server lifecycle"; List all compute instances (VMs and baremetal).
Authorization
bearerAuth Bearer token authentication using OAuth2/OIDC tokens
In: header
Path Parameters
Region identifier
Project identifier
Query Parameters
Opaque cursor token returned in the previous response's nextPageToken. Pass to retrieve the next page of results.
Use for: Frequently updated resources (sessions, servers, clusters, API keys, instances, networks, addresses) where cursor pagination prevents items from being skipped or duplicated when the dataset changes between requests.
Mutually exclusive with offset — include one or the other, not both.
Maximum number of items to return per page. Applies to both cursor-based and offset-based pagination.
Range: 1–500. Default: 50.
501 <= value <= 500Number of items to skip before returning results.
Use for: Stable resources that change infrequently (roles, organizations, providers, policies, groups, projects) where offset pagination enables page-number UIs and total-count displays.
When using offset, the response includes a total field with the full item count. Mutually exclusive with pageToken — include one or the other, not both.
00 <= valueResponse Body
application/json
application/json
application/json
application/json
curl -X GET "https://api.k0rdent.ai/v1/regions/string/projects/string/compute/instances"{
"instances": [
{
"selfLink": "/v1/regions/us-texas-1/projects/project-x9y8z7/compute/instances/instance-d4e5f6",
"uid": "07cc67f4-45d6-494b-adac-09b5cbc7e2b5",
"id": "instance-d4e5f6",
"displayName": "string",
"description": "string",
"labels": {
"property1": "string",
"property2": "string"
},
"type": "/v1/regions/us-texas-1/zones/us1-a/instance-types/g1-xlarge",
"instanceMetadata": [
{
"key": "ssh-keys",
"value": "admin:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIJeaD1heScpzmiypsUSb0T3lkmg2d/onGkPviaZ2Rtgc admin@hostname\nguest:ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAIBYgtXDI3X7eELjQ+D+qbJGqgfa+OqvY7jo/EuLv1ECd guest@hostname\n"
}
],
"hostname": "string",
"lifecycle": {
"status": "PROVISIONING",
"statusMessage": "string"
},
"disks": [
{
"sizeGb": 0,
"interface": "SCSI",
"source": "/v1/regions/us-texas-1/compute/images/ubuntu-24.04-20260202-3",
"boot": true,
"type": "PERSISTENT",
"mode": "READ_ONLY"
}
],
"nics": [
{
"network": "/v1/regions/us-texas-1/projects/project-x9y8z7/compute/networks/network-g7h8i9",
"subnet": "http://example.com",
"ipv4Address": "string",
"ipv6Address": "string",
"vlan": 0
}
],
"gpus": [
{
"type": "http://example.com",
"count": 0
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
],
"nextPageToken": "string",
"total": 0
}{
"error": {
"code": 0,
"message": "string",
"details": [
{}
]
}
}{
"error": {
"code": 0,
"message": "string",
"details": [
{}
]
}
}{
"error": {
"code": 0,
"message": "string",
"details": [
{}
]
}
}How is this guide?