Function: getDomainById()

function getDomainById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        claim?: {
         [key: string]: unknown;
           status?:   | "deleted"
              | string & object
              | "verified"
              | "unverified"
              | "superseded"
              | "missing_token";
           type?: string & object | "http" | "dns";
        };
        name?: string;
     };
     id: string;
     links: {
      [key: string]: unknown;
        self: string | null;
     };
     type: string & object | "domains";
  };
}>;

Defined in: src/admin/api/domains.ts:39

Returns information about a single verified domain by ID.

Scopes

Authorization scopes required: read:domains:admin

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ domainId: string; orgId: string; }	-
parameters.domainId	string	ID of the domain to return
parameters.orgId?	string	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; data?: { [key: string]: unknown; attributes: { [key: string]: unknown; claim?: { [key: string]: unknown; status?: | "deleted" | string & object | "verified" | "unverified" | "superseded" | "missing_token"; type?: string & object | "http" | "dns"; }; name?: string; }; id: string; links: { [key: string]: unknown; self: string | null; }; type: string & object | "domains"; }; }>