Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Domains API

Claim an existing domain

post/workspaces/{workspace_domain}/domains/claim

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

Request body

namestring

The subdomain to claim under a claimable domain

on_owner_behalfboolean

Whether to claim the domain on the workspace owner's behalf

Example request

{
  "name": "food.claim.net"
}

Response

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

namestring

The name of the domain

idstring

The ID of the domain

type'REGISTERED' | 'POINTED' | 'PRIVATE' | 'CLAIMED'

The type of the domain

pointed_viastring[]
auto_renewboolean

Whether the domain is set to auto-renew

transfer_lockboolean

Whether the domain has transfer lock enabled

dnssecboolean

Whether DNSSEC is enabled for the domain

expiry_datestring date-time

The expiration date of the domain registration

Example response

{
  "name": "example.com",
  "id": "4krmDRPw"
}