Skip to main content
POST
/
sim_cards
/
{id}
/
actions
/
set_public_ip
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.simCards.actions.setPublicIP('6a09cdc3-8948-47f0-aa62-74ac943d6c58');

console.log(response.data);
{
  "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"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string<uuid>
required

Identifies the SIM.

Example:

"6a09cdc3-8948-47f0-aa62-74ac943d6c58"

Query Parameters

​
region_code
string

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

Example:

"dc2"

Response

Successful Response

​
data
SIMCardAction · object

This object represents a SIM card action. It allows tracking the current status of an operation that impacts the SIM card.