List Ips

GET 
/ips

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

Request

Query Parameters

page[number] integer

Possible values: >= 1

Default value: 1

The page number to load

page[size] integer

Possible values: >= 1 and <= 250

Default value: 250

The size of the page

filter[connection_id] string

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

filter[ip_address] string

IP adddress represented by this resource.

filter[port] integer

Port to use when connecting to this IP.

Responses

200: Successful response with a list of IPs.

application/json

• Schema
• Example (from schema)

Schema

data

object[]

Array [

id int64

Identifies the type of resource.

record_type string

Identifies the type of the resource.

connection_id string

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

ip_address string

IP adddress represented by this resource.

port integer

Default value: 5060

Port to use when connecting to this IP.

created_at string

ISO 8601 formatted date indicating when the resource was created.

updated_at string

ISO 8601 formatted date indicating when the resource was updated.

]

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

400: Bad request, the request was unacceptable, often due to missing a required parameter.

application/json

• Schema
• Example (from schema)
• missingParameter

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

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

{
  "errors": [
    {
      "code": "10015",
      "title": "Bad Request",
      "detail": "The request failed because it was not well-formed.",
      "source": {
        "pointer": "/"
      },
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10015"
      }
    }
  ]
}

401: Unauthorized

application/json

• Schema
• Example (from schema)
• Authentication Failed

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

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

{
  "errors": [
    {
      "code": "10009",
      "title": "Authentication failed",
      "detail": "Could not understand the provided credentials.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10009"
      }
    }
  ]
}

403: The user doesn't have the required permissions to perform the requested action.

application/json

• Schema
• Example (from schema)
• notAuthorized

Schema

errors

object[]

Array [

code string

detail string

meta

object

url uri

title string

source

object

pointer string

]

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

{
  "errors": [
    {
      "code": "10010",
      "title": "Not authorized",
      "detail": "You are not authorized to access the requested resource.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10010"
      },
      "source": {
        "pointer": "/"
      }
    }
  ]
}

Loading...