GET
/
cloud
/
v2
/
inference
/
deployments
List Inference Instances
curl --request GET \
  --url https://api.gcore.com/cloud/v2/inference/deployments \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "results": [
    {
      "address": "https://example.com",
      "api_key_ids": [
        "3fa85f64-5717-4562-b3fc-2c963f66afa6"
      ],
      "auth_enabled": false,
      "command": [
        "nginx",
        "-g",
        "daemon off;"
      ],
      "containers": [
        {
          "deploy_status": {
            "ready": 1,
            "total": 3
          },
          "region_id": 7,
          "scale": {
            "cooldown_period": 60,
            "max": 3,
            "min": 1,
            "triggers": {
              "cpu": {
                "threshold": 80
              },
              "memory": {
                "threshold": 70
              }
            }
          }
        }
      ],
      "created_at": "2023-08-22T11:21:00Z",
      "description": "My first instance",
      "envs": {
        "DEBUG_MODE": "False",
        "KEY": "12345"
      },
      "flavor_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "image": "nginx:latest",
      "image_registry_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "listening_port": 8080,
      "name": "my-instance",
      "probes": {
        "liveness_probe": {
          "enabled": true,
          "probe": {
            "exec": {
              "command": "<any>"
            },
            "failure_threshold": 3,
            "http_get": {
              "headers": "<any>",
              "host": "<any>",
              "path": "<any>",
              "port": "<any>",
              "schema": "<any>"
            },
            "initial_delay_seconds": 0,
            "period_seconds": 5,
            "success_threshold": 1,
            "tcp_socket": {
              "port": "<any>"
            },
            "timeout_seconds": 1
          }
        },
        "readiness_probe": {
          "enabled": true,
          "probe": {
            "exec": {
              "command": "<any>"
            },
            "failure_threshold": 3,
            "http_get": {
              "headers": "<any>",
              "host": "<any>",
              "path": "<any>",
              "port": "<any>",
              "schema": "<any>"
            },
            "initial_delay_seconds": 0,
            "period_seconds": 5,
            "success_threshold": 1,
            "tcp_socket": {
              "port": "<any>"
            },
            "timeout_seconds": 1
          }
        },
        "startup_probe": {
          "enabled": true,
          "probe": {
            "exec": {
              "command": "<any>"
            },
            "failure_threshold": 3,
            "http_get": {
              "headers": "<any>",
              "host": "<any>",
              "path": "<any>",
              "port": "<any>",
              "schema": "<any>"
            },
            "initial_delay_seconds": 0,
            "period_seconds": 5,
            "success_threshold": 1,
            "tcp_socket": {
              "port": "<any>"
            },
            "timeout_seconds": 1
          }
        }
      },
      "status": "ACTIVE",
      "timeout": 120
    }
  ]
}

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

​
limit
integer

Limit the number of returned instances. Limited by max limit value of 1000

​
offset
integer

Offset value is used to exclude the first set of records from the result

​
order_by
string

Order instances by transmitted fields and directions (name.asc)

​
project_id
integer

Project ID

Response

List of inference instances

​
count
integer
required

Number of objects

Required range: x >= 0
Examples:

1

​
results
InferenceInstanceOutSerializer · object[]
required

Objects