Organizations

Custom domain step 3: verify platform DNS (manual TXT or managed certificate readiness)

**Manual path:** After staff **`PATCH .../platform-dns-verification`**, the org adds the published TXT and calls this endpoint. The API resolves public TXT at **`platformDnsVerification.recordName`** and matches **`recordValue`**. On success, `status` → **`platform_dns_pending_review`** until staff **`POST .../activate`**. **Automated path (default):** When automated certificate provisioning is in effect, the org calls this after the Mudbase TXT and the certificate DNS rows are in place (status typically **`cname_approved`** from automated verify-dns). The API checks the managed certificate with bounded retries. On success, `status` → **`active`** and the org may receive the activation email, with no staff **`approve-cname`** or **`activate`** required. **Legacy path:** In the legacy staff pipeline, staff **`approve-cname`** may be required first; after the managed certificate is ready, **`status`** becomes **`active`** on auto-activation, else **`platform_dns_pending_review`** until staff **`activate`**. **`platform_dns_verification_failed`** may include **`details.flyStatus`** / **`details.flyError`** with provisioning error context.

AuthBearer (JWT)

GroupOrganizations

Rate limitSee Rate Limits

POST/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}/verify-platform-dns

SDK setup

Create a client and set credentials (JWT and/or API key) before calling the API. Match the authentication type shown above.

import { Configuration, OrganizationsApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const organizations = new OrganizationsApi(configuration);
import { Configuration, OrganizationsApi } from 'mudbase-sdk';

const configuration = new Configuration({
  basePath: 'https://cloud.mudbase.dev',
  accessToken: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJ1c3JfbW9yZ2FuX2RlIiwiZW1haWwiOiJtb3JnYW4uY2hlbkBub3J0aHdpbmQuZGV2IiwiZXhwIjoxODI1MTI5NjAwfQ.doc_preview_sig',
});

const organizations = new OrganizationsApi(configuration);

Example request

Call this endpoint using the client from SDK setup. Use View HTTP for a raw cURL example.

const { data: result } = await organizations.orgCustomDomainVerifyPlatformDns("org_GuxlF5PyuM", "proj_FkQC8cE9YNwx", "Doyle Wilderman");
const { data: result } = await organizations.orgCustomDomainVerifyPlatformDns("org_GuxlF5PyuM", "proj_FkQC8cE9YNwx", "Doyle Wilderman");

Playground

live

Test this endpoint with your own credentials. Your requests will be sent to the live API.

JWT Bearer Token Use the auth endpoints to obtain a JWT.

Path Parameters

orgId

projectId

hostname

No Request Yet

Send a request to see the full inspector

Authentication

Requires JWT

Note

Include your JWT in the Authorization: Bearer YOUR_TOKEN header (user-facing apps, RBAC). View authentication guide →

Path Parameters

Name	Type	Required	Description
`orgId`	string	Yes	-
`projectId`	string	Yes	-
`hostname`	string	Yes	-

Responses

200Domain row updated (`OrgPatchDomainResponse.domain`). Manual TXT path typically sets `platform_dns_pending_review`. Automated provisioning: typically `active` when the certificate is ready. Legacy staff pipeline: may set `platform_dns_pending_review` unless auto-activation is enabled. Body may include refreshed `dnsRecords` and `flyCertificateStatus` when certificate provisioning ran.

json

{
  "success": true,
  "domain": {
    "_id": "hZnryo8KvYooSGj4",
    "hostname": "Isaias Mann",
    "status": "bandwidth quantify",
    "isPrimary": false,
    "source": "api",
    "createdAt": "2026-08-28T08:29:45.839Z",
    "verifiedAt": "2026-09-01T23:15:46.901Z",
    "lastVerifiedAt": "2026-07-27T19:04:19.233Z",
    "cnameSubmittedAt": "2026-07-22T11:54:26.851Z",
    "cnameApprovedAt": "2026-08-04T07:43:49.357Z",
    "customDomainVerificationStep": 67788,
    "routingCnameTarget": "Katrina Crona",
    "dnsRecords": [
      {
        "type": "hard drive quantify",
        "name": "Jacky Howe",
        "value": "microchip parse",
        "purpose": "feed navigate"
      }
    ],
    "platformActivationPending": false,
    "customDomainLiveForApiTraffic": true,
    "edge": {
      "saasIntegrationEnabled": true,
      "skipped": true,
      "reason": "monitor compress",
      "customHostnameId": "Alexandrine Casper DVM",
      "hostnameStatus": "Jermey Marks",
      "sslStatus": "array hack",
      "ownershipVerification": {
        "name": "Alejandro Bode MD",
        "type": "interface reboot",
        "value": "sensor program"
      },
      "sslValidationRecords": [
        {
          "txtName": "Crawford Huels",
          "txtValue": "bandwidth program",
          "httpUrl": "https://unpleasant-heartache.net/",
          "httpBody": "monitor navigate",
          "cname": "Leigh Kohler",
          "cnameTarget": "Emily Conn"
        }
      ],
      "lastError": "port compress",
      "instructions": "interface input"
    },
    "flyCertificateStatus": "driver synthesize",
    "platformDnsVerification": {
      "recordType": "circuit navigate",
      "recordName": "Toby Mosciski",
      "recordValue": "circuit override",
      "ttlSeconds": 91387,
      "staffNote": "alarm quantify",
      "updatedAt": "2026-09-02T17:49:16.986Z"
    },
    "platformDnsVerificationSubmittedAt": "2026-08-18T20:47:49.346Z"
  },
  "dnsVerificationInstructions": "bandwidth reboot"
}
{
  "success": true,
  "domain": {
    "_id": "hZnryo8KvYooSGj4",
    "hostname": "Isaias Mann",
    "status": "bandwidth quantify",
    "isPrimary": false,
    "source": "api",
    "createdAt": "2026-08-28T08:29:45.839Z",
    "verifiedAt": "2026-09-01T23:15:46.901Z",
    "lastVerifiedAt": "2026-07-27T19:04:19.233Z",
    "cnameSubmittedAt": "2026-07-22T11:54:26.851Z",
    "cnameApprovedAt": "2026-08-04T07:43:49.357Z",
    "customDomainVerificationStep": 67788,
    "routingCnameTarget": "Katrina Crona",
    "dnsRecords": [
      {
        "type": "hard drive quantify",
        "name": "Jacky Howe",
        "value": "microchip parse",
        "purpose": "feed navigate"
      }
    ],
    "platformActivationPending": false,
    "customDomainLiveForApiTraffic": true,
    "edge": {
      "saasIntegrationEnabled": true,
      "skipped": true,
      "reason": "monitor compress",
      "customHostnameId": "Alexandrine Casper DVM",
      "hostnameStatus": "Jermey Marks",
      "sslStatus": "array hack",
      "ownershipVerification": {
        "name": "Alejandro Bode MD",
        "type": "interface reboot",
        "value": "sensor program"
      },
      "sslValidationRecords": [
        {
          "txtName": "Crawford Huels",
          "txtValue": "bandwidth program",
          "httpUrl": "https://unpleasant-heartache.net/",
          "httpBody": "monitor navigate",
          "cname": "Leigh Kohler",
          "cnameTarget": "Emily Conn"
        }
      ],
      "lastError": "port compress",
      "instructions": "interface input"
    },
    "flyCertificateStatus": "driver synthesize",
    "platformDnsVerification": {
      "recordType": "circuit navigate",
      "recordName": "Toby Mosciski",
      "recordValue": "circuit override",
      "ttlSeconds": 91387,
      "staffNote": "alarm quantify",
      "updatedAt": "2026-09-02T17:49:16.986Z"
    },
    "platformDnsVerificationSubmittedAt": "2026-08-18T20:47:49.346Z"
  },
  "dnsVerificationInstructions": "bandwidth reboot"
}

400custom_domain_invalid_state, platform_dns_verification_failed (manual TXT mismatch or managed certificate not active yet; see response details)

401Unauthorized

403Forbidden

503dns_lookup_error

Errors

Code	Meaning
`400`	custom_domain_invalid_state, platform_dns_verification_failed (manual TXT mismatch or managed certificate not active yet; see response details)
`401`	Unauthorized
`403`	Forbidden
`503`	dns_lookup_error

Run in Postman Download OpenAPI

NEXT →API Reference OverviewBase URL, rate limits, pagination, and the full endpoint index.NEXT →AuthenticationAPI keys, Bearer tokens, and user sessions.NEXT →API PlaygroundSearch any endpoint and send a live request.

Edit this page on GitHub

SDK setup

Example request

Playground

No Request Yet

Authentication

Path Parameters

Responses

Errors

Next