/vanity-domains/{domainId}

GET /vanity-domains/{domainId}

Get vanity domain

Retrieve details for a specific vanity domain

Authentication Required

Authorization: Bearer {token} header string

This header is required to access this endpoint

Required Parameters

x-account-id header string

Account ID for the request

domainId path string

Try it out

Output:

Responses

Description

Domain retrieved successfully

{
  "id": "string",
  "domain": "string",
  "status": "string",
  "sslEnabled": false,
  "createdAt": "string",
  "updatedAt": "string",
  "dnsRecords": [
    {}
  ],
  "validationStatus": {
    "lastChecked": "string",
    "isValid": false
  }
}

References

#/components/parameters/xAccountIdHeader #/components/schemas/VanityDomain #/components/schemas/VanityDomainDetailed

in: header
name: x-account-id
schema:
  type: string
description: Account ID for the request
required: true
example: "2311"

|
export type xAccountIdHeader = any; // Schema type not fully supported

#/components/schemas/VanityDomain

OpenAPI
TypeScript

type: object
properties:
  id:
    type: string
  domain:
    type: string
  status:
    type: string
    enum:
      - pending
      - active
      - failed
  sslEnabled:
    type: boolean
  createdAt:
    type: string
    format: date-time
  updatedAt:
    type: string
    format: date-time

|
export interface VanityDomain {
  id?: string;
  domain?: string;
  status?: "pending" | "active" | "failed";
  sslEnabled?: boolean;
  createdAt?: Date;
  updatedAt?: Date;
}

#/components/schemas/VanityDomainDetailed

OpenAPI
TypeScript

allOf:
  - type: object
    properties:
      id:
        type: string
      domain:
        type: string
      status:
        type: string
        enum:
          - pending
          - active
          - failed
      sslEnabled:
        type: boolean
      createdAt:
        type: string
        format: date-time
      updatedAt:
        type: string
        format: date-time
    fromRef: "#/components/schemas/VanityDomain"
  - type: object
    properties:
      dnsRecords:
        type: array
        items:
          type: object
      validationStatus:
        type: object
        properties:
          lastChecked:
            type: string
            format: date-time
          isValid:
            type: boolean

|
export interface VanityDomainDetailed_AllOf_0 {
  id?: string;
  domain?: string;
  status?: "pending" | "active" | "failed";
  sslEnabled?: boolean;
  createdAt?: Date;
  updatedAt?: Date;
}

export interface VanityDomainDetailed_AllOf_1 {
  dnsRecords?: {}[];
  validationStatus?: { lastChecked?: Date; isValid?: boolean };
}

export type VanityDomainDetailed = VanityDomainDetailed_AllOf_0 &
  VanityDomainDetailed_AllOf_1;

Route Source Code

Check out the source code for this route entrypoint here: /vanity-domains/[domainId]/route.ts

Or the swagger.yaml spec this documentation was generated from: /vanity-domains/swagger.yaml