Create/edit record

PATCH
/workspaces
/:workspace
/domains
/:domain
/records
/:type

Create or edit a record.

Request

REQUIRED SCOPES

WORKSPACE, ZONE_WRITE

URL PARAMETERS

workspacerequired string

The workspace name.

domainrequired string

The domain or subdomain name.

typerequired string

The domain record type. Can be one of: A, AAAA, CNAME, TXT, NS, SOA, CAA, MX, SPF, SRV, NAPTR.

POST PARAMETERS

valuesrequired string[]

Data contaned in the DNS record.

ttlrequired integer

Time to Live set for the DNS record

Last modified on Apr 8, 2025

List your workspaces Delete record

Example:

curl -X PATCH "https://api.buddy.works/workspaces/:workspace/domains/:domain/records/:type" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json" \
-d '{
  "values": [
    "0 iodef \"iodef.my-domain.com\""
  ],
  "ttl": 3600
}'

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999

Example:

CURL
curl -X PATCH "https://api.buddy.works/workspaces/:workspace/domains/:domain/records/:type" \
-H "Authorization: Bearer <YOUR-TOKEN>" \
-H "Content-Type: application/json"

EXAMPLE RESPONSE
{
  "name": "@",
  "type": "CAA",
  "values": [
    "0 idoef "iodef.my-domain.com""
  ],
  "ttl": 3600
}

STATUS
200 OK

LIMITS
X-Rate-Limit-Limit: 1
X-Rate-Limit-Remaining: 999