List Ips
GET/ips
Get all IPs belonging to the user that match the given filters.
Request
Query Parameters
Possible values: >= 1
Default value: 1
The page number to load
Possible values: >= 1
and <= 250
Default value: 250
The size of the page
ID of the IP Connection to which this IP should be attached.
IP adddress represented by this resource.
Port to use when connecting to this IP.
Responses
200: Successful response with a list of IPs.
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
data
object[]
Identifies the type of resource.
Identifies the type of the resource.
ID of the IP Connection to which this IP should be attached.
IP adddress represented by this resource.
Default value: 5060
Port to use when connecting to this IP.
ISO 8601 formatted date indicating when the resource was created.
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
Array [
]
errors
object[]
meta
object
source
object
{
"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
Array [
]
errors
object[]
meta
object
source
object
{
"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
Array [
]
errors
object[]
meta
object
source
object
{
"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": "/"
}
}
]
}