Update an organisation DNS record

Changes a record’s content and, when given, its ttl; the name and record type cannot change. Organisation admins only. The record returns to pending until the change is published.

PATCH /api/v1/org/dns/records/{record_id}

Update an organisation DNS record

Python

import requests

url = "https://platform.ankra.app/api/v1/org/dns/records/{record_id}"

payload = { "content": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

200

{
  "id": "<string>",
  "name": "<string>",
  "record_type": "<string>",
  "content": "<string>",
  "state": "<string>",
  "created_by": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "ttl": 123,
  "last_error": "<string>",
  "source": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

authorization · string | null

x-ankra-organisation-id · string | null

Path Parameters

record_id · string<uuid> · required

Body

application/json

content · string · required

ttl · integer | null

Response

200

application/json

Successful Response

id · string · required

name · string · required

record_type · string · required

content · string · required

state · string · required

created_by · string · required

created_at · string · required

updated_at · string · required

ttl · integer | null

last_error · string | null

source · string

Who wrote the record, present for an organisation whose zone lives on Ankra Cloud, where records are read from and written to Ankra Cloud directly: platform (written through Ankra), user (written in the Ankra Cloud DNS console) or external-dns (published by a cluster's external-dns, read-only here).