Create an Ip

Create a new IP object.

POST /ips

JavaScript

JavaScript

import Telnyx from 'telnyx';

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

const ip = await client.ips.create({ ip_address: '192.168.0.0' });

console.log(ip.data);

201

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "ip",
    "connection_id": "3456789987654",
    "ip_address": "192.168.0.0",
    "port": 5060,
    "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.

Body

application/json

ip_address · string · required

IP adddress represented by this resource.

Example:

"192.168.0.0"

connection_id · string

ID of the IP Connection to which this IP should be attached.

port · integer · default: 5060

Port to use when connecting to this IP.

Example:

5060

Response

201

application/json

Successful response with details about an IP.

data · Ip · object

Show child attributes

Example:

{
  "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
  "record_type": "ip",
  "connection_id": "3456789987654",
  "ip_address": "192.168.0.0",
  "port": 5060,
  "created_at": "2018-02-02T22:25:27.521Z",
  "updated_at": "2018-02-02T22:25:27.521Z"
}