customdomains

Unshare a custom domain

Revokes sharing of a custom domain with a target workspace (or the account when targetWorkspace is "account"). Removes the shared copy / clears the account-global marker; the owner's domain is not affected.

delete/customdomains/{domainName}/share/{targetWorkspace}

Request

Base URL
https://api.blaxel.ai/v0
Auth
- OAuth 2
  Authorization code/oauth/authorize
  Client credentials
  Token URL/oauth/token
  Scopescustomdomains:update
- or HTTP bearer
TypeScript
https://skmtc.dev/blaxel/apis/blaxel-control-plane/docs/customdomains/:domainName/share/:targetWorkspace/delete.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

domainNamestring required

Name of the custom domain

targetWorkspacestring required

Name of the target workspace, or "account" for an account-wide share.

Response

successful operation

Example response

{
  "metadata": {
    "displayName": "Preview Domain",
    "name": "preview.example.com"
  },
  "spec": {
    "domainType": "applications",
    "fallbackPreviewId": "my-fallback-preview",
    "region": "us-pdx-1",
    "status": "verified"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.