Bulk Initiate

API Reference

GPU Droplets

Actions

Acting on Tagged Droplets

gpu_droplets.actions.bulk_initiate(ActionBulkInitiateParams**kwargs) -> ActionBulkInitiateResponse

post/v2/droplets/actions

Some actions can be performed in bulk on tagged Droplets. The actions can be initiated by sending a POST to /v2/droplets/actions?tag_name=$TAG_NAME with the action arguments.

Only a sub-set of action types are supported:

• power_cycle
• power_on
• power_off
• shutdown
• enable_ipv6
• enable_backups
• disable_backups
• snapshot (also requires image:create permission)

ParametersExpand Collapse

type: Literal["enable_backups", "disable_backups", "reboot", 12 more]

The type of action to initiate for the Droplet.

Accepts one of the following:

"enable_backups"

"disable_backups"

"reboot"

"power_cycle"

"shutdown"

"power_off"

"power_on"

"restore"

"password_reset"

"resize"

"rebuild"

"rename"

"change_kernel"

"enable_ipv6"

"snapshot"

tag_name: Optional[str]

Used to filter Droplets by a specific tag. Can not be combined with name or type.
Requires tag:read scope.

ReturnsExpand Collapse

class ActionBulkInitiateResponse: …

actions: Optional[List[Action]]

id: Optional[int]

A unique numeric ID that can be used to identify and reference an action.

completed_at: Optional[datetime]

A time value given in ISO8601 combined date and time format that represents when the action was completed.

formatdate-time

region: Optional[Region]

region_slug: Optional[str]

A human-readable string that is used as a unique identifier for each region.

resource_id: Optional[int]

A unique identifier for the resource that the action is associated with.

resource_type: Optional[str]

The type of resource that the action is associated with.

started_at: Optional[datetime]

A time value given in ISO8601 combined date and time format that represents when the action was initiated.

formatdate-time

status: Optional[Literal["in-progress", "completed", "errored"]]

The current status of the action. This can be "in-progress", "completed", or "errored".

Accepts one of the following:

"in-progress"

"completed"

"errored"

type: Optional[str]

This is the type of action that the object represents. For example, this could be "transfer" to represent the state of an image transfer action.

HTTPPython

from gradient import Gradient

client = Gradient()
response = client.gpu_droplets.actions.bulk_initiate(
    type="reboot",
)
print(response.actions)

200 example

{
  "actions": [
    {
      "id": 36804636,
      "completed_at": "2020-11-14T16:30:06Z",
      "region": {
        "available": true,
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata",
          "install_agent",
          "storage",
          "image_transfer"
        ],
        "name": "New York 3",
        "sizes": [
          "s-1vcpu-1gb",
          "s-1vcpu-2gb",
          "s-1vcpu-3gb",
          "s-2vcpu-2gb",
          "s-3vcpu-1gb",
          "s-2vcpu-4gb",
          "s-4vcpu-8gb",
          "s-6vcpu-16gb",
          "s-8vcpu-32gb",
          "s-12vcpu-48gb",
          "s-16vcpu-64gb",
          "s-20vcpu-96gb",
          "s-24vcpu-128gb",
          "s-32vcpu-192g"
        ],
        "slug": "nyc3"
      },
      "region_slug": "nyc3",
      "resource_id": 3164444,
      "resource_type": "droplet",
      "started_at": "2020-11-14T16:29:21Z",
      "status": "completed",
      "type": "create"
    }
  ]
}

Returns Examples

200 example

{
  "actions": [
    {
      "id": 36804636,
      "completed_at": "2020-11-14T16:30:06Z",
      "region": {
        "available": true,
        "features": [
          "private_networking",
          "backups",
          "ipv6",
          "metadata",
          "install_agent",
          "storage",
          "image_transfer"
        ],
        "name": "New York 3",
        "sizes": [
          "s-1vcpu-1gb",
          "s-1vcpu-2gb",
          "s-1vcpu-3gb",
          "s-2vcpu-2gb",
          "s-3vcpu-1gb",
          "s-2vcpu-4gb",
          "s-4vcpu-8gb",
          "s-6vcpu-16gb",
          "s-8vcpu-32gb",
          "s-12vcpu-48gb",
          "s-16vcpu-64gb",
          "s-20vcpu-96gb",
          "s-24vcpu-128gb",
          "s-32vcpu-192g"
        ],
        "slug": "nyc3"
      },
      "region_slug": "nyc3",
      "resource_id": 3164444,
      "resource_type": "droplet",
      "started_at": "2020-11-14T16:29:21Z",
      "status": "completed",
      "type": "create"
    }
  ]
}