Set DNS record — Brigg developers

Access & visibility

Allow domains.SetDnsRecord on your API key.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

idstringRequired

Use the hosted domain's id; record_types and ttl_options in that listing provide supported DNS settings. domains.ListHostedDomains.

At least 1 character. At most 80 characters.

namestringRequired

Record name relative to the domain: '@' for the domain itself, 'www', 'mail', '_dmarc', 'selector._domainkey'.

At most 253 characters.

typestringRequired

One of A, AAAA, CNAME, MX, TXT. The apex NS/SOA are Brigg's own and refused reserved.

At most 8 characters.

ttlintegerOptional

Seconds, 60–604800. Default 3600.

Default: 3600.

valuesarray of stringRequired

ALL values for this name+type — a set is replaced whole. MX values are '<priority> <host>' ('10 mail.example.com'); TXT values are the bare text (no quotes).

At least 1 item. At most 50 items.

Change a hosted DNS record set

Select the domain's id from List hosted domains. The domain must be active and DNS-hosted by Brigg. A website hostname or app ID is not a hosted-domain ID.

Set replaces every value for one name/type pair. Read the current set first and include values you want to retain. Delete removes that whole set. Use @ for the apex, www for a subdomain, and bare TXT text without surrounding quotes. MX values contain a numeric priority followed by the mail hostname. TTL is in seconds.

A successful response confirms the stored change, not global DNS propagation; caches can retain the old value until its TTL expires. Brigg-managed website aliases, certificate records and zone records are protected. A CNAME cannot coexist with another record type at the same name. Use the website connection operations to manage Brigg-hosted sites.

Response

Returns 200 OK with a JSON body.

recordDnsRecordRequired

DNS record set after the requested change.

DnsRecord

namestringRequired

Record name relative to the hosted zone; @ names the zone apex. This is the normalized name saved by the service.

typestringRequired

DNS record type: A, AAAA, CNAME, MX or TXT.

Allowed: "A", "AAAA", "CNAME", "MX", "TXT".

ttlnumberRequired

DNS time to live in seconds.

valuesarray of stringRequired

Values published in this DNS record set; syntax depends on its record type.

aliasobjectOptional

Alias target used instead of ordinary DNS values, when present.

Nested fields

targetstringRequired

DNS target hostname for this alias.

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status	Code	What to do
400	`invalid_json`	Send a JSON object with Content-Type: application/json.
400	`invalid_input`	Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401	`invalid_key`	The workspace API key is missing, invalid or revoked.
403	`forbidden`	Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404	`not_found`	The requested operation or resource is not available to this credential.
429	`rate_limited`	Wait for Retry-After before retrying. Reuse the original Idempotency-Key.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80,
      "description": "Use the hosted domain's id; record_types and ttl_options in that listing provide supported DNS settings. [domains.ListHostedDomains](/reference/domains/ListHostedDomains)."
    },
    "name": {
      "type": "string",
      "maxLength": 253,
      "description": "Record name relative to the domain: '@' for the domain itself, 'www', 'mail', '_dmarc', 'selector._domainkey'."
    },
    "type": {
      "type": "string",
      "maxLength": 8,
      "description": "One of A, AAAA, CNAME, MX, TXT. The apex NS/SOA are Brigg's own and refused `reserved`."
    },
    "ttl": {
      "type": "integer",
      "default": 3600,
      "description": "Seconds, 60–604800. Default 3600."
    },
    "values": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 4096
      },
      "minItems": 1,
      "maxItems": 50,
      "description": "ALL values for this name+type — a set is replaced whole. MX values are '<priority> <host>' ('10 mail.example.com'); TXT values are the bare text (no quotes)."
    }
  },
  "required": [
    "id",
    "name",
    "type",
    "values"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "domain_example",
      "name": "www",
      "type": "CNAME",
      "ttl": 3600,
      "values": [
        "sites.example.net"
      ]
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "record": {
      "description": "DNS record set after the requested change.",
      "title": "DnsRecord",
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Record name relative to the hosted zone; @ names the zone apex. This is the normalized name saved by the service."
        },
        "type": {
          "type": "string",
          "enum": [
            "A",
            "AAAA",
            "CNAME",
            "MX",
            "TXT"
          ],
          "description": "DNS record type: A, AAAA, CNAME, MX or TXT."
        },
        "ttl": {
          "type": "number",
          "description": "DNS time to live in seconds."
        },
        "values": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Values published in this DNS record set; syntax depends on its record type."
        },
        "alias": {
          "type": "object",
          "properties": {
            "target": {
              "type": "string",
              "description": "DNS target hostname for this alias."
            }
          },
          "required": [
            "target"
          ],
          "additionalProperties": false,
          "description": "Alias target used instead of ordinary DNS values, when present."
        }
      },
      "required": [
        "name",
        "type",
        "ttl",
        "values"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "record"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "record": {
        "name": "www",
        "type": "CNAME",
        "ttl": 3600,
        "values": [
          "sites.example.net"
        ]
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct as a memberRequires administrator-approved delegation.

This replaces the complete www CNAME record set; it is not an append.

Request

cURL

curl 'https://api.brigg.app/v1/operations/domains.SetDnsRecord' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "domain_example",
  "name": "www",
  "type": "CNAME",
  "ttl": 3600,
  "values": [
    "sites.example.net"
  ]
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/domains.SetDnsRecord", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "domain_example",
    "name": "www",
    "type": "CNAME",
    "ttl": 3600,
    "values": [
      "sites.example.net"
    ]
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "domain_example",
  "name": "www",
  "type": "CNAME",
  "ttl": 3600,
  "values": [
    "sites.example.net"
  ]
}
request = Request(
    "https://api.brigg.app/v1/operations/domains.SetDnsRecord",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/domains.SetDnsRecord' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "domain_example",
  "name": "www",
  "type": "CNAME",
  "ttl": 3600,
  "values": [
    "sites.example.net"
  ]
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/domains.SetDnsRecord", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "domain_example",
    "name": "www",
    "type": "CNAME",
    "ttl": 3600,
    "values": [
      "sites.example.net"
    ]
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "domain_example",
  "name": "www",
  "type": "CNAME",
  "ttl": 3600,
  "values": [
    "sites.example.net"
  ]
}
request = Request(
    "https://api.brigg.app/v1/operations/domains.SetDnsRecord",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "record": {
    "name": "www",
    "type": "CNAME",
    "ttl": 3600,
    "values": [
      "sites.example.net"
    ]
  }
}

Illustrative values, not a live response.

MX values include priority and hostname. Preserve all destinations you want to keep.

Request

cURL

curl 'https://api.brigg.app/v1/operations/domains.SetDnsRecord' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "domain_example",
  "name": "@",
  "type": "MX",
  "ttl": 3600,
  "values": [
    "10 mail.example.net",
    "20 backup.example.net"
  ]
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/domains.SetDnsRecord", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "domain_example",
    "name": "@",
    "type": "MX",
    "ttl": 3600,
    "values": [
      "10 mail.example.net",
      "20 backup.example.net"
    ]
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "domain_example",
  "name": "@",
  "type": "MX",
  "ttl": 3600,
  "values": [
    "10 mail.example.net",
    "20 backup.example.net"
  ]
}
request = Request(
    "https://api.brigg.app/v1/operations/domains.SetDnsRecord",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/domains.SetDnsRecord' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "domain_example",
  "name": "@",
  "type": "MX",
  "ttl": 3600,
  "values": [
    "10 mail.example.net",
    "20 backup.example.net"
  ]
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/domains.SetDnsRecord", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "id": "domain_example",
    "name": "@",
    "type": "MX",
    "ttl": 3600,
    "values": [
      "10 mail.example.net",
      "20 backup.example.net"
    ]
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "id": "domain_example",
  "name": "@",
  "type": "MX",
  "ttl": 3600,
  "values": [
    "10 mail.example.net",
    "20 backup.example.net"
  ]
}
request = Request(
    "https://api.brigg.app/v1/operations/domains.SetDnsRecord",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "record": {
    "name": "@",
    "type": "MX",
    "ttl": 3600,
    "values": [
      "10 mail.example.net",
      "20 backup.example.net"
    ]
  }
}

Illustrative values, not a live response.