# Get statuses

`GET /v1/environments/{environmentId}/connections/statuses`

Available as MCP tool `get-statuses` (Read).

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

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

### Get statuses

Retrieves the health status of all connections, including VPN test results. [Learn more about VPN test types](https://docs.redoxengine.com/permalink/4vBFw9TgLrlKJceh46xIwU/#vpn-test-types). 

## Request parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `environmentId` | path | string | Yes | Identifies the specific environment that you're operating in or on behalf of. |
| `_page` | query | number | No | Indicates a specific page of results to return. This value typically comes from a previous response's `page` object. |
| `_count` | query | number | No | Defines the number of results to return per page. The maximum value per page is 50. |

## Request example

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

## Responses

### 200

Contains a paginated payload with the VPN health status for connections in the specified environment.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `meta` | object | No |  |
| `meta.version` | string | No | 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. |
| `meta.page` | object | No | Contains metadata about paginated results of returned data. |
| `meta.page.totalRecords` | number | No | Specifies the total number of records across all pages for the result set. |
| `meta.page.links` | object | No |  |
| `meta.page.links.self` | string | No | Links to the current page of results. |
| `meta.page.links.next` | string | No | Links to the next page of results. |
| `meta.page.links.prev` | string | No | Links to the previous page of results, which returns the page based on the current page you're on. |
| `meta.page.links.first` | string | No | Links to the first page of results. |
| `meta.page.links.last` | string | No | Links to the last page of results. |
| `meta.page.currentPage` | number | No | Specifies the current page number. |
| `meta.page.pageType` | string | No | Describes the pagination algorithm. Value: offest |
| `meta.page.pageSize` | number | No | Describes the number of records included in each page of the current result set. |
| `meta.page.totalPages` | number | No | Specifies the total number of pages in the result set. |
| `payload` | object | No | Contains the VPN health status for connections in the environment. |
| `payload.statusCounts` | object | No | Contains the number of VPN tests on the current page grouped by status. |
| `payload.statusCounts.success` | integer | No | Indicates how many VPN tests on this page resulted in a success status. |
| `payload.statusCounts.warning` | integer | No | Indicates how many VPN tests on this page resulted in a warning status. |
| `payload.statusCounts.failure` | integer | No | Indicates how many VPN tests on this page resulted in a failed status. |
| `payload.statusCounts.unknown` | integer | No | Indicates how many VPN tests on this page resulted in an unknown status, meaning the status couldn't be determined. |
| `payload.checks` | Array of object | No | Contains a list of VPN test results for the current page. Each test corresponds to a single VPN tunnel or destination. |
| `payload.checks[].connectedOrgId` | number | No | Displays the unique identifier of the connected organization. |
| `payload.checks[].connectedOrgName` | string | No | Displays the name of the connected organization. |
| `payload.checks[].checkType` | string | No | 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 |
| `payload.checks[].status` | string | No | Displays the VPN status after the test. Possible values: success, warning, failure, unknown |
| `payload.checks[].resourceType` | string | No | Indicates whether this tests the VPN tunnel or destination. Possible values: vpn, destination |
| `payload.checks[].resourceId` | string | No | Displays the unique identifier of the VPN configuration or destination being tested. |
| `payload.checks[].detail` | string | No | Describes the test result. |
| `payload.checks[].diagnostics` | string | No | Contains detailed diagnostic information (e.g., IKE phase status, connection error) from the test. |
| `payload.checks[].checkedAt` | string (date-time) | No | Indicates when the last VPN test was performed. |

_Generated from the schema: the values are placeholders, not a real payload._

```json
{
  "meta": {
    "version": "1.0.0",
    "page": {
      "totalRecords": 0,
      "links": {
        "self": "string",
        "next": "string",
        "prev": "string",
        "first": "string",
        "last": "string"
      },
      "currentPage": 1,
      "pageType": "offest",
      "pageSize": 0,
      "totalPages": 0
    }
  },
  "payload": {
    "statusCounts": {
      "success": 6,
      "warning": 0,
      "failure": 2,
      "unknown": 0
    },
    "checks": [
      {
        "connectedOrgId": 12345,
        "connectedOrgName": "Acme Health System",
        "checkType": "security-association",
        "status": "success",
        "resourceType": "vpn",
        "resourceId": "d63b9307-a759-4e08-9b2a-d172f3ddd479",
        "detail": "Tunnel is established",
        "diagnostics": "IKEv2 SA active, last rekey 2h ago",
        "checkedAt": "2026-07-01T12:00:00.000Z"
      }
    ]
  }
}
```

### 400

Bad Request

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `payload` | object | No | Contains the error message. |
| `payload.error` | object | No | Contains the error message details. |
| `payload.error.id` | string | No | Contains a unique identifier for the given error instance. |
| `payload.error.title` | string | No | Displays the high-level error message, typically something succinct like `Bad Request`. |
| `payload.error.code` | string | No | Contains an alternative ID for the error type, which can be used to find relevant troubleshooting information. |
| `payload.error.detail` | string | No | Contains the specific error details for this message. |
| `payload.error.status` | number | No | Displays the corresponding HTTP status code for the error. |
| `payload.error.transient` | boolean | No | Describes whether the error will resolve itself. If `true`, no further action needs to be taken. If `false`, you may need to troubleshoot on your end to resolve the issue before the error can be processed. |

```json
{
  "payload": {
    "error": {
      "title": "Bad Request",
      "code": "validation.error.bad.request",
      "detail": "Error details",
      "status": 400,
      "transient": false
    }
  }
}
```

### 403

Forbidden

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `payload` | object | No | Contains the error message. |
| `payload.errors` | Array of object | No |  |
| `payload.errors[].title` | string | No | Displays the high-level error message, typically something succinct like `Forbidden`. |
| `payload.errors[].code` | string | No | Contains an alternative ID for the error type, which can be used to find relevant troubleshooting information. |

```json
{
  "payload": {
    "errors": [
      {
        "title": "Forbidden",
        "code": "authorization.forbidden"
      }
    ]
  }
}
```

### 500

Internal Server Error

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `payload` | object | No | Contains the error message. |
| `payload.error` | object | No | Contains the error message details. |
| `payload.error.title` | string | No | Displays the high-level error message, typically something succinct like `Failed in step X`. |
| `payload.error.code` | string | No | Contains an alternative ID for the error type, which can be used to find relevant troubleshooting information. |
| `payload.error.detail` | string | No | Contains the specific error details for this message. |
| `payload.error.status` | number | No | Displays the corresponding HTTP status code for the error. |
| `payload.error.transient` | boolean | No | Describes whether the error will resolve itself. If `true`, no further action needs to be taken. If `false`, you may need to troubleshoot on your end to resolve the issue before the error can be processed. |

```json
{
  "payload": {
    "error": {
      "title": "Internal Server Error",
      "code": "failed.db.lookup",
      "detail": "Error details",
      "status": 500,
      "transient": true
    }
  }
}
```
