object JsonDataType

{
  "required": [
    "type",
    "$ref"
  ],
  "properties": {
    "type": {
      "type": "string"
    },
    "format": {
      "type": "string"
    },
    "pattern": {
      "type": "string"
    }
  }
}

object JsonProperty

{
  "required": [
    "type",
    "$ref",
    "required"
  ],
  "properties": {
    "type": {
      "type": "string"
    },
    "items": {
      "type": "object",
      "items": {
        "$ref": "#/components/schemas/JsonDataType"
      }
    },
    "format": {
      "type": "string"
    },
    "maximum": {
      "type": "integer"
    },
    "minimum": {
      "type": "integer"
    },
    "pattern": {
      "type": "string"
    },
    "maxItems": {
      "type": "integer"
    },
    "minItems": {
      "type": "integer"
    },
    "required": {
      "type": "boolean"
    },
    "defaultValue": {
      "type": "string"
    }
  }
}

object JsonSchema

{
  "required": [
    "id",
    "properties",
    "required",
    "models"
  ],
  "properties": {
    "id": {
      "type": "string"
    },
    "models": {
      "type": "object",
      "items": {
        "$ref": "#/components/schemas/JsonSchema"
      }
    },
    "required": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "properties": {
      "type": "object",
      "items": {
        "$ref": "#/components/schemas/JsonProperty"
      }
    }
  }
}

object LegalAgreement

{
  "required": [
    "agreementKey",
    "title",
    "content"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "url",
      "description": "URL to a page containing the legal agreement"
    },
    "title": {
      "type": "string",
      "description": "Title of the legal agreement"
    },
    "content": {
      "type": "string",
      "description": "Contents of the legal agreement, suitable for embedding"
    },
    "agreementKey": {
      "type": "string",
      "description": "Unique identifier for the legal agreement"
    }
  }
}

object Maintenance

{
  "required": [
    "createdAt",
    "endsAt",
    "environment",
    "maintenanceId",
    "modifiedAt",
    "reason",
    "startsAt",
    "status",
    "summary",
    "type"
  ],
  "properties": {
    "tlds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tlds that are in maintenance.  Generally only applies when `type` is REGISTRY"
    },
    "type": {
      "enum": [
        "API",
        "REGISTRY",
        "UI"
      ],
      "type": "string",
      "description": "The type of maintenance being performed<br/><ul><li><strong style='margin-left: 12px;'>API</strong> - Programmatic Api components.</li><li><strong style='margin-left: 12px;'>REGISTRY</strong> - The underlying Registry providing the tld(s).</li><li><strong style='margin-left: 12px;'>UI</strong> - User Interface components.</li></ul>"
    },
    "endsAt": {
      "type": "string",
      "format": "iso-datetime",
      "description": "Date and time (UTC) when this maintenance will complete"
    },
    "reason": {
      "enum": [
        "EMERGENCY",
        "PLANNED"
      ],
      "type": "string",
      "description": "The reason for the maintenance being performed<br/><ul><li><strong style='margin-left: 12px;'>EMERGENCY</strong> - Unexpected Emergency maintenance.</li><li><strong style='margin-left: 12px;'>PLANNED</strong> - Planned system maintenance.</li></ul>"
    },
    "status": {
      "enum": [
        "ACTIVE",
        "CANCELLED"
      ],
      "type": "string",
      "description": "The status of maintenance<br/><ul><li><strong style='margin-left: 12px;'>ACTIVE</strong> - The upcoming maintenance is active.</li><li><strong style='margin-left: 12px;'>CANCELLED</strong> - The upcoming maintenance has been cancelled.</li></ul>"
    },
    "summary": {
      "type": "string",
      "description": "A brief description of what is being performed"
    },
    "startsAt": {
      "type": "string",
      "format": "iso-datetime",
      "description": "Date and time (UTC) when this maintenance will start"
    },
    "createdAt": {
      "type": "string",
      "format": "iso-datetime",
      "description": "Date and time (UTC) when this maintenance was created"
    },
    "modifiedAt": {
      "type": "string",
      "format": "iso-datetime",
      "description": "Date and time (UTC) when this maintenance was last modified"
    },
    "environment": {
      "enum": [
        "OTE",
        "PRODUCTION"
      ],
      "type": "string",
      "description": "The environment on which the maintenance will be performed<br/><ul><li><strong style='margin-left: 12px;'>OTE</strong> - The Operational Testing Environment.</li><li><strong style='margin-left: 12px;'>PRODUCTION</strong> - The Live Production Environment.</li></ul>"
    },
    "maintenanceId": {
      "type": "string",
      "description": "The identifier for the system maintenance"
    }
  },
  "additionalProperties": false
}

object MaintenanceDetail

{
  "required": [
    "createdAt",
    "endsAt",
    "environment",
    "maintenanceId",
    "modifiedAt",
    "reason",
    "startsAt",
    "status",
    "summary",
    "type"
  ],
  "properties": {
    "tlds": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of tlds that are in maintenance.  Generally only applies when `type` is REGISTRY"
    },
    "type": {
      "enum": [
        "API",
        "REGISTRY",
        "UI"
      ],
      "type": "string",
      "description": "The type of maintenance being performed<br/><ul><li><strong style='margin-left: 12px;'>API</strong> - Programmatic Api components.</li><li><strong style='margin-left: 12px;'>REGISTRY</strong> - The underlying Registry providing the tld(s).</li><li><strong style='margin-left: 12px;'>UI</strong> - User Interface components.</li></ul>"
    },
    "endsAt": {
      "type": "string",
      "format": "iso-datetime",
      "description": "Date and time (UTC) when this maintenance will complete"
    },
    "reason": {
      "enum": [
        "EMERGENCY",
        "PLANNED"
      ],
      "type": "string",
      "description": "The reason for the maintenance being performed<br/><ul><li><strong style='margin-left: 12px;'>EMERGENCY</strong> - Unexpected Emergency maintenance.</li><li><strong style='margin-left: 12px;'>PLANNED</strong> - Planned system maintenance.</li></ul>"
    },
    "status": {
      "enum": [
        "ACTIVE",
        "CANCELLED"
      ],
      "type": "string",
      "description": "The status of maintenance<br/><ul><li><strong style='margin-left: 12px;'>ACTIVE</strong> - The upcoming maintenance is active.</li><li><strong style='margin-left: 12px;'>CANCELLED</strong> - The upcoming maintenance has been cancelled.</li></ul>"
    },
    "summary": {
      "type": "string",
      "description": "A brief description of what is being performed"
    },
    "systems": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MaintenanceSystem"
      },
      "description": "List of systems that are impacted by the maintenance."
    },
    "startsAt": {
      "type": "string",
      "format": "iso-datetime",
      "description": "Date and time (UTC) when this maintenance will start"
    },
    "createdAt": {
      "type": "string",
      "format": "iso-datetime",
      "description": "Date and time (UTC) when this maintenance was created"
    },
    "modifiedAt": {
      "type": "string",
      "format": "iso-datetime",
      "description": "Date and time (UTC) when this maintenance was last modified"
    },
    "environment": {
      "enum": [
        "OTE",
        "PRODUCTION"
      ],
      "type": "string",
      "description": "The environment on which the maintenance will be performed<br/><ul><li><strong style='margin-left: 12px;'>OTE</strong> - The Operational Testing Environment.</li><li><strong style='margin-left: 12px;'>PRODUCTION</strong> - The Live Production Environment.</li></ul>"
    },
    "maintenanceId": {
      "type": "string",
      "description": "The identifier for the system maintenance"
    }
  },
  "additionalProperties": false
}

object MaintenanceSystem

{
  "required": [
    "name",
    "impact"
  ],
  "properties": {
    "name": {
      "enum": [
        "DOMAIN_CHECKS",
        "DOMAIN_MANAGEMENT",
        "DOMAIN_REGISTRATION",
        "DOMAIN_REGISTRATION_DATA",
        "DOMAIN_RESOLUTION",
        "RESELLER_ADMIN_PORTAL",
        "RESELLER_STOREFRONT"
      ],
      "type": "string",
      "description": "The name of the system affected by the maintenance<br/><ul><li><strong style='margin-left: 12px;'>DOMAIN_CHECKS</strong> - Refers to domain availability checks.</li><li><strong style='margin-left: 12px;'>DOMAIN_MANAGEMENT</strong> - Refers to domain management options including various update options on the domain, contacts, records, etc.</li><li><strong style='margin-left: 12px;'>DOMAIN_REGISTRATION</strong> - Refers to domain registrations, renewals, transfers.</li><li><strong style='margin-left: 12px;'>DOMAIN_REGISTRATION_DATA</strong> - Refers to RDAP and WHOIS Service queries for domains.</li><li><strong style='margin-left: 12px;'>DOMAIN_RESOLUTION</strong> - Refers to DNS resolution for domains.</li><li><strong style='margin-left: 12px;'>RESELLER_ADMIN_PORTAL</strong> - Refers to Admin portals to manage the reseller account and settings.</li><li><strong style='margin-left: 12px;'>RESELLER_STOREFRONT</strong> - Refers to the Reseller Storefront features (Standard and Custom).</li></ul>"
    },
    "impact": {
      "type": "array",
      "items": {
        "enum": [
          "DELAYED",
          "DOWN",
          "NON_AUTHORITATIVE",
          "PARTIAL"
        ],
        "type": "string"
      },
      "description": "The impact of the maintenance to the system<br/><ul><li><strong style='margin-left: 12px;'>DELAYED</strong> - This response generally applies to systems where the request is queued up and processed once the system is back online.</li><li><strong style='margin-left: 12px;'>DOWN</strong> - The system will be entirely offline; errors are expected.</li><li><strong style='margin-left: 12px;'>NON_AUTHORITATIVE</strong> - This response generally applies to DOMAIN_CHECKS and DOMAIN_MANAGEMENT `system` values where a cached answer will be supplied.</li><li><strong style='margin-left: 12px;'>PARTIAL</strong> - The system will experience partial feature outages; some errors are expected.</li></ul>"
    }
  },
  "additionalProperties": false
}

array NotificationsListOptedInTypesResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainNotification"
  }
}

object PrivacyPurchase

{
  "required": [
    "consent"
  ],
  "properties": {
    "consent": {
      "$ref": "#/components/schemas/Consent"
    }
  }
}

object RealNameValidation

{
  "properties": {
    "status": {
      "enum": [
        "APPROVED",
        "PENDING",
        "PENDING_ASSOCIATION_WITH_DOMAIN",
        "PENDING_SUBMISSION_TO_VERIFICATION_SERVICE",
        "PENDING_VERIFICATION_SERVICE_REPLY",
        "PENDING_SUBMISSION_TO_REGISTRY",
        "PENDING_REGISTRY_REPLY",
        "PENDING_DOMAIN_UPDATE",
        "REJECTED"
      ],
      "type": "string"
    }
  }
}

object RenewalDetails

{
  "required": [
    "price",
    "currency"
  ],
  "properties": {
    "price": {
      "type": "integer",
      "format": "currency-micro-unit",
      "description": "Price for the domain renewal excluding taxes or fees"
    },
    "currency": {
      "type": "string",
      "format": "iso-currency-code",
      "default": "USD",
      "pattern": "^[A-Z][A-Z][A-Z]$",
      "description": "Currency in which the `price` is listed"
    },
    "renewable": {
      "type": "boolean",
      "description": "Whether or not the domain is eligble for renewal based on status"
    }
  }
}

object TldSummary

{
  "required": [
    "name",
    "type"
  ],
  "properties": {
    "name": {
      "type": "string",
      "format": "tld",
      "description": "Name of the top-level domain"
    },
    "type": {
      "enum": [
        "COUNTRY_CODE",
        "GENERIC"
      ],
      "type": "string",
      "default": "GENERIC",
      "description": "Type of the top-level domain"
    }
  }
}

array V1CheckDomainAvailabilityPostRequest

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "maximum": 500
}

array V1CheckDomainAvailabilityPostRequest1

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "maximum": 500
}

array V1CheckDomainAvailabilityPostRequest2

{
  "type": "array",
  "items": {
    "type": "string"
  },
  "maximum": 500
}

array V1GetDnsRecords200Response

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecord"
  }
}

array V1GetDnsRecords200Response1

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecord"
  }
}

array V1GetDnsRecords200Response2

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecord"
  }
}

array V1GetDnsRecords200Response3

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecord"
  }
}

array V1GetDnsRecordsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecord"
  }
}

array V1GetDomainsList200Response

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSummary"
  }
}

array V1GetDomainsList200Response1

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSummary"
  }
}

array V1GetDomainsList200Response2

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSummary"
  }
}

array V1GetDomainsList200Response3

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSummary"
  }
}

array V1GetDomainsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSummary"
  }
}

array V1GetLegalAgreements200Response

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/LegalAgreement"
  }
}

array V1GetLegalAgreements200Response1

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/LegalAgreement"
  }
}

array V1GetLegalAgreements200Response2

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/LegalAgreement"
  }
}

array V1GetLegalAgreements200Response3

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/LegalAgreement"
  }
}

array V1GetLegalAgreementsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/LegalAgreement"
  }
}

array V1GetTldsList200Response

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TldSummary"
  }
}

array V1GetTldsList200Response1

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TldSummary"
  }
}

array V1GetTldsList200Response2

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TldSummary"
  }
}

array V1GetTldsList200Response3

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TldSummary"
  }
}

array V1GetTldsListResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/TldSummary"
  }
}

array V1ReplaceDnsRecordsRequest

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecord"
  }
}

array V1ReplaceDnsRecordsRequest1

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecord"
  }
}

array V1ReplaceDnsRecordsRequest2

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecord"
  }
}

array V1ReplaceDnsRecordsTypeRequest

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecordCreateType"
  }
}

array V1ReplaceDnsRecordsTypeRequest1

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecordCreateType"
  }
}

array V1ReplaceDnsRecordsTypeRequest2

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecordCreateType"
  }
}

array V1ReplaceDnsRecordsTypeRequest3

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecordCreateTypeName"
  }
}

array V1ReplaceDnsRecordsTypeRequest4

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecordCreateTypeName"
  }
}

array V1ReplaceDnsRecordsTypeRequest5

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DNSRecordCreateTypeName"
  }
}

array V1SuggestAlternateDomains200Response

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSuggestion"
  }
}

array V1SuggestAlternateDomains200Response1

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSuggestion"
  }
}

array V1SuggestAlternateDomains200Response2

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSuggestion"
  }
}

array V1SuggestAlternateDomains200Response3

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSuggestion"
  }
}

array V1SuggestAlternateDomainsResponse

{
  "type": "array",
  "items": {
    "$ref": "#/components/schemas/DomainSuggestion"
  }
}

object VerificationDomainName

{
  "required": [
    "status"
  ],
  "properties": {
    "status": {
      "enum": [
        "APPROVED",
        "PENDING",
        "REJECTED",
        "UNABLE_TO_RETRIEVE_STATUS"
      ],
      "type": "string",
      "description": "Status of the domain name verification"
    }
  }
}