Sign in

v50

latestOpenAPI 3.1.0raw.githubusercontent.com2025-06-09181183330.0 KB
security

Create a VPC Private Endpoint

Configure a new private endpoint for the App.

post/groups/{groupId}/apps/{appId}/security/private_endpoints

Request body

cloud_provider_regionstring required

The cloud provider region that hosts the private endpoint.

cloud_provider_endpoint_idstring required

The private endpoint ID from the cloud provider.

commentstring

An optional comment that describes the endpoint.

endpoint_type'sync' | 'general' required

The type of endpoint. For more information on endpoint types and migrating deprecated endpoints to "general" or "sync", see Use a VPC Private Endpoint.

Example request

{
  "cloud_provider_region": "aws-us-east-1",
  "cloud_provider_endpoint_id": "vpce-12345678",
  "endpoint_type": "sync"
}

Response

Created

_idstring
cloud_provider_regionstring

The cloud provider region that hosts the private endpoint.

cloud_provider_endpoint_idstring

The private endpoint ID from the cloud provider.

commentstring

An optional comment that describes the endpoint.

endpoint_type'sync' | 'general' | 'legacy'

The type of endpoint. For more information on migrating deprecated "legacy" endpoints, see Migrate Legacy Endpoints.

Example response

{
  "cloud_provider_region": "aws-us-east-1",
  "cloud_provider_endpoint_id": "vpce-12345678",
  "endpoint_type": "sync"
}