Sign in
SIM Cards

Request setting a SIM card public IP

This API makes a SIM card reachable on the public internet by mapping a random public IP to the SIM card. <br/><br/> The API will trigger an asynchronous operation called a SIM Card Action. The status of the SIM Card Action can be followed through the List SIM Card Action API. <br/><br/> Setting a Public IP to a SIM Card incurs a charge and will only succeed if the account has sufficient funds.

post/sim_cards/{id}/actions/set_public_ip

Path parameters

idstring uuid required
Example:6a09cdc3-8948-47f0-aa62-74ac943d6c58

Identifies the SIM.

Query parameters

region_codestring
Example:dc2

The code of the region where the public IP should be assigned. A list of available regions can be found at the regions endpoint

Response

Action accepted. The response contains a SIM card action; poll GET /sim_card_actions/{id} with the action id to track progress.

Example response

{
  "data": {
    "action_type": "enable",
    "created_at": "2018-02-02T22:25:27.521Z",
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "sim_card_action",
    "settings": {},
    "sim_card_id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "status": {
      "reason": "The data limit was exceeded.",
      "value": "completed"
    },
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

Changes

Changed in 2 of the 61 revisions of this API.22

  • 1571b0380bd712See the full diff
    • ▲

      the // response's property type changed from integer to string, and format from int32 to no format for status

      response-property-type-changed

    • ●

      added the new disable_voice enum value to the / response property for the response status

      response-property-enum-value-added

    • ●

      added the new enable_voice enum value to the / response property for the response status

      response-property-enum-value-added

    This revision also has 64 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 8f5f4e5379941See the full diff
    • ▲

      the // response's property type changed from string to integer, and format from no format to int32 for status

      response-property-type-changed

    This revision also has 41 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog