List SIM card actions

GET 
/sim_card_actions

This API lists a paginated collection of SIM card actions. It enables exploring a collection of existing asynchronous operations using specific filters.

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load.

page[size] integer

Possible values: >= 1 and <= 250

Default value: 20

The size of the page.

filter[sim_card_id] uuid

A valid SIM card ID.

filter[status] string

Possible values: [in-progress, completed, failed]

Filter by a specific status of the resource's lifecycle.

filter[bulk_sim_card_action_id] uuid

Filter by a bulk SIM card action ID.

filter[action_type] string

Possible values: [enable, enable_standby_sim_card, disable, set_standby, remove_public_ip, set_public_ip]

Filter by action type.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id uuid

Identifies the resource.

record_type string

sim_card_id uuid

The related SIM card identifier.

action_type string

Possible values: [enable, enable_standby_sim_card, disable, set_standby]

The operation type. It can be one of the following:


• enable - move the SIM card to the enabled status
• enable_standby_sim_card - move a SIM card previously on the standby status to the enabled status after it consumes data.
• disable - move the SIM card to the disabled status
• set_standby - move the SIM card to the standby status

status

object

value string

Possible values: [in-progress, completed, failed, interrupted]

The current status of the SIM card action.

reason string

It describes why the SIM card action is in the current status. This will be null for self-explanatory statuses, such as in-progress and completed but will include further information on statuses like interrupted and failed.

settings objectnullable

A JSON object representation of the action params.

created_at CreatedAt (string)

ISO 8601 formatted date-time indicating when the resource was created.

updated_at UpdatedAt (string)

ISO 8601 formatted date-time indicating when the resource was updated.

]

meta

object

total_pages integer

total_results integer

page_number integer

page_size integer

{
  "data": [
    {
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "record_type": "sim_card_action",
      "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "action_type": "enable",
      "status": {
        "value": "completed",
        "reason": "The data limit was exceeded."
      },
      "settings": {},
      "created_at": "2018-02-02T22:25:27.521Z",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "total_pages": 3,
    "total_results": 55,
    "page_number": 2,
    "page_size": 25
  }
}

default: Unexpected error

application/json

• Schema
• Example (from schema)

Schema

errors

Error[]

Array [

code intrequired

title stringrequired

detail string

source

object

pointer json-pointer

JSON pointer (RFC6901) to the offending entity.

parameter string

Indicates which query parameter caused the error.

meta object

]

{
  "errors": [
    {
      "code": "string",
      "title": "string",
      "detail": "string",
      "source": {
        "pointer": "string",
        "parameter": "string"
      },
      "meta": {}
    }
  ]
}

Loading...