POST /v1/networking/privatelink/endpoints

Creates a PrivateLink endpoint for a project.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Query parameters

Name Type Required Description
teamId String No

The Team identifier to perform the request on behalf of.

slug String No

The Team slug to perform the request on behalf of.

Request body fields

Name Type Required Description
projectId String Yes

The project ID to create the PrivateLink endpoint for.

name String Yes

The name of the PrivateLink endpoint, used as its label in the Vercel dashboard.

vercelRegion String Yes

The Vercel region to provision the endpoint in. Advanced Networking must be enabled for the project in that region. The endpoint service itself may live in another AWS region.

awsServiceName String Yes

The name of the AWS VPC endpoint service to connect to. Its AWS region is read from the name; when that region differs from the one behind vercelRegion, the service must allow cross-region access.

enablePrivateDns Boolean No

Whether to resolve the endpoint service through its private DNS names, which are then returned in privateDnsNames. Defaults to false, in which case the endpoint is reachable through the DNS names in awsDnsEntries.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.