Get connection VPN status

get/v1/environments/{environmentId}/connections/statuses

MCP ToolRead

Page View

Coming soon

This feature is coming soon, so you won’t see it live in a production environment just yet. Stay tuned for the release!

Connection endpoints allow you to manage connection details in your Redox organization.

Currently, you can retrieve the health status of your connections.

Get connection VPN status

Retrieves the health status of all connections, including VPN test results. Learn more about VPN test types.

Request parameters

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/environments/{environmentId}/connections/statuses' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

environmentId
required, string
Identifies the specific environment that you're operating in or on behalf of.

Query Parameters

_page
number
Indicates a specific page of results to return. This value typically comes from a previous response's page object.
_count
number
Defines the number of results to return per page. The maximum value per page is 50.

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0",
4
    "page": {
5
      "totalRecords": 0,
6
      "links": {
7
        "self": "string",
8
        "next": "string",
9
        "prev": "string",
10
        "first": "string",
11
        "last": "string"
12
      },
13
      "currentPage": 1,
14
      "pageType": "offest",
15
      "pageSize": 0,
16
      "totalPages": 0
17
    }
18
  },
19
  "payload": {
20
    "statusCounts": {
21
      "success": 6,
22
      "warning": 0,
23
      "failure": 2,
24
      "unknown": 0
25
    },
26
    "checks": [
27
      {
28
        "connectedOrgId": 12345,
29
        "connectedOrgName": "Acme Health System",
30
        "checkType": "security-association",
31
        "status": "success",
32
        "resourceType": "vpn",
33
        "resourceId": "d63b9307-a759-4e08-9b2a-d172f3ddd479",
34
        "detail": "Tunnel is established",
35
        "diagnostics": "IKEv2 SA active, last rekey 2h ago",
36
        "checkedAt": "2026-07-01T12:00:00.000Z"
37
      }
38
    ]
39
  }
40
}

meta
object
- version
  string
  Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
- page
  object
  Contains metadata about paginated results of returned data.
  totalRecords
  number
  Specifies the total number of records across all pages for the result set.
  links
  object
  self
  string
  Links to the current page of results.
  next
  string
  Links to the next page of results.
  prev
  string
  Links to the previous page of results, which returns the page based on the current page you're on.
  first
  string
  Links to the first page of results.
  last
  string
  Links to the last page of results.
  currentPage
  number
  Specifies the current page number.
  pageType
  string
  Describes the pagination algorithm.
  Value: offest
  pageSize
  number
  Describes the number of records included in each page of the current result set.
  totalPages
  number
  Specifies the total number of pages in the result set.
payload
object
Contains the VPN health status for connections in the environment.
- statusCounts
  object
  Contains the number of VPN tests on the current page grouped by status.
  success
  integer
  Indicates how many VPN tests on this page resulted in a success status.
  warning
  integer
  Indicates how many VPN tests on this page resulted in a warning status.
  failure
  integer
  Indicates how many VPN tests on this page resulted in a failed status.
  unknown
  integer
  Indicates how many VPN tests on this page resulted in an unknown status, meaning the status couldn't be determined.
- checks
  Array of object
  Contains a list of VPN test results for the current page. Each test corresponds to a single VPN tunnel or destination.
  connectedOrgId
  number
  Displays the unique identifier of the connected organization.
  connectedOrgName
  string
  Displays the name of the connected organization.
  checkType
  string
  Describes the type of VPN test performed. A security association (SA) tests whether the VPN tunnel is active. A TCP heartbeat or ping tests whether the VPN destination is receiving data.
  Possible Values: security-association, tcp-heartbeat, icmp-ping
  status
  string
  Displays the VPN status after the test.
  Possible Values: success, warning, failure, unknown
  resourceType
  string
  Indicates whether this tests the VPN tunnel or destination.
  Possible Values: vpn, destination
  resourceId
  string
  Displays the unique identifier of the VPN configuration or destination being tested.
  detail
  string
  Describes the test result.
  diagnostics
  string
  Contains detailed diagnostic information (e.g., IKE phase status, connection error) from the test.
  checkedAt
  string
  Indicates when the last VPN test was performed.
  Format: date-time

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.