/vanity-domains

GET /vanity-domains

List vanity domains

Retrieve all vanity domains for the account

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

Optional Parameters

Click here to view an exhaustive list of all available parameters

page query integer

pageSize query integer

Try it out

Output:

Responses

Description

Domains retrieved successfully

{
  "data": [
    {
      "id": "string",
      "domain": "string",
      "status": "string",
      "sslEnabled": false,
      "createdAt": "string",
      "updatedAt": "string"
    }
  ],
  "page": 0,
  "pageSize": 0,
  "total": 0
}

References

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

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;
}

Route Source Code

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

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