Update the cluster's private link
const url = 'http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/private-link';
const options = {
method: 'PUT',
headers: {
'API-Version': '2026-06-01.beta',
'API-Key': '<API-Key>',
'Content-Type': 'application/json'
},
body: '{"enabled":true,"azure_subscription_ids":["example"]}'
};
try {
const response = await fetch(url, options);
const data = await response.json();
console.log(data);
} catch (error) {
console.error(error);
}curl --request PUT \
--url http://localhost:8000/clusters/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/private-link \
--header 'API-Key: <API-Key>' \
--header 'API-Version: 2026-06-01.beta' \
--header 'Content-Type: application/json' \
--data '{ "enabled": true, "azure_subscription_ids": [ "example" ] }'Turns Azure private link on or off and sets the Azure subscription IDs. The alias is returned once private link
is enabled. Connections are approved afterwards, per listed subscription, so status moves from waiting to
connected once a private endpoint from a listed subscription connects.
Returns 403 when the workspace’s plan lacks the private_network feature, and 422 when the cluster’s site
has no Azure private link or the subscription IDs are not valid.
Required scope: clusters:private-link:write
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Turns a cluster’s Azure private link on or off and sets its subscription IDs.
object
Turn private link on or off.
Azure subscription IDs (GUIDs, at most 20) allowed to connect. Replaces the stored list; an empty list clears it. When omitted the stored list is kept. At least one is required to enable.
Example generated
{
"enabled": true,
"azure_subscription_ids": [
"example"
]
}Responses
Section titled “Responses”The request has succeeded.
A cluster’s Azure private link.
object
Whether private link is on.
Azure subscription IDs allowed to connect a private endpoint, lowercase GUIDs.
Private Link Service alias to paste when creating the private endpoint in Azure. Only present while private link is enabled.
Private hostname to create in your private DNS zone. Only present while private link is enabled.
Status of a cluster’s private link.
Connection state of each subscription seen so far. A subscription with no private endpoint yet is absent.
The private endpoint connection of one Azure subscription.
object
Azure subscription ID, a GUID.
Connection state of one subscription’s private endpoint.
Example
{
"status": "disabled",
"connections": [
{
"status": "waiting"
}
]
}Access is unauthorized.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Access is forbidden.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}The server cannot find the requested resource.
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Client error
object
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com",
"errors": [
{
"field": "example",
"detail": "example",
"code": "example",
"value": "example"
}
]
}Client error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Headers
Section titled “Headers”Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}Server error
RFC 9457 Problem Details object.
object
Example generated
{
"type": "https://example.com",
"title": "example",
"status": 1,
"detail": "example",
"instance": "https://example.com"
}