Execute instance action

The action can be one of: start, stop, reboot, reboot_hard, suspend or resume. Suspend and resume are not available for bare metal instances.

POST /cloud/v2/instances/{project_id}/{region_id}/{instance_id}/action

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
task_id_list = client.cloud.instances.action(
    instance_id="b5b4d65d-945f-4b98-ab6f-332319c724ef",
    project_id=1,
    region_id=1,
    action="start",
)
print(task_id_list.tasks)

200

{
  "tasks": [
    "d478ae29-dedc-4869-82f0-96104425f565"
  ]
}

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

Path Parameters

project_id · integer · required

Project ID

Example:

1

region_id · integer · required

Region ID

Example:

1

instance_id · string<uuid4> · required

Instance ID

Example:

"b5b4d65d-945f-4b98-ab6f-332319c724ef"

Body

application/json

StartActionInstanceSerializer

BasicActionInstanceSerializer

action · string · required

Instance action name

Allowed value: "start"

Example:

"start"

activate_profile · boolean | null · default: true

Used on start instance to activate Advanced DDoS profile

Example:

true

Response

200 - application/json

List of created tasks

tasks · string[] · required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

• GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.

Example:

["d478ae29-dedc-4869-82f0-96104425f565"]