customdomains

Share a custom domain

Shares a verified custom domain with another workspace of the same account by copying the domain record; the ACM certificate and CloudFront tenant stay with the owner and are reused (not re-provisioned). Use targetWorkspace "account" to make the domain usable by every workspace of the account. Cross-account sharing is not supported.

post/customdomains/{domainName}/share

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/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

domainNamestring required

Name of the custom domain

Request body

targetWorkspacestring required

Name of the workspace to share the domain with, or "account" to share with every workspace of the account.

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.