Verify Portal Domain

Beta

POST/v1/settings/portal-domains/{id}/actions/verify

Idempotent with Idempotency-Key header. Learn more

Re-checks the domain's DNS configuration and flips it to verified once the published records are confirmed.

Returns the updated domain (still pending if DNS has not propagated yet) along with the currently required DNS records.

Permissions requiredValues:self:update

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

idstring

Portal domain ID.

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

200

Successful response for Verify Portal Domain

Verify 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.actions.verify(
  'podn_018e88072d1320808dc9aab42',
);

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.actions.verify(
  'podn_018e88072d1320808dc9aab42',
);

console.log(portalDomain.id);

200 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"
}

Verify Portal Domain

Authorization

Path Parameters

Returns

Responses