Get SIM card public IP definition

GET 
/sim_cards/:sim_card_id/public_ip

It returns the public IP requested for a SIM card.

Request

Path Parameters

sim_card_id uuidrequired

Identifies a SIM card.

Responses

200: Successful response

application/json

• Schema
• Example (from schema)

Schema

data

object

record_type string

sim_card_id uuid

type string

Possible values: [ipv4]

Default value: ipv4

ip string

The provisioned IP address. This attribute will only be available when underlying resource status is in a "provisioned" status.

created_at string

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

updated_at string

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

{
  "data": {
    "record_type": "sim_card_public_ip",
    "sim_card_id": "6b14e151-8493-4fa1-8664-1cc4e6d14158",
    "type": "ipv4",
    "ip": "192.168.0.0",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

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": {}
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/sim_cards/:sim_card_id/public_ip' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• default

---

{
  "data": {
    "record_type": "sim_card_public_ip",
    "sim_card_id": "6b14e151-8493-4fa1-8664-1cc4e6d14158",
    "type": "ipv4",
    "ip": "192.168.0.0",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z"
  }
}

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