Primary IP Actions

List Actions

Lists multiple Actions.

Use the provided URI parameters to modify the result.

get/primary_ips/actions

Request

  • Base URL: https://api.hetzner.cloud/v1
  • URL: https://api.hetzner.cloud/v1/primary_ips/actions
  • Auth: HTTP bearer

Query parameters

idinteger[]

Filter the actions by ID. May be used multiple times.

The response will only contain actions matching the specified IDs.

[
  42
]
sortstring[]

Sort actions by field and direction. May be used multiple times.

For more information, see "Sorting".

statusstring[]

Filter the actions by status. May be used multiple times.

The response will only contain actions matching the specified statuses.

pageinteger
Example:1

Page number to return. For more information, see "Pagination".

per_pageinteger
Example:25

Maximum number of entries returned per page. For more information, see "Pagination".

Response

Request succeeded.

Example response

{
  "actions": [
    {
      "id": 42,
      "command": "start_resource",
      "started": "2016-01-30T23:55:00Z",
      "finished": "2016-01-30T23:55:00Z",
      "progress": 100,
      "resources": [
        {
          "id": 42,
          "type": "server"
        }
      ],
      "error": {
        "code": "action_failed",
        "message": "Action failed"
      }
    }
  ],
  "meta": {
    "pagination": {
      "page": 3,
      "per_page": 25,
      "previous_page": 2,
      "next_page": 4,
      "last_page": 4,
      "total_entries": 100
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.