Organizations

Update domain status or regenerate verification token

AuthBearer (JWT)
GroupOrganizations
Rate limitSee Rate Limits
PATCH/api/orgs/{orgId}/projects/{projectId}/domains/{hostname}

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.patchOrgCustomDomain(
  "org_AJNzzzg80n",
  "proj_EUkL6zC2R2cG",
  "Irene Ankunding",
  {
    status: "bus quantify",
    regenerateToken: true
  }
);
const { data: result } = await organizations.patchOrgCustomDomain(
  "org_AJNzzzg80n",
  "proj_EUkL6zC2R2cG",
  "Irene Ankunding",
  {
    status: "bus quantify",
    regenerateToken: true
  }
);

Playground

live

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

Use the auth endpoints to obtain a JWT.

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

NameTypeRequiredDescription
orgIdstringYes—
projectIdstringYes—
hostnamestringYes—

Request Body

json
{
  "status": "failed",
  "regenerateToken": true
}
{
  "status": "failed",
  "regenerateToken": true
}

Responses

200Updated; domain object includes dnsTxtHost and dnsTxtValue
json
{
  "success": true,
  "domain": {
    "_id": "hZnryo8KvYooSGj4",
    "hostname": "Isaias Mann",
    "status": "bandwidth quantify",
    "isPrimary": false,
    "source": "api",
    "createdAt": "2026-07-14T07:18:02.282Z",
    "verifiedAt": "2026-07-18T22:04:03.344Z",
    "lastVerifiedAt": "2026-06-12T17:52:35.676Z",
    "cnameSubmittedAt": "2026-06-07T10:42:43.294Z",
    "cnameApprovedAt": "2026-06-20T06:32:05.800Z",
    "customDomainVerificationStep": 67788,
    "routingCnameTarget": "Katrina Crona",
    "dnsRecords": [
      {
        "type": "hard drive quantify",
        "name": "Jacky Howe",
        "value": "microchip parse",
        "purpose": "feed navigate"
      }
    ],
    "platformActivationPending": false,
    "customDomainLiveForApiTraffic": true,
    "cloudflareEdge": {
      "saasIntegrationEnabled": true,
      "skipped": false,
      "reason": "pixel reboot",
      "customHostnameId": "Miss Alexis Jacobson-Renner",
      "hostnameStatus": "Joshua Mitchell",
      "sslStatus": "transmitter input",
      "ownershipVerification": {
        "name": "Jamie Cummings",
        "type": "panel back up",
        "value": "microchip input"
      },
      "sslValidationRecords": [
        {
          "txtName": "Miss Roma Mante",
          "txtValue": "pixel copy",
          "httpUrl": "https://unkempt-ice-cream.com",
          "httpBody": "application override",
          "cname": "Zachary Kub",
          "cnameTarget": "Sheldon Mann"
        }
      ],
      "lastError": "interface reboot",
      "instructions": "array synthesize"
    },
    "flyCertificateStatus": "driver synthesize",
    "platformDnsVerification": {
      "recordType": "circuit navigate",
      "recordName": "Toby Mosciski",
      "recordValue": "circuit override",
      "ttlSeconds": 91387,
      "staffNote": "alarm quantify",
      "updatedAt": "2026-07-19T16:37:33.428Z"
    },
    "platformDnsVerificationSubmittedAt": "2026-07-04T19:36:05.788Z"
  },
  "dnsVerificationInstructions": "bandwidth reboot"
}
{
  "success": true,
  "domain": {
    "_id": "hZnryo8KvYooSGj4",
    "hostname": "Isaias Mann",
    "status": "bandwidth quantify",
    "isPrimary": false,
    "source": "api",
    "createdAt": "2026-07-14T07:18:02.282Z",
    "verifiedAt": "2026-07-18T22:04:03.344Z",
    "lastVerifiedAt": "2026-06-12T17:52:35.676Z",
    "cnameSubmittedAt": "2026-06-07T10:42:43.294Z",
    "cnameApprovedAt": "2026-06-20T06:32:05.800Z",
    "customDomainVerificationStep": 67788,
    "routingCnameTarget": "Katrina Crona",
    "dnsRecords": [
      {
        "type": "hard drive quantify",
        "name": "Jacky Howe",
        "value": "microchip parse",
        "purpose": "feed navigate"
      }
    ],
    "platformActivationPending": false,
    "customDomainLiveForApiTraffic": true,
    "cloudflareEdge": {
      "saasIntegrationEnabled": true,
      "skipped": false,
      "reason": "pixel reboot",
      "customHostnameId": "Miss Alexis Jacobson-Renner",
      "hostnameStatus": "Joshua Mitchell",
      "sslStatus": "transmitter input",
      "ownershipVerification": {
        "name": "Jamie Cummings",
        "type": "panel back up",
        "value": "microchip input"
      },
      "sslValidationRecords": [
        {
          "txtName": "Miss Roma Mante",
          "txtValue": "pixel copy",
          "httpUrl": "https://unkempt-ice-cream.com",
          "httpBody": "application override",
          "cname": "Zachary Kub",
          "cnameTarget": "Sheldon Mann"
        }
      ],
      "lastError": "interface reboot",
      "instructions": "array synthesize"
    },
    "flyCertificateStatus": "driver synthesize",
    "platformDnsVerification": {
      "recordType": "circuit navigate",
      "recordName": "Toby Mosciski",
      "recordValue": "circuit override",
      "ttlSeconds": 91387,
      "staffNote": "alarm quantify",
      "updatedAt": "2026-07-19T16:37:33.428Z"
    },
    "platformDnsVerificationSubmittedAt": "2026-07-04T19:36:05.788Z"
  },
  "dnsVerificationInstructions": "bandwidth reboot"
}
Run in PostmanDownload OpenAPI

Next

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