DNS

Records of the DNS zones Nimag hosts for the customer.

GET/services/{service_id}/dns-recordsList records
POST/services/{service_id}/dns-recordsAdd a record
PATCH/services/{service_id}/dns-records/{record_id}Change a record
DELETE/services/{service_id}/dns-records/{record_id}Delete a record

List records

GET/services/{service_id}/dns-records

Needs the permission dns:manage

Path

service_idrequired string (uuid)

Response 200

`id`required	string
`type`required	string
`name`required	string
`data`required	string
`ttl`required	integer
`priority`required	integer \| null
`active`required	boolean

curl "https://portal.nimag.net/api/v1/services/{service_id}/dns-records" \
  -H "Authorization: Bearer nck_…"

[
  {
    "id": "string",
    "type": "string",
    "name": "string",
    "data": "string",
    "ttl": 0,
    "priority": 0,
    "active": true
  }
]

Add a record

POST/services/{service_id}/dns-records

Needs the permission dns:manage

A, AAAA, CNAME, MX, TXT, SRV, CAA and NS records. Names are relative to the zone (www, @) or full names inside it.

Path

service_idrequired string (uuid)

Body (JSON)

`type`required	string	up to 8 characters
`name`required	string	up to 253 characters
`data`required	string	up to 2048 characters
`ttl`	integer	from 60, up to 604800, default 3600
`priority`	integer \| null	from 0, up to 65535

Response 201

`id`required	string
`type`required	string
`name`required	string
`data`required	string
`ttl`required	integer
`priority`required	integer \| null
`active`required	boolean

curl -X POST "https://portal.nimag.net/api/v1/services/{service_id}/dns-records" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "string",
    "name": "string",
    "data": "string",
    "ttl": 3600,
    "priority": 0
  }'

{
  "id": "string",
  "type": "string",
  "name": "string",
  "data": "string",
  "ttl": 0,
  "priority": 0,
  "active": true
}

Change a record

PATCH/services/{service_id}/dns-records/{record_id}

Needs the permission dns:manage

Path

`service_id`required	string (uuid)
`record_id`required	string

Body (JSON)

`name`required	string	up to 253 characters
`data`required	string	up to 2048 characters
`ttl`	integer	from 60, up to 604800, default 3600
`priority`	integer \| null	from 0, up to 65535

Response 200

`id`required	string
`type`required	string
`name`required	string
`data`required	string
`ttl`required	integer
`priority`required	integer \| null
`active`required	boolean

curl -X PATCH "https://portal.nimag.net/api/v1/services/{service_id}/dns-records/{record_id}" \
  -H "Authorization: Bearer nck_…" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "data": "string",
    "ttl": 3600,
    "priority": 0
  }'

{
  "id": "string",
  "type": "string",
  "name": "string",
  "data": "string",
  "ttl": 0,
  "priority": 0,
  "active": true
}

Delete a record

DELETE/services/{service_id}/dns-records/{record_id}

Needs the permission dns:manage

Path

`service_id`required	string (uuid)
`record_id`required	string

Response 204: no content.

curl -X DELETE "https://portal.nimag.net/api/v1/services/{service_id}/dns-records/{record_id}" \
  -H "Authorization: Bearer nck_…"