Skip to main content
GET
/
cloud
/
v1
/
instances
/
search
Search instances across all reseller clients
curl --request GET \
  --url https://api.gcore.com/cloud/v1/instances/search \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "results": [
    {
      "client_id": 123,
      "id": "<string>",
      "name": "<string>",
      "project_id": "<string>",
      "project_name": "<string>",
      "region_id": "<string>",
      "region_name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

​
id
string

Supports search by full or partial instance ID

Example:

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

​
instance_ip
string

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

Example:

"192.168.10.15"

​
name
string

Supports search by full or partial instance name

Example:

"my-instance"

Response

200 - application/json

OK

​
count
integer
required

Number of objects

Required range: x >= 0
Example:

1

​
results
SearchInstanceResultSerializer · object[]
required

Objects