Sign in
security

Modify a VPC Private Endpoint

Update the configuration of a private endpoint.

put/groups/{groupId}/apps/{appId}/security/private_endpoints/{privateEndpointId}

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

Updated

_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 3 of the 50 revisions of this API.314

  • v3aec31f78ae64312See the full diff
    • ▲

      added the new required request property

      new-required-request-property

    • ▲

      the request property became required

      request-property-became-required

    • ▲

      the request property became required

      request-property-became-required

    • ●

      removed the request property

      request-property-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

  • v3e2240dd053bd1See the full diff
    • ○

      added the media type application/json for the response with the status

      response-media-type-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v3ab15c3dfb59e1See the full diff
    • ○

      endpoint added

      endpoint-added