GET
/
cloud
/
v1
/
instances
/
search
curl --request GET \
  --url https://api.gcore.com/cloud/v1/instances/search \
  --header 'APIKey: <api-key>'
{
  "count": 1,
  "results": [
    {
      "client_id": 2,
      "id": "0fc2bcde-209a-44d7-9506-1e92089b1695",
      "name": "my-instance",
      "project_id": "1",
      "project_name": "default",
      "region_id": "1",
      "region_name": "Luxembourg"
    }
  ]
}

Authorizations

APIKey
string
header
required

API key for authentication.

Query Parameters

id
string

Supports search by full or partial instance ID

Examples:

"ee2402d0-f0cd-4503-9b75-69be1d11c5f1"

instance_ip
string

Supports search by full or partial instance fixed IP address. Floating IPs are not supported

Examples:

"192.168.10.15"

name
string

Supports search by full or partial instance name

Examples:

"my-instance"

Response

200 - application/json

OK

The response is of type object.