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"
}

Changes

Changed in 2 of the 50 revisions of this API.312

Apr 18, 2024v3aec31f78ae64311See the full diff
- ▲
  added the new required request property endpoint_type
  new-required-request-property
- ▲
  the request property cloud_provider_endpoint_id became required
  request-property-became-required
- ▲
  the request property cloud_provider_region became required
  request-property-became-required
- ●
  removed the request property _id
  request-property-removed
- ○
  added the media type application/json for the response with the status 201
  response-media-type-added
May 11, 2023v3ab15c3dfb59e1See the full diff
- ○
  endpoint added
  endpoint-added

Full history