Create Portal Domain

Beta

POST/v1/settings/portal-domains

Idempotent with Idempotency-Key header. Learn more

Connects a custom domain to the account's customer portal and returns the DNS records to publish.

Each account can have one custom domain. The domain starts in pending until its DNS is verified.

Permissions requiredValues:self:update

The role behind your API key or agent must grant every one of these permissions.

domainstring

The fully-qualified domain name to connect (e.g. shop.acme.com). Subdomains are recommended; apex domains are supported via an A record.

idstring

Portal domain ID.

objectstringenumValues:portal_domain

Resource type identifier.

domainstring

The fully-qualified domain name (e.g. shop.acme.com).

statusstringenumValues:pendingsecuringverified

Verification status.

pending domains await DNS configuration
securing domains have correct DNS and are waiting on TLS certificate issuance; the portal is not yet reachable over HTTPS
verified domains serve the portal over HTTPS
failed domains were rejected and cannot be used

dns_recordslistnullable

The DNS records the customer must publish for the domain to route and verify.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

null when the last page has been reached.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

null while on the first page.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of dns_record

Resources in this page.

objectstringenumValues:dns_record

Resource type identifier.

typestringenumValues:CNAMEATXT

Record type.

namestring

Record name (host) to publish.

valuestring

Record value to publish.

reasonstringenumValues:routingownership

Why the record is needed.

Routing records point traffic at the portal's serving infrastructure; ownership records prove control of a domain that is claimed elsewhere.

verified_atstring (date-time)nullable

When the domain's DNS configuration was confirmed.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

201

Successful response for Create Portal Domain

Create Portal Domain

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const portalDomain = await client.settings.portalDomains.create({ domain: 'shop.acme.com' });

console.log(portalDomain.id);

import Augno from '@augno/sdk';

const client = new Augno({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const portalDomain = await client.settings.portalDomains.create({ domain: 'shop.acme.com' });

console.log(portalDomain.id);

201 example

{
  "id": "podn_018e88072d1320808dc9aab42",
  "object": "portal_domain",
  "domain": "shop.acme.com",
  "status": "pending",
  "dns_records": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "object": "dns_record",
        "type": "CNAME",
        "name": "shop.acme.com",
        "value": "cname.vercel-dns.com",
        "reason": "routing"
      }
    ]
  },
  "verified_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "podn_018e88072d1320808dc9aab42",
  "object": "portal_domain",
  "domain": "shop.acme.com",
  "status": "pending",
  "dns_records": {
    "object": "list",
    "page_info": {
      "next_page_url": null,
      "previous_page_url": null,
      "has_next_page": false,
      "has_prev_page": false
    },
    "data": [
      {
        "object": "dns_record",
        "type": "CNAME",
        "name": "shop.acme.com",
        "value": "cname.vercel-dns.com",
        "reason": "routing"
      }
    ]
  },
  "verified_at": null,
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Create Portal Domain

Authorization

Request Body

Returns

Responses