domains

A domain’s DNS records and nameservers

Changed on

records is every record on Orgo DNS for the domain: A, AAAA, CNAME, MX, TXT and SRV, the types Orgo DNS serves (no NS, CAA or ALIAS). name is relative to the domain ("" for the domain itself, "www", "_dmarc", "*"); fqdn is the full name. A record with managed set was written by Orgo to serve a computer (the A record at a connected name and its _orgo-verify TXT): it changes with the computer’s custom domain, not here.

serving is whether the internet gets these records: true while the domain uses Orgo DNS’s nameservers (nameservers.mode "orgo"). With custom nameservers the records stay saved here but are not served. ttl_seconds is always null: Orgo DNS sets the TTL and it can’t be changed. Any member may read it, with a session, an account-wide key or a key for this workspace.

get/api/projects/{id}/domains/{domainId}/dns

Request

  • Base URL
    https://www.orgo.ai
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Workspace id.

domainIdstring uuid required

A domain bought through Orgo: its id in GET /api/projects/{id}/domains.

Response

The zone.

domainstring required
servingboolean required

The internet gets these records: the domain uses Orgo DNS’s nameservers.

ttl_secondsunknown required

Example response

{
  "domain": "orgo.agency",
  "nameservers": {
    "mode": "custom",
    "list": [
      "ada.ns.cloudflare.com",
      "bob.ns.cloudflare.com"
    ]
  },
  "records": [
    {
      "id": "k3Jd9xQ2mZ0aB1cD",
      "type": "MX",
      "name": "",
      "fqdn": "orgo.agency",
      "value": "smtp.google.com",
      "priority": 1,
      "managed": null
    }
  ]
}

Changes

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the non-success response with the status