Retrieve an access IP address

GET /access_ip_address/{access_ip_address_id}

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 accessIPAddressResponse = await client.accessIPAddress.retrieve('access_ip_address_id');

console.log(accessIPAddressResponse.id);

200

{
  "id": "<string>",
  "ip_address": "<string>",
  "source": "<string>",
  "status": "pending",
  "user_id": "<string>",
  "description": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

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

Path Parameters

access_ip_address_id · string · required

Response

200

application/json

Successful Response

id · string · required

ip_address · string · required

source · string · required

status · enum<string> · required

An enumeration.

Available options: pending, added

user_id · string · required

description · string

created_at · string<date-time>

updated_at · string<date-time>