Retrieve a connection

GET 
/connections/:id

Retrieves the high-level details of an existing connection. To retrieve specific authentication information, use the endpoint for the specific connection type.

Path Parameters

id stringrequired

IP Connection ID

200: Successful response with details about a connection.

application/json

• Schema
• Example (from schema)

Schema

data

object

id int64

Identifies the specific resource.

record_type string

Identifies the type of the resource.

active boolean

Defaults to true

anchorsite_override Anchorsite Override (string)

Possible values: [Latency, Chicago, IL, Ashburn, VA, San Jose, CA, Sydney, Australia, Amsterdam, Netherlands, London, UK, Toronto, Canada, Vancouver, Canada, Frankfurt, Germany]

Default value: Latency

Latency directs Telnyx to route media through the site with the lowest round-trip time to the user's connection. Telnyx calculates this time using ICMP ping messages. This can be disabled by specifying a site to handle all media.

connection_name string

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.

webhook_event_url urlnullable

The URL where webhooks related to this connection will be sent.

webhook_event_failover_url urlnullable

The failover URL where webhooks related to this connection will be sent if sending to the primary URL fails.

webhook_api_version string

Possible values: [1, 2]

Default value: 1

Determines which webhook format will be used, Telnyx API v1 or v2.

outbound_voice_profile_id int64

Identifies the associated outbound voice profile.

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "ip_connection",
    "active": true,
    "anchorsite_override": "Latency",
    "connection_name": "string",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "webhook_event_url": "https://example.com",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_api_version": "1",
    "outbound_voice_profile_id": "1293384261075731499"
  }
}

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": "/"
      }
    }
  ]
}

404: The requested resource doesn't exist.

application/json

• Schema
• Example (from schema)
• notFound

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": "10005",
      "title": "Resource not found",
      "detail": "The requested resource or URL could not be found.",
      "meta": {
        "url": "https://developers.telnyx.com/docs/overview/errors/10005"
      },
      "source": {
        "pointer": "/"
      }
    }
  ]
}

Request samples

• cURL

---

curl -L 'https://api.telnyx.com/v2/connections/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Response samples

• 200
• 400
• 401
• 403
• 404

---

{
  "data": {
    "id": "6a09cdc3-8948-47f0-aa62-74ac943d6c58",
    "record_type": "ip_connection",
    "active": true,
    "anchorsite_override": "Latency",
    "connection_name": "string",
    "created_at": "2018-02-02T22:25:27.521Z",
    "updated_at": "2018-02-02T22:25:27.521Z",
    "webhook_event_url": "https://example.com",
    "webhook_event_failover_url": "https://failover.example.com",
    "webhook_api_version": "1",
    "outbound_voice_profile_id": "1293384261075731499"
  }
}

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

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

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

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