---
title: "Get All Connections"
method: GET
path: "/connections"
tags: ["Connections"]
---

# Get All Connections

`GET /connections`

## Query parameters

- `device-sip-registration-uri` string
- `termination-match` string
- `domain` string — This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. Then using in path for GET you can set to "~" to use the domain name linked to your token/key instead of the domain name itself when reading for your own domain.
- `reseller` string
- `route-chain` string
- `user-scope` string

## Response `200`

- object[]
  - `connection-orig-match-pattern` string, required — This is the connection's origination match pattern
  - `domain` string, required — This is the main organization name. This is used to link resource to its group/tenant/organization/enterprise. ~ and * can be used alone in special cases to mean My Domain (~) and All Domains (\*).
  - `description` string — This is the connection's description
  - `connection-term-match-pattern` string — Defaulted to connection-orig-match-pattern
  - `connection-audio-relay-enabled` string — Available options are "yes", "optional", "no". "Yes" will set the connection audio realy to "automatic". "Optional" will set it to "none". "No" will set it to "never". Default will be "yes".
  - `connection-address` string — This is the connection's address
  - `dial-plan` string — This is the connection's dial plan
  - `dial-policy` string — This is the connection's dial policy
  - `limits-max-active-calls-orig` integer — This is the connection's limit of maximum originating calls
  - `limits-max-active-calls-term` integer — This is the connection's limit of maximum terminating calls
  - `limits-max-active-calls-total` integer — This is the connection's limit of maximum total calls
  - `connection-linked-billing-user` string — This is the connection's linked billing user
  - `connection-sip-registration-username` string — This is the connection's authorized username
  - `connection-sip-registration-password` string — This is the connection's password
  - `connection-sip-registration-realm` string — This is the connection's authentication realm
  - `connection-orig-enabled` 'yes' | 'no'
  - `connection-term-enabled` 'yes' | 'no'
  - `connection-translation-request-host` string — This is the connection's translation request host.
  - `connection-translation-destination-host` string — This is the connection's translation destination host. This typically comes from the connection-orig-match-pattern. Defaults to ''
  - `connection-translation-request-user` string — This is the connection's translation request user. This is typically set to [*]. Defaults to ""
  - `connection-translation-destination-user` string — This is the connection's translation destination user. This is typically set to [*]. Defaults to ""
  - `connection-translation-source-user` string — This is the connection's translation source user. This is typically set to [*]. Defaults to ""
  - `connection-source-ip-checking-enabled` 'yes' | 'no'
  - `connection-include-server-header-enabled` 'yes' | 'no'
  - `connection-relay-comfort-noise-enabled` string — This will set whether there is an RTP Relay comfort noise. Can be set to yes or no. If not set, will be set to system-default
  - `connection-pcmu-only-enabled` 'yes' | 'no'
  - `connection-enforce-minimum-duration-enabled` 'yes' | 'no'
  - `connection-bind-to-alternate-interface-enabled` 'yes' | 'no'
  - `connection-block-video-in-sdp-enabled` 'yes' | 'no'
  - `connection-sip-get-new-dialog-destination-from` string — This will set the new dialog destination. Values available are contact-header or via-header. Default would be default-ip
  - `connection-sip-get-response-destination-from` string — This will set the response desination. Values available will be contact-header or via-header. Default will be default-ip
  - `connection-require-encrypted-audio-enabled` string — This will set whether audio encryption is required. Options availabe are "optional" and "yes". Defaults to no
  - `connection-sip-transport-protocol` string — This will set the SIP transport protocol. Options are "TCP and "TLS". Default will be UDP
  - `connection-check-orig-matching-sip-header` string — This will set whether to check whether the origination matches the SIP header. Options are "to", "request", or "contact". Default will default to "from"
  - `connection-sip-session-timer-enabled` string — This will set the SIP session timer. Options are setting to "no" or not setting at all, which will default to the system-default
  - `connection-prevent-rtp-port-change-enabled` 'yes' | 'no'
  - `connection-hide-post-dial-delay-with-ringback-enabled` 'yes' | 'no'
  - `connection-remote-ringback-handling` string — This will set the remote ringback handling. Options are "no-ringback" and "local-only". Default will be set to "allowed".
  - `connection-block-media-in-sip-180-ringing` 'yes' | 'no'
  - `connection-allow-mid-call-uri-updates-enabled` 'yes' | 'no'
  - `connection-record-all-calls-enabled` 'yes' | 'no'
  - `connection-custom-p-asserted-id-format` string — This will set the PAId of the connection. Example input "sample" will translate to "PAId=sample" in call rules
  - `connection-require-sip-authentication-enabled` 'yes' | 'no'
  - `connection-translation-source-host` string
  - `utc-offset` string — This is the utc offset of the connection. Example "-7" for US/Pacific
  - `time-zone` string — This is the timezone of the connection
  - `minimum-call-duration-seconds` integer
  - `connection-sip-registration-expires-datetime` string
  - `connection-sip-authenticate-as-client-enabled` 'yes' | 'no'
  - `connection-is-carrier-trunk` 'yes' | 'no'
  - `active-calls-max-last-month` integer
  - `active-calls-max-this-month` integer
  - `active-calls-orig-current` integer
  - `active-calls-orig-since-startup` integer
  - `active-calls-term-current` integer
  - `active-calls-term-since-startup` integer
  - `connection-sip-registration-datetime` string
  - `last-modified-datetime` string

## Other responses

- `400`
- `401`
- `404`

---

[API](https://skmtc.net/ns-api/apis/netsapiens-api-v2.md) · [All operations](https://skmtc.net/ns-api/apis/netsapiens-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ns-api/netsapiens-api-v2/revisions/d37f65b5b886/schema)
