Sign in

v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
IPs

List Ips

Get all IPs belonging to the user that match the given filters.

get/ips

Query parameters

numberinteger

The page number to load

sizeinteger

The size of the page

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

connection_idstring

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

ip_addressstring

IP adddress represented by this resource.

portinteger

Port to use when connecting to this IP.

Consolidated filter parameter (deepObject style). Originally: filter[connection_id], filter[ip_address], filter[port]

{
  "ip_address": "192.168.0.0",
  "port": 5060
}

Response

Successful response with a list of IPs.

Example response

{
  "data": [
    {
      "connection_id": "3456789987654",
      "created_at": "2018-02-02T22:25:27.521Z",
      "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
      "ip_address": "192.168.0.0",
      "port": 5060,
      "record_type": "ip",
      "updated_at": "2018-02-02T22:25:27.521Z"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}