Sign in
Private Endpoints

Validate a draft private endpoint

Send a live test request to the draft endpoint using the given workspace's BYOK credential for its provider. A passing validation is required before activation. Failed checks return 200 with passed: false. Management key required.

post/private-endpoints/{id}/validate

Path parameters

idstring uuid required

Stable identifier of the private endpoint.

Example:5b1c4c4e-7d0a-4a8e-9f3a-2d6c1b0e8a11

Stable identifier of the private endpoint.

Request body

workspace_idstring uuid required

Workspace whose BYOK credential is used for the live validation call. The workspace must belong to your account.

Example request

{
  "workspace_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response

Validation checks

Example response

{
  "data": {
    "checks": [
      {
        "name": "auth_ok",
        "passed": true
      }
    ],
    "passed": true
  }
}

Changes

Changed in 1 of the 339 revisions of this API.1