PATCH /v1/networking/privatelink/endpoints/{endpointId}

Updates a PrivateLink endpoint (name, privateDns).

Servers

Path parameters

Name Type Required Description
endpointId String Yes

The unique identifier of the PrivateLink endpoint.

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
projectId String Yes

The project ID the PrivateLink endpoint belongs to.

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
name String No

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

enablePrivateDns Boolean No

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.

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.