Skip to content
enum

Add a value to a DNS Record Set

POST
/enum.api.v1.DnsService/AddRecordSetValue

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

AddRecordSetValue adds one value to the (name, type) rrset, creating the set if it does not exist.

object
projectId
string
zoneId
string
name
string
type
string
ttl

Ttl is applied only when the rrset is created; 0 means “use the per-type default”.

integer format: int32
value
object
content

Rdata in presentation format (e.g. “192.0.2.1”, “10 mail.example.com.”).

string
disabled
boolean

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

object
recordSet

DnsRecordSet is a resource record set: all values sharing (name, type) with one shared TTL. It is addressed by (zone_id, name, type).

object
id
string
zoneId
string
name

Owner name (FQDN, e.g. www.example.com or example.com for apex).

string
type

Record type: A, AAAA, CNAME, MX, TXT, NS, SRV, or CAA. A CNAME at the zone apex flattens to the target’s A/AAAA addresses when served; unlike CNAME elsewhere, it may coexist with MX, TXT, and CAA at the apex (not with A or AAAA).

string
ttl
integer format: int32
records
Array<object>
object
content

Rdata in presentation format (e.g. “192.0.2.1”, “10 mail.example.com.”).

string
disabled
boolean
createdAt
string format: date-time
updatedAt
string format: date-time

400

Section titled “400 ”

invalid_argument: a field or record value is invalid. A CNAME at the zone apex is stored as ALIAS, so its errors name ALIAS.

Messages:

  • validation error: <field>: <reason>
  • record <name> is not within zone <zone>
  • ttl <ttl> out of range [<min>,<max>] for <type>: allowed TTLs are 60 - 86400 seconds, or 3600 - 604800 for NS.
  • invalid <type> rdata "<value>"
  • A record content must be an IPv4 address, got "<value>" (AAAA and IPv6 likewise)
  • a CNAME record set must have exactly one value
  • CNAME at <name> cannot coexist with other record types
  • ALIAS at <name> cannot coexist with A, AAAA, or CNAME
  • apex NS at <name> is managed by enum and cannot be set
object
code

Error code, such as invalid_argument or not_found.

string
message

Human-readable error message.

string

401

Section titled “401 ”

unauthenticated: the token is missing, invalid, or expired.

Messages:

  • missing authorization header
  • invalid authorization header format
  • authentication failed
object
code

Error code, such as invalid_argument or not_found.

string
message

Human-readable error message.

string

403

Section titled “403 ”

permission_denied: the token has no access to this project or method.

Messages:

  • not authorized
object
code

Error code, such as invalid_argument or not_found.

string
message

Human-readable error message.

string

404

Section titled “404 ”

not_found: the resource does not exist.

Messages:

  • resource not found
object
code

Error code, such as invalid_argument or not_found.

string
message

Human-readable error message.

string

429

Section titled “429 ”

resource_exhausted: a rate limit or quota is reached.

Messages:

  • rate limit exceeded: wait for the number of seconds in Retry-After.
  • dns.records quota exceeded: limit <n>, in use <n>, requested <n>: the project has reached its record quota.
object
code

Error code, such as invalid_argument or not_found.

string
message

Human-readable error message.

string

500

Section titled “500 ”

internal: something failed on our side.

Messages:

  • internal error
object
code

Error code, such as invalid_argument or not_found.

string
message

Human-readable error message.

string