Skip to main content

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.

Request

Path Parameters

    id stringrequired

    IP Connection ID

Responses

200: Successful response with details about a connection.

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

    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.

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

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

401: Unauthorized

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

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

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

404: The requested resource doesn't exist.

Schema

    errors

    object[]

  • Array [

  • code string
    detail string

    meta

    object

    url uri
    title string

    source

    object

    pointer string
  • ]

Loading...