Update a PrivateLink endpoint

APIs & SDKs

PATCH/__remote/api.vercel.com/v1/networking/privatelink/endpoints/{endpointId}

Updates a PrivateLink endpoint (name, privateDns). Changes to endpoints of the same project are serialized. If another change holds them for too long, the request fails with 503 service_unavailable and can be retried. If the change may have completed but the outcome is unknown, it fails with 409 uncertain_outcome; read the endpoint before retrying.

Request

import { Edgenivo } from "@vercel/sdk";

const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.networking.updatePrivateLinkEndpoint({
    projectId: "prj_a1b2c3d4e5f6g7h8",
    endpointId: "ple_a1b2c3d4e5f6g7h8",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "payments-db",
      enablePrivateDns: false,
    },
  });

  console.log(result);
}

run();

Response

{
  "awsDnsEntries": [],
  "awsServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0123456789abcdef0",
  "createdAt": "1610963878358",
  "endpointId": "ple_a1b2c3d4e5f6g7h8",
  "name": "payments-db",
  "privateDnsNames": [],
  "projectId": "prj_a1b2c3d4e5f6g7h8",
  "status": "available",
  "statusMessage": "Endpoint did not become available in time. Try deleting and recreating, or visit /help if the issue persists.",
  "teamId": "team_a1b2c3d4e5f6g7h8",
  "updatedAt": "1610963878358",
  "vercelRegion": "iad1",
  "vpcEndpointId": "vpce-0123456789abcdef0"
}

Authentication

AuthorizationbearerToken

Default authentication mechanism

Path parameters

endpointIdstringRequired

The unique identifier of the PrivateLink endpoint.

Query parameters

projectIdstringRequired

The project ID the PrivateLink endpoint belongs to.

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Body

application/json

namestringOptional

A new name for the PrivateLink endpoint. When omitted, the current name is kept.

enablePrivateDnsbooleanOptional

When true, resolves the endpoint service through its private DNS names, which are then returned in privateDnsNames. When false, clears them. When omitted, the current setting is kept. At least one of name or enablePrivateDns must be provided.

Response

200The updated PrivateLink endpoint.

awsDnsEntriesarrayOptional

The regional DNS names assigned to the endpoint by AWS. Use these to reach the service when private DNS is not enabled.

awsServiceNamestringRequired

The AWS VPC endpoint service the endpoint connects to.

createdAtnumberRequired

Timestamp in milliseconds since the UNIX epoch for when the endpoint was created.

endpointIdstringRequired

The unique identifier of the PrivateLink endpoint.

namestringRequired

The name of the PrivateLink endpoint, shown in the Edgenivo dashboard.

privateDnsNamesarrayOptional

The private DNS names of the endpoint service, populated when private DNS is enabled for the endpoint.

projectIdstringRequired

The identifier of the project the PrivateLink endpoint belongs to.

statusstringRequired

The current state of the endpoint. - creating: the endpoint is being created. - pending-acceptance: waiting for the endpoint service owner to accept the connection. Only occurs for services that require manual acceptance. - provisioning: the connection was accepted and AWS is finishing setup. - available: the endpoint is fully provisioned and ready to use. - rejected: the endpoint service owner rejected the connection. - failed: the endpoint could not be provisioned. - deleting: the endpoint is being deleted.

statusMessagestringOptional

A human-readable explanation of why the endpoint could not be provisioned. Only set when status is failed, and absent for every other status including rejected, since AWS does not report a rejection reason.

teamIdstringRequired

The identifier of the team that owns the PrivateLink endpoint.

updatedAtnumberRequired

Timestamp in milliseconds since the UNIX epoch for when the endpoint was last updated.

vercelRegionstringRequired

The Edgenivo region the endpoint is provisioned in.

vpcEndpointIdstringOptional

The identifier of the underlying AWS VPC endpoint. Absent until AWS has created the endpoint.

Errors

400One of the provided values in the request body is invalid. One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

409Error

410Error

500Error

503Error

Request

import { Edgenivo } from "@vercel/sdk";

const vercel = new Edgenivo({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.networking.updatePrivateLinkEndpoint({
    projectId: "prj_a1b2c3d4e5f6g7h8",
    endpointId: "ple_a1b2c3d4e5f6g7h8",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
    requestBody: {
      name: "payments-db",
      enablePrivateDns: false,
    },
  });

  console.log(result);
}

run();

Response

{
  "awsDnsEntries": [],
  "awsServiceName": "com.amazonaws.vpce.us-east-1.vpce-svc-0123456789abcdef0",
  "createdAt": "1610963878358",
  "endpointId": "ple_a1b2c3d4e5f6g7h8",
  "name": "payments-db",
  "privateDnsNames": [],
  "projectId": "prj_a1b2c3d4e5f6g7h8",
  "status": "available",
  "statusMessage": "Endpoint did not become available in time. Try deleting and recreating, or visit /help if the issue persists.",
  "teamId": "team_a1b2c3d4e5f6g7h8",
  "updatedAt": "1610963878358",
  "vercelRegion": "iad1",
  "vpcEndpointId": "vpce-0123456789abcdef0"
}

OpenAPI Specification