Stable Url

View as Markdown

A stable URL provides a failover-aware endpoint for accessing a workspace. Its lifecycle is independent of any failover group.

Get a Stable URLGET /api/disaster-recovery/v1/{name=accounts/*/stable-urls/*}List Stable URLsGET /api/disaster-recovery/v1/{parent=accounts/*}/stable-urlsCreate a Stable URLPOST /api/disaster-recovery/v1/{parent=accounts/*}/stable-urlsDelete a Stable URLDELETE /api/disaster-recovery/v1/{name=accounts/*/stable-urls/*}

StableUrl object

A stable URL provides a failover-aware endpoint for accessing a workspace. Its lifecycle is independent of any failover group.

namestringImmutable

Fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.

urlstringOutput onlyImmutable

The stable URL endpoint. Generated on creation and immutable thereafter. For non-Private-Link workspaces this is https://<spog_host>/?w=<connection_id>. For Private-Link workspaces this is the per-connection hostname.

initial_workspace_idstringInput onlyImmutable

The workspace this stable URL is initially bound to. Used only in Create requests to associate the stable URL with a workspace. Not returned in responses.

failover_group_namestringOutput only

Fully qualified resource name of the FailoverGroup this stable URL is currently linked to, in the format accounts/{account_id}/failover-groups/{failover_group_id}. Empty when the stable URL is not attached to any failover group.

effective_workspace_idstringOutput only

The workspace this stable URL currently routes to. Set to initial_workspace_id at creation, advanced to the failover group's primary while attached (including across a failover), and preserved when the stable URL is detached from its failover group. Read this to see where an unattached stable URL points: after a failover followed by a detach it reflects the post-failover primary, not initial_workspace_id.

stable_workspace_idstringOutput onlyImmutable

The stable workspace ID for this stable URL. Generated on creation and immutable thereafter; identifies the URL across failovers and is the same value embedded in the url (as the w= query parameter for SPOG URLs, or in the conn-<id> hostname for Private-Link URLs).

View as Markdown

The StableUrl object

{
  "name": "string",
  "url": "string",
  "initial_workspace_id": "string",
  "failover_group_name": "string",
  "effective_workspace_id": "string",
  "stable_workspace_id": "string"
}

Get a Stable URL GA

GET /api/disaster-recovery/v1/{name=accounts/*/stable-urls/*}

Get a stable URL.

API scopes: disaster-recovery

CloudsAWSAzure

Parameters

namestringRequiredpath

The fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.

Response

Returns the StableUrl object.

View as Markdown

Response

{
  "name": "string",
  "url": "string",
  "failover_group_name": "string",
  "effective_workspace_id": "string",
  "stable_workspace_id": "string"
}

List Stable URLs GA

GET /api/disaster-recovery/v1/{parent=accounts/*}/stable-urls

List stable URLs for an account.

API scopes: disaster-recovery

CloudsAWSAzure

Parameters

parentstringRequiredpath

The parent resource. Format: accounts/{account_id}.

page_sizeint32query

Maximum number of stable URLs to return per page:

• when set to a value greater than 0, the page length is the minimum of this value and a server configured value;
• when set to 0 or unset, the page length is set to a server configured value (recommended);
• when set to a value less than 0, an invalid parameter error is returned.

page_tokenstringquery

Page token received from a previous ListStableUrls call. Provide this to retrieve the subsequent page.

Response

Returns a list of StableUrl objects.

View as Markdown

Response

{
  "stable_urls": [
    {
      "name": "string",
      "url": "string",
      "failover_group_name": "string",
      "effective_workspace_id": "string",
      "stable_workspace_id": "string"
    }
  ],
  "next_page_token": "string"
}

Create a Stable URL GA

POST /api/disaster-recovery/v1/{parent=accounts/*}/stable-urls

Create a new stable URL.

API scopes: disaster-recovery

CloudsAWSAzure

Parameters

parentstringRequiredpath

The parent resource. Format: accounts/{account_id}.

validate_onlybooleanquery

When true, validates the request without creating the stable URL.

Default: false

stable_url_idstringRequiredquery

Client-provided identifier for the stable URL. Used to construct the resource name as {parent}/stable-urls/{stable_url_id}.

Request body

stable_urlobjectRequired

The stable URL to create.

Show child attributesHide child attributes

namestringImmutable

Fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.

initial_workspace_idstringRequiredInput onlyImmutable

The workspace this stable URL is initially bound to. Used only in Create requests to associate the stable URL with a workspace. Not returned in responses.

Response

Returns the StableUrl object.

View as Markdown

Request

{
  "stable_url": {
    "name": "string",
    "initial_workspace_id": "string"
  }
}

Response

{
  "name": "string",
  "url": "string",
  "failover_group_name": "string",
  "effective_workspace_id": "string",
  "stable_workspace_id": "string"
}

Delete a Stable URL GA

DELETE /api/disaster-recovery/v1/{name=accounts/*/stable-urls/*}

Delete a stable URL.

API scopes: disaster-recovery

CloudsAWSAzure

Parameters

namestringRequiredpath

The fully qualified resource name. Format: accounts/{account_id}/stable-urls/{stable_url_id}.

View as Markdown

Response

{}