ORorgo
public-urls

List a computer’s custom domains, each with the DNS records to set

Changed on

enabled is false while custom domains are not enabled for this account, or for a computer they cannot serve (reason says so); the list still shows what the computer has. limit is the plan’s cap across every computer of the workspace owner (-1 = unlimited, 0 = not on the plan) and used what counts against it. cname_target is where a subdomain’s CNAME points and apex_ipv4 the A record for an apex domain. owned_domains are the workspace’s active domains bought through Orgo (GET /api/projects/{id}/domains), to add as registered_domain_id: absent when domains are not enabled for the caller or enabled is false, [] when enabled and the workspace has none. dns_records of a domain not bought through Orgo have zone null and their full names as host here; GET .../dns-check finds the zone.

get/api/computers/{id}/domains

Request

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

Path parameters

idstring required

Computer id.

Response

The domains.

enabledboolean
reasonstring

Why enabled is false for this computer, when that is the reason.

limitinteger
usedinteger
cname_targetstring nullable
apex_ipv4string nullable

Example response

{
  "cname_target": "edge.orgo.dev",
  "owned_domains": [
    {
      "domain": "orgo.agency"
    }
  ],
  "domains": [
    {
      "domain": "app.example.com",
      "dns": {
        "host": "_orgo-verify.app",
        "zone": "example.com"
      },
      "dns_records": [
        {
          "host": "_orgo-verify.app",
          "zone": "example.com"
        }
      ]
    }
  ]
}

Changes

  • afb6f0ee1aacRevision changes
    • info

      added the non-success response with the status

  • a506f6169bb5Revision 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