Sign in

v4

latestOpenAPI 3.0.1Apache 2.02026-07-312457525.9 MB
Domains API

Create or update record

patch/workspaces/{workspace_domain}/domains/{domain_id}/records/{record_name}/{type}

Path parameters

workspace_domainstring required
Example:my-company

The human-readable ID of the workspace

domain_idstring required
Example:4krmDRPw

The ID of the domain

record_namestring required
Example:api.example.com

The full record name with domain

type'SOA' | 'NS' | 'A' | 'AAAA' | 'CNAME' | 'ALIAS' | 'CAA' | 'SPF' | 'MX' | 'TXT' | 'SRV' | 'NAPTR' | 'PTR' required
Example:A

The record type

Request body

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

valuesstring[] required

New values to set for the DNS record

ttlinteger required

New TTL value for the DNS record in seconds

routing'simple' | 'geolocation'

Routing strategy: 'simple' (uses only values field) or 'geolocation' (uses country/continent fields, values field is used as default/fallback)

countryobject nullable

Country-specific routing values (only used when routing is 'geolocation'). Keys are ISO 3166-1 alpha-2 country codes

continentobject nullable

Continent-specific routing values (only used when routing is 'geolocation'). Available values: Africa, Antarctica, Asia, Europe, NorthAmerica, Oceania, SouthAmerica

Response

Record updated successfully

urlstring

API endpoint to GET this object

html_urlstring

Web URL to view this object in Buddy.works

namestring

The record name (subdomain or @ for root)

type'SOA' | 'NS' | 'A' | 'AAAA' | 'CNAME' | 'ALIAS' | 'CAA' | 'SPF' | 'MX' | 'TXT' | 'SRV' | 'NAPTR' | 'PTR'

The record type

valuesstring[]
ttlinteger

Time To Live in seconds for the DNS record

routingstring

Routing strategy for the record (simple or geolocation)

Example response

{
  "name": "api",
  "type": "A",
  "ttl": 300
}