List IP access control list mappings

5 parameters

AccountSidstringrequired

The unique identifier of the account responsible for the mappings. Must be a 34-character SID matching `AC` followed by 32 hexadecimal characters.

DomainSidstringrequired

The unique identifier of the SIP domain whose mappings to list. Must be a 34-character SID matching `SD` followed by 32 hexadecimal characters.

PageSizeintegeroptional

The number of mappings to return per page. Must be between 1 and 1000 and defaults to 50 when omitted.

Pageintegeroptional

The zero-based page index used to track client pagination state. Defaults to the API's initial page when omitted.

PageTokenstringoptional

The pagination token provided by the API for retrieving a specific page. Omit it when starting a new listing.

1 status code

200Returns a paginated collection of IP access control list mappings with page bounds, page links, page index, page size, and mapping resources.

endintegeroptional

first_page_uristringoptional

next_page_uristringoptional

pageintegeroptional

page_sizeintegeroptional

previous_page_uristringoptional

startintegeroptional

uristringoptional

ip_access_control_list_mappingsarray<object>optional

Error handling

AccountSid must be a 34-character account SID matching AC followed by 32 hexadecimal characters, and DomainSid must be a 34-character SIP domain SID matching SD followed by 32 hexadecimal characters. PageSize must be between 1 and 1000, while Page must be zero or greater; PageSize defaults to 50 when omitted.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.ipAccessControlListMappingsJson.list({
  accountSid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  domainSid: "c0a80123-4567-89ab-cdef-0123456789ab",
  pageSize: 20,
  page: 1,
  pageToken: "sk_live_4eC39Hq",
});

{
  "end": 0,
  "first_page_uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0",
  "ip_access_control_list_mappings": [
    {
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "Fri, 17 Jul 2015 21:25:15 +0000",
      "date_updated": "Fri, 17 Jul 2015 21:25:15 +0000",
      "friendly_name": "aaaa",
      "domain_sid": "SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "sid": "ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings/ALaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
    }
  ],
  "next_page_uri": null,
  "page": 0,
  "page_size": 50,
  "previous_page_uri": null,
  "start": 0,
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SIP/Domains/SDaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/IpAccessControlListMappings.json?PageSize=50&Page=0"
}

Request

Response

Errors