components: parameters: DatetimeFormatHeader: description: Accepted for backwards compatibility; has no effect. Response datetimes are always normalized to UTC and serialized as RFC 3339 with a `Z` suffix, whether or not this header is sent. example: rfc3339 in: header name: X-Datetime-Format required: false schema: enum: - rfc3339 type: string schemas: AggregationResult: properties: field: anyOf: - type: string - type: 'null' title: Field name: title: Name type: string other_count: anyOf: - type: integer - type: 'null' title: Other Count rows: anyOf: - items: $ref: '#/components/schemas/AggregationRow' type: array - type: 'null' title: Rows type: title: Type type: string value: anyOf: - type: number - type: 'null' title: Value values: anyOf: - additionalProperties: type: number type: object - type: 'null' title: Values required: - name - type title: AggregationResult type: object AggregationRow: properties: count: title: Count type: integer key: title: Key type: string required: - key - count title: AggregationRow type: object AggregationsContext: properties: context_id: examples: - ctx_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Context Id type: string x-typeid-prefix: ctx conversation_id: examples: - conv_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Conversation Id type: string x-typeid-prefix: conv created_at: format: date-time title: Created At type: string kind: const: aggregations default: aggregations title: Kind type: string organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization payload: $ref: '#/components/schemas/AggregationsContextPayload' user_id: title: User Id type: string required: - context_id - conversation_id - organization_id - user_id - created_at - payload title: AggregationsContext type: object AggregationsContextCreate: properties: kind: const: aggregations default: aggregations title: Kind type: string payload: $ref: '#/components/schemas/AggregationsContextPayload' required: - payload title: AggregationsContextCreate type: object AggregationsContextPayload: properties: aggregations: items: $ref: '#/components/schemas/AggregationResult' title: Aggregations type: array question: title: Question type: string total: anyOf: - type: integer - type: 'null' title: Total required: - question - aggregations title: AggregationsContextPayload type: object AgreementType: enum: - terms_and_conditions - master_service_agreement - acting_as_trader - parking_agreement title: AgreementType type: string AiInferenceUsageBucket: properties: groups: items: $ref: '#/components/schemas/AiInferenceUsageGroup' title: Groups type: array period_start: format: date title: Period Start type: string required: - period_start - groups title: AiInferenceUsageBucket type: object AiInferenceUsageGroup: description: 'Public per-model AI inference usage. Deliberately excludes billing-gateway''s internal COGS fields (cost_amount, per-million rates, has_rate).' properties: cache_read_tokens: title: Cache Read Tokens type: integer cache_write_tokens: title: Cache Write Tokens type: integer input_tokens: title: Input Tokens type: integer model: title: Model type: string output_tokens: title: Output Tokens type: integer request_count: title: Request Count type: integer required: - model - input_tokens - output_tokens - cache_read_tokens - cache_write_tokens - request_count title: AiInferenceUsageGroup type: object AiInferenceUsageSeriesResponse: properties: buckets: items: $ref: '#/components/schemas/AiInferenceUsageBucket' title: Buckets type: array end_date: format: date title: End Date type: string granularity: $ref: '#/components/schemas/UsageGranularity' product: const: ai_inference default: ai_inference title: Product type: string start_date: format: date title: Start Date type: string required: - granularity - start_date - end_date - buckets title: AiInferenceUsageSeriesResponse type: object AiInferenceUsageSummaryResponse: properties: end_date: format: date title: End Date type: string groups: items: $ref: '#/components/schemas/AiInferenceUsageGroup' title: Groups type: array product: const: ai_inference default: ai_inference title: Product type: string start_date: format: date title: Start Date type: string required: - start_date - end_date - groups title: AiInferenceUsageSummaryResponse type: object AllocationMethodType: enum: - fcfs - auction - lottery title: AllocationMethodType type: string AllowedNumberOfNameserverBase: properties: max: description: Maximum number of nameserver per domain name title: Max type: integer min: description: Minimum number of nameserver per domain name minimum: 0.0 title: Min type: integer required: - min - max title: AllowedNumberOfNameserverBase type: object AssignablePublicRole: enum: - admin - viewer - domain_manager - dns_manager - billing_manager title: AssignablePublicRole type: string AttributeCondition: properties: field: $ref: '#/components/schemas/RegistryHandleAttributeType' description: The attribute key to evaluate operator: $ref: '#/components/schemas/ConditionOperator' description: The comparison operator value: anyOf: - type: string - items: type: string type: array description: The value(s) to compare against title: Value required: - field - operator - value title: AttributeCondition type: object AttributeType: enum: - enum - string - boolean - datetime - integer - country_code - uri_template title: AttributeType type: string Auth: description: 'Pre-login OAuth bootstrap. The SPA resolves this document by hostname before login and uses `client_id` (the org''s `wl-` Keycloak client) + `authority` (the OIDC issuer on the customer''s auth host) to start the flow; absent, it falls back to the default dashboard client. System-owned: written only by onboarding (via branding-service''s set-auth endpoint), never by a customer document write - branding-service preserves this block across customer upserts.' properties: authority: anyOf: - type: string - type: 'null' title: Authority client_id: anyOf: - pattern: ^[a-zA-Z0-9._-]{1,255}$ type: string - type: 'null' title: Client Id title: Auth type: object BatchSortField: enum: - created_on - started_at - finished_at title: BatchSortField type: string BatchStatus: enum: - pending - complete title: BatchStatus type: string BillingMetadata: properties: billing_model: anyOf: - type: string - type: 'null' description: Payment terms for the organization. title: Billing Model credit_limit: anyOf: - type: integer - type: 'null' description: Credit limit for the organization. title: Credit Limit customer_number: anyOf: - type: integer - type: 'null' description: Customer account number for the organization. title: Customer Number title: BillingMetadata type: object BillingMode: enum: - consolidated - independent title: BillingMode type: string BillingTransactionAction: enum: - create - transfer - import - renew - restore - trade - application - service_fee - upgrade_fee - wallet_top_up title: BillingTransactionAction type: string BillingTransactionProductType: enum: - domain - zones - email_forward - domain_forward - account_wallet - vanity_nameserver - whitelabel_branding - whitelabel_branding_plus - ras_domain_lifecycle - ams_domain_lifecycle title: BillingTransactionProductType type: string BillingTransactionResponse: properties: action: $ref: '#/components/schemas/BillingTransactionAction' description: The action performed in the transaction amount: description: The amount of the transaction including VAT pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$) title: Amount type: string billing_transaction_id: examples: - billing_transaction_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^billing_transaction_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Billing Transaction Id type: string x-typeid-prefix: billing_transaction completed_on: anyOf: - format: date-time type: string - type: 'null' description: The date/time the transaction completed title: Completed On created_on: description: The date/time the transaction was created format: date-time title: Created On type: string currency: $ref: '#/components/schemas/Currency' description: The currency of the transaction price: description: The price of the product without sales tax pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$) title: Price type: string product_reference: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The reference of the product title: Product Reference product_type: $ref: '#/components/schemas/BillingTransactionProductType' description: The type of product status: $ref: '#/components/schemas/BillingTransactionStatus' default: pending description: The status of the transaction tax_amount: description: The tax amount of the transaction pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$) title: Tax Amount type: string tax_rate: description: The tax rate of the transaction pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$) title: Tax Rate type: string unit: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The unit for `volume` (e.g. 'y' for years when renewing a domain); null when not applicable title: Unit updated_on: description: The date/time the transaction was updated format: date-time title: Updated On type: string volume: description: The quantity the transaction covers, expressed in `unit` (e.g. 1 for a one-year domain renewal) pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$) title: Volume type: string required: - product_type - product_reference - action - volume - amount - price - tax_rate - tax_amount title: BillingTransactionResponse type: object BillingTransactionSortField: enum: - product_type - action - status - created_on - completed_on title: BillingTransactionSortField type: string BillingTransactionStatus: enum: - pending - succeeded - failed - canceled title: BillingTransactionStatus type: string Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post: properties: file: contentMediaType: application/octet-stream description: Asset file (image/font) title: File type: string required: - file title: Body_upload_whitelabel_asset_v1_whitelabel_branding_assets_post type: object Brand: properties: logo: anyOf: - $ref: '#/components/schemas/Logo' - type: 'null' name: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' title: Name title: Brand type: object BrandingAsset: properties: asset_id: description: Opaque handle used to delete or reference the asset title: Asset Id type: string asset_url: description: Public URL of the asset title: Asset Url type: string content_type: anyOf: - type: string - type: 'null' description: MIME type of the asset title: Content Type size_bytes: description: Asset size in bytes title: Size Bytes type: integer updated_on: description: Last-modified timestamp format: date-time title: Updated On type: string required: - asset_id - asset_url - size_bytes - updated_on title: BrandingAsset type: object BrandingDocument: properties: auth: anyOf: - $ref: '#/components/schemas/Auth' - type: 'null' brand: anyOf: - $ref: '#/components/schemas/Brand' - type: 'null' content: anyOf: - $ref: '#/components/schemas/Content' - type: 'null' theme: anyOf: - $ref: '#/components/schemas/Theme' - type: 'null' version: default: 1 title: Version type: integer title: BrandingDocument type: object BrowserStatsBucket: properties: key: title: Key type: string total: title: Total type: integer unique: title: Unique type: integer required: - key - total - unique title: BrowserStatsBucket type: object BulkObjectTagChanges: properties: add: description: Tag IDs to add to the objects. items: examples: - tag_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: tag maxItems: 1000 title: Add type: array objects: description: Object references to operate on. TypeIDs and resource names may be mixed. items: description: A TypeID (e.g. domain_01h45ytscbebyvny4gc8cr8ma2) or a resource name (e.g. example.com) examples: - domain_01h45ytscbebyvny4gc8cr8ma2 - example.com type: string maxItems: 1000 minItems: 1 title: Objects type: array remove: description: Tag IDs to remove from the objects. items: examples: - tag_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: tag maxItems: 1000 title: Remove type: array replace: anyOf: - items: examples: - tag_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: tag maxItems: 1000 type: array - type: 'null' description: Tag IDs to set as the complete tag set for the objects, replacing any existing tags. Mutually exclusive with 'add' and 'remove'. An empty list removes all tags. title: Replace type: $ref: '#/components/schemas/TagType' description: The object/tag type (e.g. DOMAIN, CONTACT, ZONE) required: - type - objects title: BulkObjectTagChanges type: object ClaimsNotice: properties: claims: description: List of trademark claims items: $ref: '#/components/schemas/TmClaim' title: Claims type: array claims_key: description: The claims key used to retrieve this claims notice title: Claims Key type: string claims_notice_acceptance_hash: description: Hash to accept the claims notice title: Claims Notice Acceptance Hash type: string label: description: Domain name label covered by this claims notice title: Label type: string notice_footer: default: '' description: Claims notice form footer text title: Notice Footer type: string notice_footer_url: default: '' description: Claims notice form footer URL title: Notice Footer Url type: string notice_intro: default: '' description: Introductory text for the claims notice title: Notice Intro type: string notice_not_exact_match_intro: default: '' description: Introductory text for the non-exact match section title: Notice Not Exact Match Intro type: string notice_title: default: '' description: Title for the claims notice title: Notice Title type: string rendered_html: default: '' description: The rendered trademark claims notice HTML title: Rendered Html type: string required: - claims_key - claims_notice_acceptance_hash - label title: ClaimsNotice type: object ClaimsNoticesRequest: properties: claims_keys: description: List of claims keys to retrieve claims notices for, for the time being limited to one claims key items: type: string maxItems: 1 minItems: 1 title: Claims Keys type: array required: - claims_keys title: ClaimsNoticesRequest type: object ClaimsNoticesResponse: properties: claims_notices: items: $ref: '#/components/schemas/ClaimsNotice' title: Claims Notices type: array required: - claims_notices title: ClaimsNoticesResponse type: object ClearVanityNameserverSetDefaultRes: properties: cleared: description: True if an ACTIVE default was unset; False on an idempotent no-op (org had no default). title: Cleared type: boolean required: - cleared title: ClearVanityNameserverSetDefaultRes type: object CommandError: properties: code: anyOf: - type: string - type: 'null' description: Stable semantic error code for known failure modes (e.g. 'ERROR_BATCH_EMPTY'); null for ad-hoc failures. Matches the 'code' field in top-level error responses. title: Code error: description: Error message title: Error type: string index: description: Index of the failed command in the request title: Index type: integer instance_index: anyOf: - type: integer - type: 'null' description: Index within the bulk command's instances[] for per-instance failures title: Instance Index resource_key: anyOf: - type: string - type: 'null' description: Resource identifier (zone name, domain name, contact email) for per-instance failures title: Resource Key type: anyOf: - type: string - type: 'null' description: RFC 9457 problem type identifier derived from the exception class (e.g. 'value', 'batch-empty'). Matches the 'type' field in top-level error responses. title: Type required: - index - error title: CommandError type: object Communication: properties: timedelta: description: The Timedeltas of when to send a verification notice of the Communication Channel [+0D, +4D, +12D, +15D, +27D] items: type: string title: Timedelta type: array type: description: Which Communication channel is used for the Verification [email] title: Type type: string required: - type - timedelta title: Communication type: object ComplianceStatus: enum: - preparing - pending - approved - disapproved - expired title: ComplianceStatus type: string ConditionOperator: enum: - equals - not_equals - in - not_in title: ConditionOperator type: string ContactAttestReq: properties: attestations: items: $ref: '#/components/schemas/ContactAttestVerificationReq' maxItems: 50 minItems: 0 title: Attestations type: array required: - attestations title: ContactAttestReq type: object ContactAttestRes: properties: verifications: items: $ref: '#/components/schemas/ContactVerificationStatus' title: Verifications type: array required: - verifications title: ContactAttestRes type: object ContactAttestVerificationReq: properties: attestation_reference: maxLength: 255 minLength: 0 title: Attestation Reference type: string claim: $ref: '#/components/schemas/ContactVerificationClaim' eid: anyOf: - $ref: '#/components/schemas/ContactVerificationEidInformation' - type: 'null' method: $ref: '#/components/schemas/ContactVerificationMethod' proof: $ref: '#/components/schemas/ContactVerificationProof' required: - claim - method - proof - attestation_reference title: ContactAttestVerificationReq type: object ContactAttributeDefinition: description: Definition of a possible attribute for a TLD. properties: conditions: anyOf: - items: $ref: '#/components/schemas/AttributeCondition' type: array - type: 'null' description: Conditions that must ALL be true for this attribute to be active. None means always active. title: Conditions contact_roles: anyOf: - items: $ref: '#/components/schemas/DomainContactType' type: array - type: 'null' description: Contact roles this attribute applies to. None means all roles. title: Contact Roles key: $ref: '#/components/schemas/RegistryHandleAttributeType' description: Unique identifier for the attribute required: default: false description: Whether this attribute is required when its conditions are met title: Required type: boolean type: $ref: '#/components/schemas/AttributeType' description: Type of the attribute (e.g., 'enum', 'string', 'boolean') values: anyOf: - items: type: string type: array - type: 'null' description: Allowed values for enum types title: Values required: - key - type title: ContactAttributeDefinition type: object ContactAttributeLinkDetail: properties: attributes: additionalProperties: type: string description: The attributes from the linked set propertyNames: $ref: '#/components/schemas/RegistryHandleAttributeType' title: Attributes type: object contact_attribute_set_id: description: The attribute set linked to the contact examples: - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Attribute Set Id type: string x-typeid-prefix: contact_attribute_set label: description: The label of the linked attribute set title: Label type: string tld: description: The TLD this link applies to title: Tld type: string required: - contact_attribute_set_id - label - tld - attributes title: ContactAttributeLinkDetail type: object ContactAttributeLinkResponse: properties: contact_attribute_link_id: description: The unique identifier of the link examples: - contact_attribute_link_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_attribute_link_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Attribute Link Id type: string x-typeid-prefix: contact_attribute_link contact_attribute_set_id: description: The attribute set linked to the contact examples: - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Attribute Set Id type: string x-typeid-prefix: contact_attribute_set contact_id: description: The contact this link belongs to examples: - contact_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Id type: string x-typeid-prefix: contact created_on: description: The date/time the entry was created on format: date-time title: Created On type: string tld: description: The TLD this link applies to title: Tld type: string required: - contact_attribute_link_id - contact_id - contact_attribute_set_id - tld - created_on title: ContactAttributeLinkResponse type: object ContactAttributeSetCreate: properties: attributes: additionalProperties: type: string description: Key-value map of contact attributes for this set propertyNames: $ref: '#/components/schemas/RegistryHandleAttributeType' title: Attributes type: object label: description: A human-readable label explaining the purpose of this attribute set maxLength: 255 minLength: 1 title: Label type: string tld: description: The TLD this attribute set applies to (e.g. 'de', '.de', 'DE') title: Tld type: string required: - label - attributes - tld title: ContactAttributeSetCreate type: object ContactAttributeSetResponse: properties: attributes: additionalProperties: type: string description: Key-value map of contact attributes for this set propertyNames: $ref: '#/components/schemas/RegistryHandleAttributeType' title: Attributes type: object contact_attribute_set_id: description: The unique identifier of the attribute set examples: - contact_attribute_set_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_attribute_set_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Attribute Set Id type: string x-typeid-prefix: contact_attribute_set created_on: description: The date/time the entry was created on format: date-time title: Created On type: string label: description: A human-readable label explaining the purpose of this attribute set maxLength: 255 minLength: 1 title: Label type: string linked_contacts: default: 0 description: Number of contacts linked to this attribute set title: Linked Contacts type: integer organization_id: description: The organization that owns this attribute set examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization tld: description: The TLD this attribute set applies to title: Tld type: string updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string required: - label - attributes - contact_attribute_set_id - organization_id - tld - created_on - updated_on title: ContactAttributeSetResponse type: object ContactAttributeSetSortField: enum: - label - tld - created_on - updated_on title: ContactAttributeSetSortField type: string ContactAttributeSetUpdate: properties: label: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: A human-readable label explaining the purpose of this attribute set title: Label title: ContactAttributeSetUpdate type: object ContactConfigBase: properties: max: description: Maximum contacts per domain name minimum: 0.0 title: Max type: integer min: description: Minimum contacts per domain name minimum: 0.0 title: Min type: integer type: $ref: '#/components/schemas/DomainContactType' description: The type of contact required: - type - min - max title: ContactConfigBase type: object ContactCreate: properties: city: description: The city of the contact maxLength: 255 minLength: 1 title: City type: string country: description: The country of the contact (ISO 3166-1 alpha-2, plus XK for Kosovo) pattern: ^\w{2}$ title: Country type: string disclose: description: Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in. title: Disclose type: boolean email: description: Contact email address (as submitted) format: email title: Email type: string fax: anyOf: - format: phone type: string - type: 'null' description: The contacts's fax number title: Fax first_name: description: The first name of the contact maxLength: 255 minLength: 1 title: First Name type: string last_name: description: The last name of the contact maxLength: 255 minLength: 1 title: Last Name type: string org: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The organization of the contact title: Org phone: description: The contact's phone number examples: - '+1.2125552368' format: phone title: Phone type: string postal_code: description: The postal code of the contact maxLength: 255 minLength: 1 title: Postal Code type: string state: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The state of the contact title: State street: description: The address of the contact maxLength: 255 minLength: 1 title: Street type: string title: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The title of the contact title: Title required: - first_name - last_name - email - phone - street - city - postal_code - country - disclose title: ContactCreate type: object ContactCreateBulkCommand: properties: command: const: contact_create_bulk default: contact_create_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/ContactCreateBulkPayload' description: Bulk contact creation payload version: default: v1 description: Command version title: Version type: string required: - payload title: ContactCreateBulkCommand type: object ContactCreateBulkInstance: properties: city: description: City maxLength: 255 minLength: 1 title: City type: string country: anyOf: - pattern: ^\w{2}$ type: string - type: 'null' description: Override country for this contact title: Country disclose: anyOf: - type: boolean - type: 'null' description: Override disclose setting for this contact title: Disclose email: description: Email address of the contact format: email title: Email type: string fax: anyOf: - format: phone type: string - type: 'null' description: Fax number in international format title: Fax first_name: description: First name of the contact maxLength: 255 minLength: 1 title: First Name type: string last_name: description: Last name of the contact maxLength: 255 minLength: 1 title: Last Name type: string org: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Override organization for this contact title: Org phone: description: Phone number in international format format: phone title: Phone type: string postal_code: description: Postal code maxLength: 255 minLength: 1 title: Postal Code type: string state: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Override state for this contact title: State street: description: Street address maxLength: 255 minLength: 1 title: Street type: string title: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Override title for this contact title: Title required: - first_name - last_name - email - phone - street - city - postal_code title: ContactCreateBulkInstance type: object ContactCreateBulkPayload: properties: instances: description: List of contacts to create (1-1000) items: $ref: '#/components/schemas/ContactCreateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/ContactCreateBulkTemplate' description: Shared settings for all contacts required: - template - instances title: ContactCreateBulkPayload type: object ContactCreateBulkTemplate: properties: country: description: The country of the contacts (ISO 3166-1 alpha-2, plus XK for Kosovo) pattern: ^\w{2}$ title: Country type: string disclose: description: Whether contact details should be disclosed in WHOIS title: Disclose type: boolean org: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Organization name title: Org state: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: State/province title: State title: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Contact title title: Title required: - country - disclose title: ContactCreateBulkTemplate type: object ContactCreateCommand: properties: command: const: contact_create default: contact_create title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this command title: Idempotency Key payload: $ref: '#/components/schemas/ContactCreatePayloadData' description: Contact creation payload version: default: v1 description: Command version title: Version type: string required: - payload title: ContactCreateCommand type: object ContactCreatePayloadData: properties: city: description: The city of the contact maxLength: 255 minLength: 1 title: City type: string country: description: The country of the contact (ISO 3166-1 alpha-2, plus XK for Kosovo) pattern: ^\w{2}$ title: Country type: string disclose: description: Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in. title: Disclose type: boolean email: description: Contact email address (as submitted) format: email title: Email type: string fax: anyOf: - format: phone type: string - type: 'null' description: The contacts's fax number title: Fax first_name: description: The first name of the contact maxLength: 255 minLength: 1 title: First Name type: string last_name: description: The last name of the contact maxLength: 255 minLength: 1 title: Last Name type: string org: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The organization of the contact title: Org phone: description: The contact's phone number examples: - '+1.2125552368' format: phone title: Phone type: string postal_code: description: The postal code of the contact maxLength: 255 minLength: 1 title: Postal Code type: string state: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The state of the contact title: State street: description: The address of the contact maxLength: 255 minLength: 1 title: Street type: string title: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The title of the contact title: Title required: - first_name - last_name - email - phone - street - city - postal_code - country - disclose title: ContactCreatePayloadData type: object ContactCreateWorkerPayload: properties: contact: $ref: '#/components/schemas/ContactCreatePayloadData' operation: title: Operation type: string type: enum: - contact_create - contact_create_bulk title: Type type: string required: - type - operation - contact title: ContactCreateWorkerPayload type: object ContactCreateWorkerResult: properties: contact_id: title: Contact Id type: string type: enum: - contact_create - contact_create_bulk title: Type type: string required: - type - contact_id title: ContactCreateWorkerResult type: object ContactHandle: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/RegistryHandleAttributeType' type: object - type: 'null' description: Additional attributes related to the contact title: Attributes contact_id: description: The contact id of the contact examples: - contact_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Id type: string x-typeid-prefix: contact required: - contact_id title: ContactHandle type: object ContactIdList: additionalProperties: examples: - contact_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: contact description: The contacts of the domain propertyNames: $ref: '#/components/schemas/DomainContactType' type: object ContactIncludeField: enum: - tags title: ContactIncludeField type: string ContactResponse: properties: attribute_sets: description: Linked attribute sets for this contact items: $ref: '#/components/schemas/ContactAttributeLinkDetail' title: Attribute Sets type: array city: description: The city of the contact maxLength: 255 minLength: 1 title: City type: string contact_id: examples: - contact_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Id type: string x-typeid-prefix: contact country: description: The country of the contact (ISO 3166-1 alpha-2, plus XK for Kosovo) pattern: ^\w{2}$ title: Country type: string created_on: description: The date/time the entry was created on format: date-time title: Created On type: string disclose: description: Whether the contact details should be disclosed. The Disclose function may not work with all TLDs. Some registries still display the data in Whois if, for example, the organization field is filled in. title: Disclose type: boolean email: description: Contact email address (as submitted) format: email title: Email type: string fax: anyOf: - format: phone type: string - type: 'null' description: The contacts's fax number title: Fax first_name: description: The first name of the contact maxLength: 255 minLength: 1 title: First Name type: string last_name: description: The last name of the contact maxLength: 255 minLength: 1 title: Last Name type: string org: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The organization of the contact title: Org organization_id: default: None description: The organization that owns the domain examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization phone: description: The contact's phone number examples: - '+1.2125552368' format: phone title: Phone type: string postal_code: description: The postal code of the contact maxLength: 255 minLength: 1 title: Postal Code type: string state: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The state of the contact title: State status_tags: anyOf: - items: $ref: '#/components/schemas/StatusTagResponse' type: array - type: 'null' description: Status tags assigned to this contact. Only included when ?include=tags is specified. title: Status Tags street: description: The address of the contact maxLength: 255 minLength: 1 title: Street type: string tags: anyOf: - items: $ref: '#/components/schemas/TagEnrichedResponse' type: array - type: 'null' description: Tags assigned to this contact title: Tags title: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The title of the contact title: Title required: - first_name - last_name - email - phone - street - city - postal_code - country - disclose title: ContactResponse type: object ContactSortField: enum: - first_name - last_name - email - created_on title: ContactSortField type: string ContactType: enum: - owner - agent - third party title: ContactType type: string ContactVerificationApiResponse: properties: canceled_on: anyOf: - format: date-time type: string - type: 'null' description: The date the verification was cancelled title: Canceled On contact_id: default: None description: The contact that is being verified examples: - contact_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Id type: string x-typeid-prefix: contact contact_verification_id: examples: - contact_verification_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Verification Id type: string x-typeid-prefix: contact_verification created_on: description: The date/time the entry was created on format: date-time title: Created On type: string status: $ref: '#/components/schemas/EmailVerificationStatus' default: pending description: Current status of the email verification token: description: The token to verify the email address maxLength: 256 minLength: 35 title: Token type: string type: $ref: '#/components/schemas/VerificationType' description: 'The type of verification: ''api'' for retrieving token via API, ''email'' for retrieving via email' updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string verified_on: anyOf: - format: date-time type: string - type: 'null' description: The date the verification was verified title: Verified On required: - token - type title: ContactVerificationApiResponse type: object ContactVerificationClaim: enum: - NAME - ADDRESS - EMAIL - PHONE - LEGAL_ENTITY title: ContactVerificationClaim type: string ContactVerificationEidInformation: properties: eid_scheme: title: Eid Scheme type: string level_of_assurance: $ref: '#/components/schemas/LevelOfAssurance' required: - eid_scheme - level_of_assurance title: ContactVerificationEidInformation type: object ContactVerificationEmailResponse: properties: canceled_on: anyOf: - format: date-time type: string - type: 'null' description: The date the verification was cancelled title: Canceled On contact_id: default: None description: The contact that is being verified examples: - contact_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Id type: string x-typeid-prefix: contact contact_verification_id: examples: - contact_verification_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Verification Id type: string x-typeid-prefix: contact_verification created_on: description: The date/time the entry was created on format: date-time title: Created On type: string status: $ref: '#/components/schemas/EmailVerificationStatus' default: pending description: Current status of the email verification type: $ref: '#/components/schemas/VerificationType' description: 'The type of verification: ''api'' for retrieving token via API, ''email'' for retrieving via email' updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string verified_on: anyOf: - format: date-time type: string - type: 'null' description: The date the verification was verified title: Verified On required: - type title: ContactVerificationEmailResponse type: object ContactVerificationMethod: enum: - AUTH - VDIG - ELECTRONIC_DOCUMENT - PHYSICAL_DOCUMENT - BVR - PVR - DATA - REACHABILITY title: ContactVerificationMethod type: string ContactVerificationProof: enum: - IDCARD - PASSPORT - POPULATION_REGISTER - RESIDENCE_PERMIT - PROOF_OF_ARRIVAL - DRIVERS_LICENCE - COMPANY_REGISTER - COMPANY_STATEMENT - BANK_ACCOUNT - ONLINE_PAYMENT_ACCOUNT - UTILITY_ACCOUNT - BANK_STATEMENT - TAX_STATEMENT - WRITTEN_ATTESTATION - DIGITAL_ATTESTATION - POSTAL_VER_TRANSACTION_LOG - EMAIL_VER_TRANSACTION_LOG - PHONE_VER_TRANSACTION_LOG - ADDRESS_DATABASE title: ContactVerificationProof type: string ContactVerificationResponse: properties: canceled_on: anyOf: - format: date-time type: string - type: 'null' description: The date the verification was cancelled title: Canceled On contact_id: default: None description: The contact that is being verified examples: - contact_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Id type: string x-typeid-prefix: contact contact_verification_id: examples: - contact_verification_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_verification_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Verification Id type: string x-typeid-prefix: contact_verification created_on: description: The date/time the entry was created on format: date-time title: Created On type: string status: $ref: '#/components/schemas/EmailVerificationStatus' default: pending description: Current status of the email verification type: $ref: '#/components/schemas/VerificationType' description: 'The type of verification: ''api'' for retrieving token via API, ''email'' for retrieving via email' updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string verified_on: anyOf: - format: date-time type: string - type: 'null' description: The date the verification was verified title: Verified On required: - type title: ContactVerificationResponse type: object ContactVerificationState: enum: - UNVERIFIED - VERIFIED - IN_PROGRESS - EXPIRED title: ContactVerificationState type: string ContactVerificationStatus: properties: attestation_reference: anyOf: - type: string - type: 'null' title: Attestation Reference claim: $ref: '#/components/schemas/ContactVerificationClaim' eid: anyOf: - $ref: '#/components/schemas/ContactVerificationEidInformation' - type: 'null' expires_on: anyOf: - format: date-time type: string - type: 'null' title: Expires On method: anyOf: - $ref: '#/components/schemas/ContactVerificationMethod' - type: 'null' proof: anyOf: - $ref: '#/components/schemas/ContactVerificationProof' - type: 'null' state: $ref: '#/components/schemas/ContactVerificationState' verified_on: anyOf: - format: date-time type: string - type: 'null' title: Verified On required: - claim - state title: ContactVerificationStatus type: object ContactsBase: properties: authinfo_required: anyOf: - type: boolean - type: 'null' description: Whether the registry requires authinfo for contact creation title: Authinfo Required authinfo_supported: default: true description: Whether the registry supports authinfo for contact creation title: Authinfo Supported type: boolean is_thick: anyOf: - type: boolean - type: 'null' description: Whether the registry supports thick contacts title: Is Thick possible_attributes: description: List of possible attributes that can be set for this TLD items: $ref: '#/components/schemas/ContactAttributeDefinition' title: Possible Attributes type: array privacy_proxy: anyOf: - type: boolean - type: 'null' description: Whether a privacy service is allowed title: Privacy Proxy registrant_change: anyOf: - $ref: '#/components/schemas/RegistrantChangeType' - type: 'null' description: Whether the registrant can change through update or trade support_check: anyOf: - type: boolean - type: 'null' description: Whether the registry supports contact checks title: Support Check support_client_contact_id: anyOf: - type: boolean - type: 'null' description: Whether the registry supports client defined contact ID title: Support Client Contact Id support_transfer: anyOf: - type: boolean - type: 'null' description: Whether the registry supports contact transfer title: Support Transfer supported_postal_types: anyOf: - items: $ref: '#/components/schemas/PostalAddressType' type: array - type: 'null' description: Supported postal address types title: Supported Postal Types supported_roles: anyOf: - items: $ref: '#/components/schemas/ContactConfigBase' type: array - type: 'null' description: Supported contact roles title: Supported Roles transfer_supported_roles: anyOf: - items: $ref: '#/components/schemas/ContactConfigBase' type: array - type: 'null' description: Supported contact roles for transfer operations. Falls back to supported_roles if not specified. title: Transfer Supported Roles update_supported_roles: anyOf: - items: $ref: '#/components/schemas/ContactConfigBase' type: array - type: 'null' description: Supported contact roles for update operations. Falls back to supported_roles if not specified. title: Update Supported Roles title: ContactsBase type: object ContactsContext: properties: context_id: examples: - ctx_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Context Id type: string x-typeid-prefix: ctx conversation_id: examples: - conv_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Conversation Id type: string x-typeid-prefix: conv created_at: format: date-time title: Created At type: string kind: const: contacts default: contacts title: Kind type: string organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization payload: $ref: '#/components/schemas/ContextPayload_RegistrarContact_' user_id: title: User Id type: string required: - context_id - conversation_id - organization_id - user_id - created_at - payload title: ContactsContext type: object ContactsContextCreate: properties: kind: const: contacts default: contacts title: Kind type: string payload: $ref: '#/components/schemas/ContextPayload_RegistrarContact_' required: - payload title: ContactsContextCreate type: object Content: properties: email_blocks: anyOf: - patternProperties: ^[a-z0-9_]+$: patternProperties: ^[a-z0-9_]+$: patternProperties: ^[a-z]{2}(-[a-z]{2})?$: maxLength: 2000 type: string type: object type: object type: object - type: 'null' title: Email Blocks footer: anyOf: - $ref: '#/components/schemas/Footer' - type: 'null' legal: anyOf: - $ref: '#/components/schemas/Legal' - type: 'null' signature: anyOf: - type: string - type: 'null' title: Signature support: anyOf: - $ref: '#/components/schemas/Support' - type: 'null' title: Content type: object ContextListResponse: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: discriminator: mapping: aggregations: '#/components/schemas/AggregationsContext' contacts: '#/components/schemas/ContactsContext' domain_forwards: '#/components/schemas/DomainForwardsContext' domain_recommendations: '#/components/schemas/DomainRecommendationsContext' domains: '#/components/schemas/DomainsContext' email_forwards: '#/components/schemas/EmailForwardsContext' zones: '#/components/schemas/ZonesContext' propertyName: kind oneOf: - $ref: '#/components/schemas/ZonesContext' - $ref: '#/components/schemas/ContactsContext' - $ref: '#/components/schemas/DomainsContext' - $ref: '#/components/schemas/DomainForwardsContext' - $ref: '#/components/schemas/EmailForwardsContext' - $ref: '#/components/schemas/DomainRecommendationsContext' - $ref: '#/components/schemas/AggregationsContext' title: Results type: array required: - results - pagination title: ContextListResponse type: object ContextMeta: properties: processing_time_ms: anyOf: - type: integer - type: 'null' title: Processing Time Ms total: anyOf: - type: integer - type: 'null' title: Total title: ContextMeta type: object ContextPayload_DomainForward_: properties: meta: anyOf: - $ref: '#/components/schemas/ContextMeta' - type: 'null' pagination: anyOf: - $ref: '#/components/schemas/PaginationMetadata' - type: 'null' results: items: $ref: '#/components/schemas/DomainForward' title: Results type: array required: - results title: ContextPayload[DomainForward] type: object ContextPayload_DomainSearchSuggestionWithPrice_: properties: meta: anyOf: - $ref: '#/components/schemas/ContextMeta' - type: 'null' pagination: anyOf: - $ref: '#/components/schemas/PaginationMetadata' - type: 'null' results: items: $ref: '#/components/schemas/DomainSearchSuggestionWithPrice' title: Results type: array required: - results title: ContextPayload[DomainSearchSuggestionWithPrice] type: object ContextPayload_EmailForwardResponse_: properties: meta: anyOf: - $ref: '#/components/schemas/ContextMeta' - type: 'null' pagination: anyOf: - $ref: '#/components/schemas/PaginationMetadata' - type: 'null' results: items: $ref: '#/components/schemas/EmailForwardResponse' title: Results type: array required: - results title: ContextPayload[EmailForwardResponse] type: object ContextPayload_RegistrarContact_: properties: meta: anyOf: - $ref: '#/components/schemas/ContextMeta' - type: 'null' pagination: anyOf: - $ref: '#/components/schemas/PaginationMetadata' - type: 'null' results: items: $ref: '#/components/schemas/RegistrarContact' title: Results type: array required: - results title: ContextPayload[RegistrarContact] type: object ContextPayload_RegistrarDomain_: properties: meta: anyOf: - $ref: '#/components/schemas/ContextMeta' - type: 'null' pagination: anyOf: - $ref: '#/components/schemas/PaginationMetadata' - type: 'null' results: items: $ref: '#/components/schemas/RegistrarDomain' title: Results type: array required: - results title: ContextPayload[RegistrarDomain] type: object ContextPayload_RegistrarZone_: properties: meta: anyOf: - $ref: '#/components/schemas/ContextMeta' - type: 'null' pagination: anyOf: - $ref: '#/components/schemas/PaginationMetadata' - type: 'null' results: items: $ref: '#/components/schemas/RegistrarZone' title: Results type: array required: - results title: ContextPayload[RegistrarZone] type: object Conversation: properties: conversation_id: examples: - conv_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Conversation Id type: string x-typeid-prefix: conv created_at: format: date-time title: Created At type: string last_message_at: anyOf: - format: date-time type: string - type: 'null' title: Last Message At message_count: default: 0 title: Message Count type: integer metadata: additionalProperties: true title: Metadata type: object organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization summary: anyOf: - type: string - type: 'null' description: Optional rolling summary maintained by the memory service. title: Summary title: anyOf: - type: string - type: 'null' description: Human-readable conversation title. title: Title updated_at: format: date-time title: Updated At type: string user_id: title: User Id type: string required: - conversation_id - organization_id - user_id - created_at - updated_at title: Conversation type: object ConversationCreateRequest: properties: metadata: additionalProperties: true title: Metadata type: object title: anyOf: - maxLength: 200 type: string - type: 'null' title: Title title: ConversationCreateRequest type: object ConversationListResponse: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/Conversation' title: Results type: array required: - results - pagination title: ConversationListResponse type: object ConversationPatchRequest: properties: metadata: anyOf: - additionalProperties: true type: object - type: 'null' title: Metadata title: anyOf: - maxLength: 200 type: string - type: 'null' title: Title title: ConversationPatchRequest type: object CreateJobBatchResponse: properties: batch_id: description: TypeID identifying this batch examples: - batch_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Batch Id type: string x-typeid-prefix: batch duplicates: description: Per-command details for duplicates, including pointers to the existing jobs/batches items: $ref: '#/components/schemas/DuplicateCommand' title: Duplicates type: array errors: description: Details of failed commands items: $ref: '#/components/schemas/CommandError' title: Errors type: array jobs_created: description: Number of jobs successfully created title: Jobs Created type: integer jobs_duplicated: default: 0 description: Number of commands skipped because their idempotency_key matched a previously-submitted job title: Jobs Duplicated type: integer jobs_failed: description: Number of jobs that failed to create title: Jobs Failed type: integer status_url: description: "URL to check batch status. May 404 if jobs_created is 0 \u2014\ \ see duplicates[].existing_batch_id for prior batches." title: Status Url type: string total_commands: description: Total commands in the batch title: Total Commands type: integer required: - batch_id - jobs_created - jobs_failed - total_commands - status_url title: CreateJobBatchResponse type: object CreateReportReq: properties: registrar_credential_id: anyOf: - examples: - registrar_credential_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^registrar_credential_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: registrar_credential - type: 'null' title: Registrar Credential Id report_type: $ref: '#/components/schemas/ReportType' default: domain_inventory title: CreateReportReq type: object Currency: enum: - USD - EUR title: Currency type: string CustomRoleCreate: description: Request body for creating a custom role. properties: description: anyOf: - type: string - type: 'null' description: Description of the custom role. title: Description name: description: Display name of the custom role as provided by the user (e.g. 'Support Staff'). maxLength: 64 minLength: 1 title: Name type: string permissions: description: Permissions the role grants, as `resource:scope` (e.g. `domains:read`). The escalation-bearing admin/owner permissions cannot be granted. items: $ref: '#/components/schemas/PublicPermission' title: Permissions type: array required: - name - permissions title: CustomRoleCreate type: object CustomRoleLabel: type: string CustomRoleUpdate: description: 'Request body for updating a custom role. Omitted fields are left unchanged; `permissions` is a full replacement set when provided.' properties: description: anyOf: - type: string - type: 'null' description: New description. title: Description name: anyOf: - maxLength: 64 minLength: 1 type: string - type: 'null' description: New display name. title: Name permissions: anyOf: - items: $ref: '#/components/schemas/PublicPermission' type: array - type: 'null' description: Full replacement set of `resource:scope` permissions the role grants. title: Permissions title: CustomRoleUpdate type: object DeletePolicyType: enum: - immediate - expiration title: DeletePolicyType type: string DnsChangeAction: enum: - create_zone - delete_zone - create_record - delete_record - enable_dnssec - disable_dnssec title: DnsChangeAction type: string DnsChangeResponse: properties: action: $ref: '#/components/schemas/DnsChangeAction' record_data: anyOf: - type: string - type: 'null' title: Record Data rrset_name: anyOf: - type: string - type: 'null' title: Rrset Name rrset_type: anyOf: - $ref: '#/components/schemas/DnsRrsetType' - type: 'null' ttl: anyOf: - type: integer - type: 'null' title: Ttl required: - action - rrset_name - rrset_type - record_data - ttl title: DnsChangeResponse type: object DnsChangesResponse: properties: changes: items: $ref: '#/components/schemas/DnsChangeResponse' title: Changes type: array changeset_id: anyOf: - format: uuid type: string - type: 'null' title: Changeset Id dnssec_registry_publish: anyOf: - $ref: '#/components/schemas/DnssecRegistryPublishOutcome' - type: 'null' num_changes: title: Num Changes type: integer zone_name: title: Zone Name type: string required: - zone_name - changeset_id - num_changes - changes title: DnsChangesResponse type: object DnsConfigurationBase: properties: allowed_number_of_nameserver: $ref: '#/components/schemas/AllowedNumberOfNameserverBase' czds_available: anyOf: - type: boolean - type: 'null' description: Whether the zone is available in CZDS title: Czds Available dnssec_allowed: description: Whether the registry supports DNSSEC title: Dnssec Allowed type: boolean dnssec_mandatory: anyOf: - type: boolean - type: 'null' description: Whether DNSSEC is mandatory for a domain name title: Dnssec Mandatory dnssec_mode: anyOf: - $ref: '#/components/schemas/DnssecModeType' - type: 'null' description: DNSSEC mode dnssec_submit_digest_types: anyOf: - items: type: integer minItems: 1 type: array - type: 'null' description: 'Which DS digest types we submit to the registry for zones we host, in order of preference: the first listed type the zone has a DS record for is submitted, later entries are fallbacks. Absent means submit every digest type the zone publishes. This is our submission policy, not the set of digest types the registry accepts.' title: Dnssec Submit Digest Types host_objects: description: Whether the registry supports host objects or use attributes title: Host Objects type: boolean host_parent_check_tlds: anyOf: - items: type: string type: array - type: 'null' description: TLDs that require parent-host checks (ns1.example.com => example.com) title: Host Parent Check Tlds registry_nameserver_check: description: Whether the registry checks the nameserver configuration title: Registry Nameserver Check type: boolean registry_root_nameserver_update: description: Number of hours until the root zone is updated, 0 = real-time minimum: 0.0 title: Registry Root Nameserver Update type: integer required: - allowed_number_of_nameserver - registry_nameserver_check - dnssec_allowed - registry_root_nameserver_update - host_objects title: DnsConfigurationBase type: object DnsProtectedReason: enum: - SYSTEM_MANAGED_SOA - SYSTEM_MANAGED_NS - EMAIL_FORWARD - DOMAIN_FORWARD - WHITELABEL - GENERIC title: DnsProtectedReason type: string DnsRecordCreate: properties: rdata: title: Rdata type: string required: - rdata title: DnsRecordCreate type: object DnsRecordDTO: properties: rdata: description: The record data (e.g., IP address, domain name) title: Rdata type: string required: - rdata title: DnsRecordDTO type: object DnsRecordPatchOp: properties: op: $ref: '#/components/schemas/PatchOp' record: $ref: '#/components/schemas/DnsRrsetWithOneRecordPatch' required: - op - record title: DnsRecordPatchOp type: object DnsRecordResponse: properties: protected: default: false description: Whether the record is protected title: Protected type: boolean protected_reason: anyOf: - $ref: '#/components/schemas/DnsProtectedReason' - type: 'null' description: Reason why the record is protected rdata: title: Rdata type: string required: - rdata title: DnsRecordResponse type: object DnsRrsetCreate: properties: name: title: Name type: string records: items: $ref: '#/components/schemas/DnsRecordCreate' title: Records type: array ttl: title: Ttl type: integer type: $ref: '#/components/schemas/DnsRrsetType' required: - name - type - ttl - records title: DnsRrsetCreate type: object DnsRrsetDTO: properties: name: description: The RRset name (e.g., '@', 'www') title: Name type: string records: description: List of records in this RRset items: $ref: '#/components/schemas/DnsRecordDTO' title: Records type: array ttl: description: Time to live in seconds title: Ttl type: integer type: $ref: '#/components/schemas/DnsRrsetType' description: The RRset type required: - name - type - ttl title: DnsRrsetDTO type: object DnsRrsetPatch: properties: name: title: Name type: string records: items: $ref: '#/components/schemas/DnsRecordCreate' title: Records type: array ttl: title: Ttl type: integer type: $ref: '#/components/schemas/DnsRrsetType' required: - name - type - ttl - records title: DnsRrsetPatch type: object DnsRrsetPatchOp: properties: op: $ref: '#/components/schemas/PatchOp' rrset: $ref: '#/components/schemas/DnsRrsetPatch' required: - op - rrset title: DnsRrsetPatchOp type: object DnsRrsetResponse: properties: name: title: Name type: string protected: default: false description: Whether the RRset is protected title: Protected type: boolean protected_reason: anyOf: - $ref: '#/components/schemas/DnsProtectedReason' - type: 'null' description: Reason why the RRset is protected records: items: $ref: '#/components/schemas/DnsRecordResponse' title: Records type: array ttl: title: Ttl type: integer type: $ref: '#/components/schemas/DnsRrsetType' required: - name - type - ttl title: DnsRrsetResponse type: object DnsRrsetType: enum: - A - AAAA - ALIAS - CAA - CNAME - DNSKEY - DS - MX - NS - PTR - TXT - SOA - SRV - TLSA - SMIMEA - URI - HTTPS - SVCB - NAPTR - SSHFP - CERT title: DnsRrsetType type: string DnsRrsetWithOneRecordPatch: properties: name: title: Name type: string rdata: title: Rdata type: string ttl: title: Ttl type: integer type: $ref: '#/components/schemas/DnsRrsetType' required: - rdata - name - type - ttl title: DnsRrsetWithOneRecordPatch type: object DnsZoneCreate: properties: dnssec_status: $ref: '#/components/schemas/DnssecStatus' default: disabled name: title: Name type: string rrsets: items: $ref: '#/components/schemas/DnsRrsetCreate' title: Rrsets type: array vanity_nameserver_set_id: anyOf: - examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: vns - type: 'null' description: Optional vanity NS set to brand this zone's apex NS + SOA with. When omitted, the org's default ACTIVE set (if any) is used; when no default exists the system default NS is used. title: Vanity Nameserver Set Id required: - name title: DnsZoneCreate type: object DnsZoneCreateBulkCommand: properties: command: const: dns_zone_create_bulk default: dns_zone_create_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DnsZoneCreateBulkPayload' description: Bulk DNS zone creation payload version: default: v1 description: Command version title: Version type: string required: - payload title: DnsZoneCreateBulkCommand type: object DnsZoneCreateBulkInstance: properties: dnssec_status: anyOf: - $ref: '#/components/schemas/DnssecStatus' - type: 'null' description: Override DNSSEC status for this zone name: description: The DNS zone name (e.g., example.com) title: Name type: string rrsets: anyOf: - items: $ref: '#/components/schemas/DnsRrsetCreate' type: array - type: 'null' description: Override RRsets for this zone title: Rrsets required: - name title: DnsZoneCreateBulkInstance type: object DnsZoneCreateBulkPayload: properties: instances: description: List of zones to create (1-1000) items: $ref: '#/components/schemas/DnsZoneCreateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/DnsZoneCreateBulkTemplate' description: Shared RRsets for all zones required: - template - instances title: DnsZoneCreateBulkPayload type: object DnsZoneCreateBulkTemplate: properties: dnssec_status: $ref: '#/components/schemas/DnssecStatus' default: disabled description: DNSSEC status for all zones rrsets: description: DNS record sets to create items: $ref: '#/components/schemas/DnsRrsetCreate' title: Rrsets type: array title: DnsZoneCreateBulkTemplate type: object DnsZoneCreateCommand: properties: command: const: dns_zone_create default: dns_zone_create title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this command title: Idempotency Key payload: $ref: '#/components/schemas/DnsZoneCreatePayloadData' description: DNS zone creation payload version: default: v1 description: Command version title: Version type: string required: - payload title: DnsZoneCreateCommand type: object DnsZoneCreatePayloadData: properties: dnssec_status: $ref: '#/components/schemas/DnssecStatus' default: disabled name: title: Name type: string rrsets: items: $ref: '#/components/schemas/DnsRrsetCreate' title: Rrsets type: array vanity_nameserver_set_id: anyOf: - examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: vns - type: 'null' description: Optional vanity NS set to brand this zone's apex NS + SOA with. When omitted, the org's default ACTIVE set (if any) is used; when no default exists the system default NS is used. title: Vanity Nameserver Set Id required: - name title: DnsZoneCreatePayloadData type: object DnsZoneCreateWorkerPayload: properties: operation: title: Operation type: string type: enum: - dns_zone_create - dns_zone_create_bulk title: Type type: string zone: $ref: '#/components/schemas/DnsZoneCreatePayloadData' required: - type - operation - zone title: DnsZoneCreateWorkerPayload type: object DnsZoneCreateWorkerResult: properties: type: enum: - dns_zone_create - dns_zone_create_bulk title: Type type: string zone_name: title: Zone Name type: string required: - type - zone_name title: DnsZoneCreateWorkerResult type: object DnsZoneDTO: properties: created_on: anyOf: - format: date-time type: string - type: 'null' description: Zone creation timestamp title: Created On dnssec_status: $ref: '#/components/schemas/DnssecStatus' default: disabled description: DNSSEC status name: description: The zone name (e.g., 'example.com') title: Name type: string rrsets: description: List of RRsets in the zone items: $ref: '#/components/schemas/DnsRrsetDTO' title: Rrsets type: array updated_on: anyOf: - format: date-time type: string - type: 'null' description: Zone last update timestamp title: Updated On vanity_nameserver_set_id: anyOf: - examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: vns - type: 'null' description: Vanity NS set branding this zone's apex, or null for system default NS title: Vanity Nameserver Set Id required: - name title: DnsZoneDTO type: object DnsZonePatchRecordsBulkCommand: properties: command: const: dns_zone_patch_records_bulk default: dns_zone_patch_records_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this command title: Idempotency Key payload: $ref: '#/components/schemas/DnsZonePatchRecordsBulkPayload' description: DNS zone patch records bulk payload version: default: v1 description: Command version title: Version type: string required: - payload title: DnsZonePatchRecordsBulkCommand type: object DnsZonePatchRecordsBulkInstance: properties: ops: items: $ref: '#/components/schemas/DnsRecordPatchOp' maxItems: 100 minItems: 1 title: Ops type: array zone_name: description: DNS zone name to patch title: Zone Name type: string required: - zone_name - ops title: DnsZonePatchRecordsBulkInstance type: object DnsZonePatchRecordsBulkPayload: properties: instances: items: $ref: '#/components/schemas/DnsZonePatchRecordsBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: DnsZonePatchRecordsBulkPayload type: object DnsZonePatchRecordsWorkerPayload: properties: operation: title: Operation type: string type: const: dns_zone_patch_records_bulk title: Type type: string zone: $ref: '#/components/schemas/DnsZonePatchRecordsBulkInstance' required: - type - operation - zone title: DnsZonePatchRecordsWorkerPayload type: object DnsZonePatchRrsetsBulkCommand: properties: command: const: dns_zone_patch_rrsets_bulk default: dns_zone_patch_rrsets_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this command title: Idempotency Key payload: $ref: '#/components/schemas/DnsZonePatchRrsetsBulkPayload' description: DNS zone patch rrsets bulk payload version: default: v1 description: Command version title: Version type: string required: - payload title: DnsZonePatchRrsetsBulkCommand type: object DnsZonePatchRrsetsBulkInstance: properties: ops: items: $ref: '#/components/schemas/DnsRrsetPatchOp' maxItems: 100 minItems: 1 title: Ops type: array zone_name: description: DNS zone name to patch title: Zone Name type: string required: - zone_name - ops title: DnsZonePatchRrsetsBulkInstance type: object DnsZonePatchRrsetsBulkPayload: properties: instances: items: $ref: '#/components/schemas/DnsZonePatchRrsetsBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: DnsZonePatchRrsetsBulkPayload type: object DnsZonePatchRrsetsWorkerPayload: properties: operation: title: Operation type: string type: const: dns_zone_patch_rrsets_bulk title: Type type: string zone: $ref: '#/components/schemas/DnsZonePatchRrsetsBulkInstance' required: - type - operation - zone title: DnsZonePatchRrsetsWorkerPayload type: object DnsZoneRecordsPatchOps: properties: ops: items: $ref: '#/components/schemas/DnsRecordPatchOp' title: Ops type: array required: - ops title: DnsZoneRecordsPatchOps type: object DnsZoneResponse: properties: created_on: description: The date/time the entry was created on format: date-time title: Created On type: string dns_zone_id: description: The unique identifier of the zone examples: - zone_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^zone_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Dns Zone Id type: string x-typeid-prefix: zone dnssec_status: $ref: '#/components/schemas/DnssecStatus' default: disabled domain_parts: $ref: '#/components/schemas/DomainNameParts' name: title: Name type: string rrsets: items: $ref: '#/components/schemas/DnsRrsetResponse' title: Rrsets type: array tags: anyOf: - items: $ref: '#/components/schemas/TagEnrichedResponse' type: array - type: 'null' description: Tags assigned to this zone. Only included when ?include=tags is specified. title: Tags updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string vanity_nameserver_set_id: anyOf: - examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: vns - type: 'null' description: Vanity NS set whose apex NS + SOA brand this zone, or null when the zone uses the system default nameservers. title: Vanity Nameserver Set Id required: - name - dns_zone_id title: DnsZoneResponse type: object DnsZoneRestampVanityNsBulkCommand: properties: command: const: dns_zone_restamp_vanity_ns_bulk default: dns_zone_restamp_vanity_ns_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DnsZoneRestampVanityNsBulkPayload' description: Bulk DNS zone vanity NS restamp payload version: default: v1 description: Command version title: Version type: string required: - payload title: DnsZoneRestampVanityNsBulkCommand type: object DnsZoneRestampVanityNsBulkInstance: properties: name: description: The DNS zone name to restamp (e.g., example.com) title: Name type: string vanity_nameserver_set_id: anyOf: - examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: vns - type: 'null' description: 'Override the template''s set for this zone: a set id to brand with, or null to unbrand this zone to system defaults. Omit the field entirely to inherit the template''s value.' title: Vanity Nameserver Set Id required: - name title: DnsZoneRestampVanityNsBulkInstance type: object DnsZoneRestampVanityNsBulkPayload: properties: instances: description: List of zones to restamp (1-1000) items: $ref: '#/components/schemas/DnsZoneRestampVanityNsBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/DnsZoneRestampVanityNsBulkTemplate' description: Shared vanity NS set for all zones required: - template - instances title: DnsZoneRestampVanityNsBulkPayload type: object DnsZoneRestampVanityNsBulkTemplate: properties: vanity_nameserver_set_id: anyOf: - examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: vns - type: 'null' description: Vanity NS set to restamp every zone's apex NS + SOA with, or null to unbrand all zones back to OpusDNS system default nameservers. An instance may override this. title: Vanity Nameserver Set Id title: DnsZoneRestampVanityNsBulkTemplate type: object DnsZoneRestampVanityNsWorkerPayload: properties: operation: title: Operation type: string type: const: dns_zone_restamp_vanity_ns_bulk title: Type type: string zone: $ref: '#/components/schemas/DnsZoneRestampVanityNsBulkInstance' required: - type - operation - zone title: DnsZoneRestampVanityNsWorkerPayload type: object DnsZoneRrsetsCreate: properties: rrsets: items: $ref: '#/components/schemas/DnsRrsetCreate' title: Rrsets type: array title: DnsZoneRrsetsCreate type: object DnsZoneRrsetsPatchOps: properties: ops: items: $ref: '#/components/schemas/DnsRrsetPatchOp' title: Ops type: array required: - ops title: DnsZoneRrsetsPatchOps type: object DnsZoneSummary: properties: total_zones: description: Total number of DNS zones title: Total Zones type: integer zones_by_dnssec: additionalProperties: type: integer description: Count of zones by DNSSEC status propertyNames: $ref: '#/components/schemas/DnssecStatus' title: Zones By Dnssec type: object required: - total_zones title: DnsZoneSummary type: object DnsZoneUpdateBulkCommand: properties: command: const: dns_zone_update_bulk default: dns_zone_update_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DnsZoneUpdateBulkPayload' description: Bulk DNS zone update payload version: default: v1 description: Command version title: Version type: string required: - payload title: DnsZoneUpdateBulkCommand type: object DnsZoneUpdateBulkInstance: properties: dnssec_status: anyOf: - $ref: '#/components/schemas/DnssecStatus' - type: 'null' description: Override DNSSEC status for this zone name: description: The DNS zone name (e.g., example.com) title: Name type: string rrsets: anyOf: - items: $ref: '#/components/schemas/DnsRrsetCreate' type: array - type: 'null' description: Override RRsets for this zone. Omit to inherit the template (or leave records unchanged if the template also omits rrsets). Provide an empty list to delete all records. title: Rrsets required: - name title: DnsZoneUpdateBulkInstance type: object DnsZoneUpdateBulkPayload: properties: instances: description: List of zones to update (1-1000) items: $ref: '#/components/schemas/DnsZoneUpdateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/DnsZoneUpdateBulkTemplate' description: Shared RRsets for all zones required: - template - instances title: DnsZoneUpdateBulkPayload type: object DnsZoneUpdateBulkTemplate: properties: dnssec_status: anyOf: - $ref: '#/components/schemas/DnssecStatus' - type: 'null' description: DNSSEC status for all zones rrsets: anyOf: - items: $ref: '#/components/schemas/DnsRrsetCreate' type: array - type: 'null' description: DNS record sets to apply to every zone. Omit to leave each zone's RRsets unchanged (useful for bulk DNSSEC toggles). Provide an empty list to delete all records. title: Rrsets title: DnsZoneUpdateBulkTemplate type: object DnsZoneUpdateCommand: properties: command: const: dns_zone_update default: dns_zone_update title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this command title: Idempotency Key payload: $ref: '#/components/schemas/DnsZoneUpdatePayloadData' description: DNS zone update payload version: default: v1 description: Command version title: Version type: string required: - payload title: DnsZoneUpdateCommand type: object DnsZoneUpdatePayloadData: properties: dnssec_status: anyOf: - $ref: '#/components/schemas/DnssecStatus' - type: 'null' name: title: Name type: string rrsets: items: $ref: '#/components/schemas/DnsRrsetCreate' title: Rrsets type: array vanity_nameserver_set_id: anyOf: - examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: vns - type: 'null' description: Optional vanity NS set to brand this zone's apex NS + SOA with. When omitted, the org's default ACTIVE set (if any) is used; when no default exists the system default NS is used. title: Vanity Nameserver Set Id required: - name title: DnsZoneUpdatePayloadData type: object DnsZoneUpdateWorkerPayload: properties: operation: title: Operation type: string type: enum: - dns_zone_update - dns_zone_update_bulk title: Type type: string zone: $ref: '#/components/schemas/DnsZoneUpdatePayloadData' required: - type - operation - zone title: DnsZoneUpdateWorkerPayload type: object DnsZoneVanitySetUpdateRes: properties: zone: $ref: '#/components/schemas/DnsZoneDTO' description: The zone after restamping required: - zone title: DnsZoneVanitySetUpdateRes type: object DnssecAlgorithm: enum: - 1 - 2 - 3 - 4 - 5 - 6 - 7 - 8 - 10 - 12 - 13 - 14 - 15 - 16 - 17 - 23 title: DnssecAlgorithm type: integer DnssecDigestType: enum: - 1 - 2 - 3 - 4 - 5 - 6 title: DnssecDigestType type: integer DnssecModeType: enum: - DS - DNSKEY title: DnssecModeType type: string DnssecRecordType: enum: - ds_data - key_data title: DnssecRecordType type: string DnssecRegistryPublishOutcome: description: 'Fate of the DS/DNSKEY submission that follows signing a zone. DEFERRED means the zone is signed but the parent holds no DS yet: the registry rejected the submission because the public nameservers had not served the new key material yet, and a background job is retrying. A signed zone with no DS at the parent resolves as unsigned, so the intermediate state is safe. WITHDRAWN means the zone stopped being signed while the DS was in flight, so the DS was taken back off the parent: the enablement did not take effect. It is kept apart from SKIPPED because SKIPPED also covers "there was nothing to submit", and a caller must not render an enablement that was undone as a success. FAILED means the zone is signed and nothing is working towards a DS. Only the zone create path can report it, because that is the one caller that cannot propagate the error. Null means the response makes no statement about a registry DS submission.' enum: - published - deferred - skipped - withdrawn - failed title: DnssecRegistryPublishOutcome type: string DnssecStatus: enum: - enabled - disabled title: DnssecStatus type: string DomainAttributeKey: enum: - auto_renew_period - music_registrant_attestation - nic_it_compliance_confirmation - travel_industry_acknowledgement - verification_required - de_general_request_contact - de_abuse_contact - nor_id_applicant_version - nor_id_applicant_accept_name - nor_id_applicant_accept_date - nor_id_declaration - nor_id_declaration_token - punktum_dk_terms_acceptance - punktum_dk_tracking_no - internet_ee_registrant_agreement - promotion - promotion_eligibility - domain_contact_attributes - registry_reseller_id title: DomainAttributeKey type: string DomainAvailability: properties: domain: title: Domain type: string error: anyOf: - $ref: '#/components/schemas/DomainAvailabilityError' - type: 'null' description: Error details when status is 'error', e.g. why a domain is invalid status: $ref: '#/components/schemas/DomainAvailabilityStatus' required: - domain - status title: DomainAvailability type: object DomainAvailabilityError: properties: message: description: Human-readable error message title: Message type: string type: description: Error type identifier, e.g. validation_error or check_error title: Type type: string required: - type - message title: DomainAvailabilityError type: object DomainAvailabilityMeta: properties: processing_time_ms: title: Processing Time Ms type: integer total: title: Total type: integer required: - total - processing_time_ms title: DomainAvailabilityMeta type: object DomainAvailabilityRequest: properties: domains: items: maxLength: 1024 type: string maxItems: 1000 minItems: 1 title: Domains type: array required: - domains title: DomainAvailabilityRequest type: object DomainAvailabilityStatus: enum: - available - unavailable - market_available - tmch_claim - error - unknown title: DomainAvailabilityStatus type: string DomainCheckResponse: properties: results: items: $ref: '#/components/schemas/common__models__domain__domain__DomainAvailabilityResponse' title: Results type: array required: - results title: DomainCheckResponse type: object DomainClientStatus: enum: - clientTransferProhibited - clientUpdateProhibited - clientDeleteProhibited - clientRenewProhibited - clientHold title: DomainClientStatus type: string DomainContactHandles: additionalProperties: items: $ref: '#/components/schemas/ContactHandle' type: array description: The contacts of the domain propertyNames: $ref: '#/components/schemas/DomainContactType' type: object DomainContactResponse: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/RegistryHandleAttributeType' type: object - type: 'null' description: Registry-specific attributes supplied inline for this contact in this role. Omitted when the contact was submitted without inline attributes; attributes taken from a linked contact attribute set are not reported here. title: Attributes contact_id: description: The contact id of the contact examples: - contact_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Contact Id type: string x-typeid-prefix: contact contact_type: $ref: '#/components/schemas/DomainContactType' description: The type of contact required: - contact_id - contact_type title: DomainContactResponse type: object DomainContactType: enum: - registrant - admin - tech - billing title: DomainContactType type: string DomainCreate: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Additional attributes of the domain, keyed by attribute name.\ \ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\ \ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\ \ the\n period of the next renewal; the current expiry date does not\ \ move. On transfer-in without `period` it also sets the\n period added\ \ by the transfer. Omitted on create or transfer-in, it follows the term\ \ being bought: a one-month\n `period` renews monthly and anything else\ \ yearly, except a longer month-unit term, which leaves it unset: the\ \ next\n renewal then charges the term that was bought where the TLD\ \ still renews for that term, and the product's default\n billing period\ \ otherwise. Supplying `monthly` where the TLD sells no one-month renewal\ \ is rejected on create,\n transfer-in and update; a `monthly` stored\ \ before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\ \ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" examples: - auto_renew_period: monthly title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 6 type: string - type: 'null' description: The auth code used for the domain title: Auth Code claims_notice_acceptance_hash: anyOf: - type: string - type: 'null' description: During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant. title: The accept_hash of the related claims notice contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - $ref: '#/components/schemas/ContactIdList' description: The contacts of the domain title: Contacts create_zone: default: false description: Create a zone for the domain on OpusDNS nameserver infrastructure title: Create Zone type: boolean expected_price: anyOf: - $ref: '#/components/schemas/StrictMoneyDecimal' - type: 'null' description: Expected price for premium domain confirmation title: Expected Price name: description: The domain to be created title: Name type: string nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: The name servers for the domain title: Nameservers period: $ref: '#/components/schemas/DomainPeriod' description: The registration period of the domain renewal_mode: $ref: '#/components/schemas/RenewalMode' description: The renewal mode of the domain required: - name - renewal_mode - contacts - period title: DomainCreate type: object DomainCreateBulkCommand: properties: command: const: domain_create_bulk default: domain_create_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DomainCreateBulkPayload' description: Bulk domain creation payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainCreateBulkCommand type: object DomainCreateBulkInstance: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Override attributes for this domain.\n\nAdditional attributes\ \ of the domain, keyed by attribute name. Values are strings.\n\nCustomer-settable\ \ keys:\n\n- `auto_renew_period`: `monthly` or `yearly`. All TLDs on create,\ \ transfer-in and update. Selects the\n period of the next renewal; the\ \ current expiry date does not move. On transfer-in without `period` it\ \ also sets the\n period added by the transfer. Omitted on create or\ \ transfer-in, it follows the term being bought: a one-month\n `period`\ \ renews monthly and anything else yearly, except a longer month-unit\ \ term, which leaves it unset: the next\n renewal then charges the term\ \ that was bought where the TLD still renews for that term, and the product's\ \ default\n billing period otherwise. Supplying `monthly` where the TLD\ \ sells no one-month renewal is rejected on create,\n transfer-in and\ \ update; a `monthly` stored before that rule applied is ignored at renewal.\n\ - `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 6 type: string - type: 'null' description: Override auth code for this domain title: Auth Code contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - type: 'null' description: Override contacts for this domain create_zone: anyOf: - type: boolean - type: 'null' description: Override create_zone for this domain title: Create Zone expected_price: anyOf: - $ref: '#/components/schemas/StrictMoneyDecimal' - type: 'null' description: Expected price for premium domain confirmation. Required only for premium domains; must be set per-instance because each premium domain has its own price. name: description: The domain to be created title: Name type: string nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: Override nameservers for this domain title: Nameservers period: anyOf: - $ref: '#/components/schemas/DomainPeriod' - type: 'null' description: Override registration period for this domain renewal_mode: anyOf: - $ref: '#/components/schemas/RenewalMode' - type: 'null' description: Override renewal mode for this domain required: - name title: DomainCreateBulkInstance type: object DomainCreateBulkPayload: properties: instances: description: List of domains to create (1-1000) items: $ref: '#/components/schemas/DomainCreateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/DomainCreateBulkTemplate' description: Shared settings for all domains required: - template - instances title: DomainCreateBulkPayload type: object DomainCreateBulkTemplate: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Additional attributes of the domain, keyed by attribute name.\ \ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\ \ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\ \ the\n period of the next renewal; the current expiry date does not\ \ move. On transfer-in without `period` it also sets the\n period added\ \ by the transfer. Omitted on create or transfer-in, it follows the term\ \ being bought: a one-month\n `period` renews monthly and anything else\ \ yearly, except a longer month-unit term, which leaves it unset: the\ \ next\n renewal then charges the term that was bought where the TLD\ \ still renews for that term, and the product's default\n billing period\ \ otherwise. Supplying `monthly` where the TLD sells no one-month renewal\ \ is rejected on create,\n transfer-in and update; a `monthly` stored\ \ before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\ \ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 6 type: string - type: 'null' description: The auth code used for the domain title: Auth Code contacts: $ref: '#/components/schemas/DomainContactHandles' create_zone: default: false description: Create a zone on OpusDNS nameserver infrastructure title: Create Zone type: boolean nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: The name servers for the domain title: Nameservers period: $ref: '#/components/schemas/DomainPeriod' description: The registration period of the domain renewal_mode: $ref: '#/components/schemas/RenewalMode' description: The renewal mode of the domain required: - period - contacts - renewal_mode title: DomainCreateBulkTemplate type: object DomainCreateCommand: properties: command: const: domain_create default: domain_create title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this command title: Idempotency Key payload: $ref: '#/components/schemas/DomainCreatePayloadData' description: Domain creation payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainCreateCommand type: object DomainCreatePayloadData: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Additional attributes of the domain, keyed by attribute name.\ \ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\ \ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\ \ the\n period of the next renewal; the current expiry date does not\ \ move. On transfer-in without `period` it also sets the\n period added\ \ by the transfer. Omitted on create or transfer-in, it follows the term\ \ being bought: a one-month\n `period` renews monthly and anything else\ \ yearly, except a longer month-unit term, which leaves it unset: the\ \ next\n renewal then charges the term that was bought where the TLD\ \ still renews for that term, and the product's default\n billing period\ \ otherwise. Supplying `monthly` where the TLD sells no one-month renewal\ \ is rejected on create,\n transfer-in and update; a `monthly` stored\ \ before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\ \ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" examples: - auto_renew_period: monthly title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 6 type: string - type: 'null' description: The auth code used for the domain title: Auth Code claims_notice_acceptance_hash: anyOf: - type: string - type: 'null' description: During the claims phase domain names that match a trademark registered in the Trademark Clearinghouse require an acceptance by the registrant. title: The accept_hash of the related claims notice contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - $ref: '#/components/schemas/ContactIdList' description: The contacts of the domain title: Contacts create_zone: default: false description: Create a zone for the domain on OpusDNS nameserver infrastructure title: Create Zone type: boolean expected_price: anyOf: - $ref: '#/components/schemas/StrictMoneyDecimal' - type: 'null' description: Expected price for premium domain confirmation title: Expected Price name: description: The domain to be created title: Name type: string nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: The name servers for the domain title: Nameservers period: $ref: '#/components/schemas/DomainPeriod' description: The registration period of the domain renewal_mode: $ref: '#/components/schemas/RenewalMode' description: The renewal mode of the domain required: - name - renewal_mode - contacts - period title: DomainCreatePayloadData type: object DomainCreateWorkerPayload: properties: domain: $ref: '#/components/schemas/DomainCreatePayloadData' operation: title: Operation type: string type: enum: - domain_create - domain_create_bulk title: Type type: string required: - type - operation - domain title: DomainCreateWorkerPayload type: object DomainCreateWorkerResult: properties: domain_id: title: Domain Id type: string type: enum: - domain_create - domain_create_bulk title: Type type: string required: - type - domain_id title: DomainCreateWorkerResult type: object DomainDnssecDataCreate: properties: algorithm: $ref: '#/components/schemas/DnssecAlgorithm' description: DNSSEC algorithm used digest: anyOf: - type: string - type: 'null' description: Digest value for DS records title: Digest digest_type: anyOf: - $ref: '#/components/schemas/DnssecDigestType' - type: 'null' description: Digest type for DS records flags: anyOf: - type: integer - type: 'null' description: DNSKEY flags for key records title: Flags key_tag: anyOf: - type: integer - type: 'null' description: Key tag for DS records title: Key Tag protocol: anyOf: - type: integer - type: 'null' description: Protocol field for key records (typically 3) title: Protocol public_key: anyOf: - type: string - type: 'null' description: Base64-encoded public key for key records title: Public Key record_type: $ref: '#/components/schemas/DnssecRecordType' description: Type of DNSSEC record (DS or Key) required: - record_type - algorithm title: DomainDnssecDataCreate type: object DomainDnssecDataResponse: properties: algorithm: $ref: '#/components/schemas/DnssecAlgorithm' description: DNSSEC algorithm used created_on: description: The date/time the entry was created on format: date-time title: Created On type: string digest: anyOf: - type: string - type: 'null' description: Digest value for DS records title: Digest digest_type: anyOf: - $ref: '#/components/schemas/DnssecDigestType' - type: 'null' description: Digest type for DS records domain_dnssec_data_id: examples: - domain_dnssec_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^domain_dnssec_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Domain Dnssec Data Id type: string x-typeid-prefix: domain_dnssec domain_id: default: None description: The domain this DNSSEC record belongs to examples: - domain_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Domain Id type: string x-typeid-prefix: domain flags: anyOf: - type: integer - type: 'null' description: DNSKEY flags for key records title: Flags key_tag: anyOf: - type: integer - type: 'null' description: Key tag for DS records title: Key Tag protocol: anyOf: - type: integer - type: 'null' description: Protocol field for key records (typically 3) title: Protocol public_key: anyOf: - type: string - type: 'null' description: Base64-encoded public key for key records title: Public Key record_type: $ref: '#/components/schemas/DnssecRecordType' description: Type of DNSSEC record (DS or Key) updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string required: - record_type - algorithm title: DomainDnssecDataResponse type: object DomainForward: properties: created_on: format: date-time title: Created On type: string domain_forward_id: examples: - domain_forward_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^domain_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Domain Forward Id type: string x-typeid-prefix: domain_forward enabled: title: Enabled type: boolean hostname: title: Hostname type: string http: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetResponse' - type: 'null' https: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetResponse' - type: 'null' parking_id: anyOf: - examples: - parking_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: parking - type: 'null' title: Parking Id updated_on: format: date-time title: Updated On type: string required: - domain_forward_id - hostname - enabled - updated_on - created_on title: DomainForward type: object DomainForwardBrowserStatsResponse: properties: results: items: $ref: '#/components/schemas/BrowserStatsBucket' title: Results type: array required: - results title: DomainForwardBrowserStatsResponse type: object DomainForwardCreateBulkCommand: properties: command: const: domain_forward_create_bulk default: domain_forward_create_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DomainForwardCreateBulkPayload' description: Bulk domain forward create payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainForwardCreateBulkCommand type: object DomainForwardCreateBulkInstance: properties: enabled: anyOf: - type: boolean - type: 'null' description: Override enabled setting for this hostname title: Enabled hostname: description: Hostname to create forward for title: Hostname type: string http: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' description: Override HTTP redirects https: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' description: Override HTTPS redirects required: - hostname title: DomainForwardCreateBulkInstance type: object DomainForwardCreateBulkPayload: properties: instances: description: List of domain forwards to create (1-1000) items: $ref: '#/components/schemas/DomainForwardCreateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/DomainForwardCreateBulkTemplate' description: Shared settings for all domain forwards required: - template - instances title: DomainForwardCreateBulkPayload type: object DomainForwardCreateBulkTemplate: properties: auto_create_zone: default: false description: Create apex DNS zone automatically when missing title: Auto Create Zone type: boolean enabled: default: false description: Whether domain forward should be enabled title: Enabled type: boolean http: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' description: HTTP redirect definitions https: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' description: HTTPS redirect definitions title: DomainForwardCreateBulkTemplate type: object DomainForwardCreateRequest: properties: enabled: default: false title: Enabled type: boolean hostname: title: Hostname type: string http: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' https: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' required: - hostname title: DomainForwardCreateRequest type: object DomainForwardDeleteBulkCommand: properties: command: const: domain_forward_delete_bulk default: domain_forward_delete_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DomainForwardDeleteBulkPayload' description: Bulk domain forward delete payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainForwardDeleteBulkCommand type: object DomainForwardDeleteBulkInstance: properties: hostname: description: Hostname to delete forwarding for title: Hostname type: string required: - hostname title: DomainForwardDeleteBulkInstance type: object DomainForwardDeleteBulkPayload: properties: instances: description: List of hostnames to delete forwarding for (1-1000) items: $ref: '#/components/schemas/DomainForwardDeleteBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: DomainForwardDeleteBulkPayload type: object DomainForwardDisableBulkCommand: properties: command: const: domain_forward_disable_bulk default: domain_forward_disable_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DomainForwardDisableBulkPayload' description: Bulk domain forward disable payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainForwardDisableBulkCommand type: object DomainForwardDisableBulkInstance: properties: hostname: description: Hostname to disable forwarding for title: Hostname type: string required: - hostname title: DomainForwardDisableBulkInstance type: object DomainForwardDisableBulkPayload: properties: instances: description: List of hostnames to disable forwarding for (1-1000) items: $ref: '#/components/schemas/DomainForwardDisableBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: DomainForwardDisableBulkPayload type: object DomainForwardEnableBulkCommand: properties: command: const: domain_forward_enable_bulk default: domain_forward_enable_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DomainForwardEnableBulkPayload' description: Bulk domain forward enable payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainForwardEnableBulkCommand type: object DomainForwardEnableBulkInstance: properties: hostname: description: Hostname to enable forwarding for title: Hostname type: string required: - hostname title: DomainForwardEnableBulkInstance type: object DomainForwardEnableBulkPayload: properties: instances: description: List of hostnames to enable forwarding for (1-1000) items: $ref: '#/components/schemas/DomainForwardEnableBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: DomainForwardEnableBulkPayload type: object DomainForwardGeoStatsResponse: properties: results: items: $ref: '#/components/schemas/GeoStatsBucket' title: Results type: array required: - results title: DomainForwardGeoStatsResponse type: object DomainForwardMetricsResponse: properties: configured_forwards: title: Configured Forwards type: integer invoked_forwards: title: Invoked Forwards type: integer total_visits: title: Total Visits type: integer unique_visits: title: Unique Visits type: integer required: - invoked_forwards - configured_forwards - total_visits - unique_visits title: DomainForwardMetricsResponse type: object DomainForwardMetricsTimeSeriesResponse: properties: results: items: $ref: '#/components/schemas/TimeSeriesBucket' title: Results type: array required: - results title: DomainForwardMetricsTimeSeriesResponse type: object DomainForwardPatchOp: properties: op: $ref: '#/components/schemas/PatchOp' redirect: anyOf: - $ref: '#/components/schemas/HttpRedirectUpsert' - $ref: '#/components/schemas/HttpRedirectRemove' title: Redirect required: - op - redirect title: DomainForwardPatchOp type: object DomainForwardPatchOps: properties: ops: items: $ref: '#/components/schemas/DomainForwardPatchOp' title: Ops type: array required: - ops title: DomainForwardPatchOps type: object DomainForwardPlatformStatsResponse: properties: results: items: $ref: '#/components/schemas/PlatformStatsBucket' title: Results type: array required: - results title: DomainForwardPlatformStatsResponse type: object DomainForwardProtocolSetRequest: properties: redirects: items: $ref: '#/components/schemas/HttpRedirectRequest' title: Redirects type: array required: - redirects title: DomainForwardProtocolSetRequest type: object DomainForwardProtocolSetResponse: properties: created_on: format: date-time title: Created On type: string redirects: items: $ref: '#/components/schemas/HttpRedirectListResponse' title: Redirects type: array updated_on: format: date-time title: Updated On type: string required: - redirects - updated_on - created_on title: DomainForwardProtocolSetResponse type: object DomainForwardReferrerStatsResponse: properties: results: items: $ref: '#/components/schemas/ReferrerStatsBucket' title: Results type: array required: - results title: DomainForwardReferrerStatsResponse type: object DomainForwardSetCreateRequest: properties: protocol: $ref: '#/components/schemas/HttpProtocol' redirects: items: $ref: '#/components/schemas/HttpRedirectRequest' title: Redirects type: array required: - protocol - redirects title: DomainForwardSetCreateRequest type: object DomainForwardSetRequest: properties: redirects: items: $ref: '#/components/schemas/HttpRedirectRequest' title: Redirects type: array required: - redirects title: DomainForwardSetRequest type: object DomainForwardSetResponse: properties: created_on: format: date-time title: Created On type: string hostname: title: Hostname type: string protocol: $ref: '#/components/schemas/HttpProtocol' redirects: items: $ref: '#/components/schemas/HttpRedirectListResponse' title: Redirects type: array updated_on: format: date-time title: Updated On type: string required: - hostname - protocol - redirects - updated_on - created_on title: DomainForwardSetResponse type: object DomainForwardSortField: enum: - hostname - enabled - created_on - updated_on title: DomainForwardSortField type: string DomainForwardStatusCodeStatsResponse: properties: results: items: $ref: '#/components/schemas/StatusCodeStatsBucket' title: Results type: array required: - results title: DomainForwardStatusCodeStatsResponse type: object DomainForwardUpdateBulkCommand: properties: command: const: domain_forward_update_bulk default: domain_forward_update_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DomainForwardUpdateBulkPayload' description: Bulk domain forward update payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainForwardUpdateBulkCommand type: object DomainForwardUpdateBulkInstance: properties: enabled: anyOf: - type: boolean - type: 'null' description: Override enabled setting for this hostname title: Enabled hostname: description: Hostname to update forward for title: Hostname type: string http: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' description: Override HTTP redirects https: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' description: Override HTTPS redirects required: - hostname title: DomainForwardUpdateBulkInstance type: object DomainForwardUpdateBulkPayload: properties: instances: description: List of domain forwards to update (1-1000) items: $ref: '#/components/schemas/DomainForwardUpdateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/DomainForwardUpdateBulkTemplate' description: Shared settings for all domain forwards required: - template - instances title: DomainForwardUpdateBulkPayload type: object DomainForwardUpdateBulkTemplate: properties: enabled: description: Whether domain forward should be enabled title: Enabled type: boolean http: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' description: HTTP redirect definitions https: anyOf: - $ref: '#/components/schemas/DomainForwardProtocolSetRequest' - type: 'null' description: HTTPS redirect definitions required: - enabled title: DomainForwardUpdateBulkTemplate type: object DomainForwardUserAgentStatsResponse: properties: results: items: $ref: '#/components/schemas/UserAgentStatsBucket' title: Results type: array required: - results title: DomainForwardUserAgentStatsResponse type: object DomainForwardVisitsByKeyResponse: properties: results: items: $ref: '#/components/schemas/VisitsByKeyBucket' title: Results type: array required: - results title: DomainForwardVisitsByKeyResponse type: object DomainForwardZone: properties: domain_forwards: items: $ref: '#/components/schemas/DomainForward' title: Domain Forwards type: array zone_id: examples: - zone_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^zone_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Zone Id type: string x-typeid-prefix: zone zone_name: title: Zone Name type: string required: - zone_id - zone_name - domain_forwards title: DomainForwardZone type: object DomainForwardZoneSortField: enum: - name - created_on - updated_on title: DomainForwardZoneSortField type: string DomainForwardsContext: properties: context_id: examples: - ctx_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Context Id type: string x-typeid-prefix: ctx conversation_id: examples: - conv_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Conversation Id type: string x-typeid-prefix: conv created_at: format: date-time title: Created At type: string kind: const: domain_forwards default: domain_forwards title: Kind type: string organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization payload: $ref: '#/components/schemas/ContextPayload_DomainForward_' user_id: title: User Id type: string required: - context_id - conversation_id - organization_id - user_id - created_at - payload title: DomainForwardsContext type: object DomainForwardsContextCreate: properties: kind: const: domain_forwards default: domain_forwards title: Kind type: string payload: $ref: '#/components/schemas/ContextPayload_DomainForward_' required: - payload title: DomainForwardsContextCreate type: object DomainHostResponse: properties: host_id: description: The host id of the host examples: - host_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Host Id type: string x-typeid-prefix: host required: - host_id title: DomainHostResponse type: object DomainIncludeField: enum: - tags - renewal_price - connected_account title: DomainIncludeField type: string DomainLifecycleBase: properties: add_grace_period: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: Add grace period in days after registration in ISO 8601 format (e.g., 5D, 3D) title: Add Grace Period auto_renew_before_expiration: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: Time before expiration to auto-renew a domain in ISO 8601 format (e.g., 5D, -7D) title: Auto Renew Before Expiration default_transfer_renewal_period: $ref: '#/components/schemas/PeriodStr' description: Default period for transfer if no transfer_renewal_period is specified delete_before_expiration: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: Time before expiration to delete a domain in ISO 8601 format (e.g., 5D, -7D) title: Delete Before Expiration delete_policy: anyOf: - items: $ref: '#/components/schemas/DeletePolicyType' type: array - type: 'null' description: How a domain can be deleted title: Delete Policy explicit_renew: anyOf: - type: boolean - type: 'null' description: Whether an explicit renewal is possible title: Explicit Renew grace_period: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: Grace period after expiration in ISO 8601 format (e.g., 5D, -7D) examples: - P5D - P30D title: Grace Period pending_delete: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: Pending delete period in ISO 8601 format (e.g., 5D, 10D) after redemption_period title: Pending Delete redemption_period: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: Redemption period for domain recovery after grace period in ISO 8601 format (e.g., 5D, -7D) title: Redemption Period registration_periods: $ref: '#/components/schemas/PeriodList' description: List of allowed registration periods (e.g., '1y' or ['1y', '2y', '5y']) registry_auto_renew: anyOf: - type: boolean - type: 'null' description: Does the registry enforce auto-renewal title: Registry Auto Renew renewal_periods: $ref: '#/components/schemas/PeriodList' description: List of allowed renewal periods (e.g., '1y' or ['1y', '2y', '5y']) restore_triggers_renewal: default: true description: After a restore, renew the domain so its term matches the subscription. True for RGP registries, whose redemption restore does not extend the domain. False where the restore already leaves a valid term - e.g. NASK/.pl, where restore removes clientRenewProhibited or renews+reactivates, and a redundant renew is rejected (one renewal per billing period). title: Restore Triggers Renewal type: boolean rgp_operations: anyOf: - $ref: '#/components/schemas/RgpOperations' - type: 'null' description: RGP operations supported by the registry sync_after_operations: anyOf: - items: $ref: '#/components/schemas/SyncOperationType' type: array - type: 'null' description: Operations that trigger a sync with the registry title: Sync After Operations transfer_grace_period: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: Transfer grace period after a transfer in ISO 8601 format (e.g., 5D, 3D) title: Transfer Grace Period transfer_renewal_periods: $ref: '#/components/schemas/PeriodList' description: List of allowed transfer renewal periods (eg. '1y') required: - default_transfer_renewal_period title: DomainLifecycleBase type: object DomainListIncludeField: description: 'Includes a list endpoint offers. Deliberately narrower than `DomainIncludeField`: resolving a renewal price costs a registry check plus a billing call per premium domain, which a page of results would multiply into a registry rate-limit problem. Both the public list route and the internal domains-service list request implement every member.' enum: - tags - connected_account title: DomainListIncludeField type: string DomainNameParts: properties: domain: anyOf: - type: string - type: 'null' examples: - example title: Domain subdomain: anyOf: - type: string - type: 'null' examples: - foo title: Subdomain suffix: anyOf: - type: string - type: 'null' examples: - com title: Suffix title: DomainNameParts type: object DomainPeriod: properties: unit: $ref: '#/components/schemas/PeriodUnit' description: The unit of the period value: description: Amount of time in the unit exclusiveMinimum: 0.0 title: Value type: integer required: - value - unit title: DomainPeriod type: object DomainRecommendationsContext: properties: context_id: examples: - ctx_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Context Id type: string x-typeid-prefix: ctx conversation_id: examples: - conv_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Conversation Id type: string x-typeid-prefix: conv created_at: format: date-time title: Created At type: string kind: const: domain_recommendations default: domain_recommendations title: Kind type: string organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization payload: $ref: '#/components/schemas/ContextPayload_DomainSearchSuggestionWithPrice_' user_id: title: User Id type: string required: - context_id - conversation_id - organization_id - user_id - created_at - payload title: DomainRecommendationsContext type: object DomainRecommendationsContextCreate: properties: kind: const: domain_recommendations default: domain_recommendations title: Kind type: string payload: $ref: '#/components/schemas/ContextPayload_DomainSearchSuggestionWithPrice_' required: - payload title: DomainRecommendationsContextCreate type: object DomainRegistrarCredentialResponse: properties: name: description: Human-readable name for this credential title: Name type: string registrar: $ref: '#/components/schemas/Registrar' description: The registrar this credential is for registrar_credential_id: description: Unique identifier for this credential examples: - registrar_credential_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^registrar_credential_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Registrar Credential Id type: string x-typeid-prefix: registrar_credential type: const: ras description: 'Kind of connected account. `ras`: a registrar credential managed under `/v1/connect/registrars`.' title: Type type: string required: - type - registrar_credential_id - name - registrar title: DomainRegistrarCredentialResponse type: object DomainRenewRequest: properties: current_expiry_date: description: Current expiration date of the domain for validation format: date-time title: Current Expiry Date type: string expected_price: anyOf: - $ref: '#/components/schemas/StrictMoneyDecimal' - type: 'null' description: Expected price for premium domain confirmation title: Expected Price period: $ref: '#/components/schemas/DomainPeriod' description: How long to extend the domain registration required: - period - current_expiry_date title: DomainRenewRequest type: object DomainRenewResponse: properties: name: description: The domain name that was renewed title: Name type: string new_expiry_date: description: New expiration date after renewal format: date-time title: New Expiry Date type: string period_extended: $ref: '#/components/schemas/DomainPeriod' description: The period by which the domain was extended required: - name - new_expiry_date - period_extended title: DomainRenewResponse type: object DomainRenewalDetails: properties: detail_type: const: domain_renewal default: domain_renewal title: Detail Type type: string expires_on: format: date-time title: Expires On type: string required: - expires_on title: DomainRenewalDetails type: object DomainRenewalPriceResponse: properties: currency: description: ISO 4217 currency code examples: - EUR title: Currency type: string is_premium: description: True when the price came from the registry's premium classification for renew rather than from the organization's standard TLD pricing title: Is Premium type: boolean period: $ref: '#/components/schemas/DomainPeriod' description: Period the price covers price: description: Renewal price for the period below, in the organization's billing currency, taxes excluded examples: - '43.50' pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Price type: string required: - price - currency - period - is_premium title: DomainRenewalPriceResponse type: object DomainResponse: properties: auth_code: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The auth code for the domain title: Auth Code auth_code_expires_on: anyOf: - format: date-time type: string - type: 'null' description: When the auth code expires title: Auth Code Expires On canceled_on: anyOf: - format: date-time type: string - type: 'null' description: When the domain was deleted title: Canceled On connected_account: anyOf: - discriminator: mapping: ras: '#/components/schemas/DomainRegistrarCredentialResponse' propertyName: type oneOf: - $ref: '#/components/schemas/DomainRegistrarCredentialResponse' - type: 'null' description: The connected account this domain is synced from. Null unless `include=connected_account` is requested, and null even then for natively registered domains, for domains on operator-managed registry accounts, and when the connected account was deleted. title: Connected Account contacts: description: The contacts of the domain items: $ref: '#/components/schemas/DomainContactResponse' title: Contacts type: array created_on: description: The date/time the entry was created on format: date-time title: Created On type: string deleted_on: anyOf: - format: date-time type: string - type: 'null' description: When the domain will be deleted title: Deleted On domain_id: examples: - domain_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Domain Id type: string x-typeid-prefix: domain expires_on: anyOf: - format: date-time type: string - type: 'null' description: When the domain expires title: Expires On hosts: description: The subordinate hosts of the domain items: $ref: '#/components/schemas/DomainHostResponse' title: Hosts type: array is_premium: default: false description: 'Whether the registry prices this domain at a premium class for the action it was bought under. Not purchase provenance: a renewal-time check that affirmatively quotes renew as standard corrects the flag, so it tracks the registry''s current classification. Registries classify each action separately, so a domain premium only to restore is not premium here.' title: Is Premium type: boolean name: description: The domain name examples: - example.com title: Name type: string nameservers: description: The nameservers of the domain items: $ref: '#/components/schemas/Nameserver' title: Nameservers type: array owner_id: default: None description: The organization that owns the domain examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Owner Id type: string x-typeid-prefix: organization read_only: default: false description: "Whether the domain is read-only in OpusDNS. When `true`, the\ \ domain is listed in your portfolio but cannot be managed \u2014 for\ \ example while it awaits a migration, is locked for legal reasons, or\ \ is managed at an external registrar. The flag is set and removed by\ \ OpusDNS; it cannot be changed through the API." title: Read Only type: boolean registered_on: anyOf: - format: date-time type: string - type: 'null' description: When the domain was registered title: Registered On registry_account_id: default: None examples: - registry_account_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^registry_account_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Registry Account Id type: string x-typeid-prefix: registry_account registry_statuses: description: All the domain statuses items: type: string title: Registry Statuses type: array renewal_mode: $ref: '#/components/schemas/RenewalMode' description: The renewal mode of the domain renewal_period: anyOf: - type: string - type: 'null' description: Renewal period of the domain as an ISO 8601 duration (e.g. 'P1M', 'P1Y'). Null when the domain is not set to renew (renewal mode 'expire') or has no active subscription. title: Renewal Period renewal_price: anyOf: - $ref: '#/components/schemas/DomainRenewalPriceResponse' - type: 'null' description: Price this organization pays to renew this domain for one year. Only included when ?include=renewal_price is specified. roid: description: The registry object id of the domain examples: - D123456789-EXAMPLE-TEST title: Roid type: string sld: description: The second level domain examples: - example maxLength: 255 minLength: 1 title: Sld type: string status_tags: anyOf: - items: $ref: '#/components/schemas/StatusTagResponse' type: array - type: 'null' description: Status tags assigned to this domain. Null unless `include=tags` is requested. title: Status Tags tags: anyOf: - items: $ref: '#/components/schemas/TagEnrichedResponse' type: array - type: 'null' description: User tags assigned to this domain. Null unless `include=tags` is requested. title: Tags tld: description: The top level domain of the domain examples: - com maxLength: 255 minLength: 1 title: Tld type: string transfer_lock: default: false description: Whether the domain is locked for transfer title: Transfer Lock type: boolean transferred_on: anyOf: - format: date-time type: string - type: 'null' description: When the domain was last transferred to us title: Transferred On updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string verification_required: anyOf: - $ref: '#/components/schemas/VerificationResponse' - type: 'null' description: Verification data for this domain, including pending claims and deadlines. required: - name - sld - tld - roid title: DomainResponse type: object DomainRestoreRequest: properties: additional_info: anyOf: - type: string - type: 'null' description: Additional information to include in the restore operation title: Additional Info expected_price: anyOf: - $ref: '#/components/schemas/StrictMoneyDecimal' - type: 'null' description: Expected price for premium domain confirmation title: Expected Price reason: anyOf: - type: string - type: 'null' description: Reason for restoring the domain title: Reason title: DomainRestoreRequest type: object DomainRestoreResponse: properties: domain_id: description: The ID of the restored domain examples: - domain_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Domain Id type: string x-typeid-prefix: domain name: description: The name of the restored domain title: Name type: string restored_at: description: When the domain restore operation was completed format: date-time title: Restored At type: string required: - domain_id - name - restored_at title: DomainRestoreResponse type: object DomainSearchMeta: properties: processing_time_ms: title: Processing Time Ms type: integer total: title: Total type: integer required: - total - processing_time_ms title: DomainSearchMeta type: object DomainSearchResponse: properties: meta: $ref: '#/components/schemas/DomainSearchMeta' results: items: $ref: '#/components/schemas/DomainSearchSuggestionWithPrice' title: Results type: array required: - meta - results title: DomainSearchResponse type: object DomainSearchSuggestionPriceData: properties: amount: anyOf: - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ type: string - type: 'null' title: Amount currency: title: Currency type: string period: $ref: '#/components/schemas/DomainPeriod' required: - amount - currency - period title: DomainSearchSuggestionPriceData type: object DomainSearchSuggestionWithPrice: properties: available: title: Available type: boolean domain: title: Domain type: string premium: title: Premium type: boolean price: $ref: '#/components/schemas/DomainSearchSuggestionPriceData' renewal_price: anyOf: - $ref: '#/components/schemas/DomainSearchSuggestionPriceData' - type: 'null' required: - domain - available - premium - price title: DomainSearchSuggestionWithPrice type: object DomainSortField: enum: - name - created_on - updated_on - expires_on - registered_on - transferred_on title: DomainSortField type: string DomainStatisticsBreakdown: enum: - none - organization - tld title: DomainStatisticsBreakdown type: string DomainStatisticsBreakdownRowResponse: properties: create: title: Create type: integer delete: title: Delete type: integer key: description: Organization id, or the TLD without the leading dot title: Key type: string label: anyOf: - type: string - type: 'null' description: Organization name; absent for TLD rows title: Label net: description: Created plus transferred in, minus deleted and transferred out title: Net type: integer renew: title: Renew type: integer restore: title: Restore type: integer total: description: Created plus transferred title: Total type: integer transfer: title: Transfer type: integer transfer_out: title: Transfer Out type: integer required: - key - label - create - transfer - total - delete - transfer_out - renew - restore - net title: DomainStatisticsBreakdownRowResponse type: object DomainStatisticsBucketResponse: properties: create: description: Domains created in this bucket title: Create type: integer delete: description: Domains deleted in this bucket title: Delete type: integer net: description: Created plus transferred in, minus deleted and transferred out title: Net type: integer partial: description: The bucket reaches outside the requested window, so its counts cover only part of its span and must not be read as a rise or fall against its neighbours title: Partial type: boolean period_start: description: First day of the bucket (UTC) format: date title: Period Start type: string renew: description: Domain renewals in this bucket title: Renew type: integer restore: description: Domains restored in this bucket title: Restore type: integer transfer: description: Domains transferred in during this bucket title: Transfer type: integer transfer_out: description: Domains transferred away during this bucket title: Transfer Out type: integer required: - period_start - create - transfer - delete - transfer_out - renew - restore - net - partial title: DomainStatisticsBucketResponse type: object DomainStatisticsResponse: properties: breakdown: description: Top organizations or TLDs by acquisitions in the window; empty unless requested items: $ref: '#/components/schemas/DomainStatisticsBreakdownRowResponse' title: Breakdown type: array buckets: description: One entry per bucket the window touches, oldest first, including empty buckets items: $ref: '#/components/schemas/DomainStatisticsBucketResponse' title: Buckets type: array data_available_from: anyOf: - format: date-time type: string - type: 'null' description: Oldest day these statistics can report on. They are read from the domain event log, which starts later than the domains themselves, so a window reaching further back is empty before this instant rather than zero. title: Data Available From end_date: description: Last day of the window, inclusive format: date title: End Date type: string granularity: $ref: '#/components/schemas/UsageGranularity' description: Time-bucket size of the series organization_id: description: The organization the counts are scoped to examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization start_date: description: First day of the window, inclusive format: date title: Start Date type: string totals: $ref: '#/components/schemas/DomainStatisticsTotalsResponse' required: - organization_id - granularity - start_date - end_date - totals - buckets - breakdown - data_available_from title: DomainStatisticsResponse type: object DomainStatisticsTotalsResponse: properties: create: description: Domains created (newly registered) in the window title: Create type: integer delete: description: Domains deleted in the window title: Delete type: integer net: description: Created plus transferred in, minus deleted and transferred out title: Net type: integer renew: description: Domains renewed in the window, counted once per day a domain was renewed title: Renew type: integer restore: description: Domains restored from redemption in the window title: Restore type: integer total: description: Created plus transferred title: Total type: integer transfer: description: Domains transferred to OpusDNS in the window title: Transfer type: integer transfer_out: description: Domains transferred away from OpusDNS in the window title: Transfer Out type: integer required: - create - transfer - total - delete - transfer_out - renew - restore - net title: DomainStatisticsTotalsResponse type: object DomainStatus: enum: - ok - serverTransferProhibited - serverUpdateProhibited - serverDeleteProhibited - serverRenewProhibited - serverRestoreProhibited - serverHold - transferPeriod - renewPeriod - redemptionPeriod - pendingUpdate - pendingTransfer - pendingRestore - pendingRenew - pendingDelete - pendingCreate - inactive - autoRenewPeriod - addPeriod - deleted - clientTransferProhibited - clientUpdateProhibited - clientDeleteProhibited - clientRenewProhibited - clientHold - free - connect - failed - invalid title: DomainStatus type: string DomainStatusResponse: properties: status: description: The status of the domain title: Status type: string required: - status title: DomainStatusResponse type: object DomainStatusesBase: properties: default: description: The default status for an active domain with no restrictions items: type: string title: Default type: array status_mapping: anyOf: - additionalProperties: items: $ref: '#/components/schemas/DomainStatus' type: array type: object - type: 'null' description: Mapping of registry-specific statuses to their equivalent default ones, if any title: Status Mapping supported_statuses: description: Supported domain statuses items: type: string title: Supported Statuses type: array required: - default - supported_statuses title: DomainStatusesBase type: object DomainSummaryData: properties: by_organization: additionalProperties: type: integer description: 'Domain counts by organization name (name: count)' title: By Organization type: object by_status: additionalProperties: type: integer description: 'Domain counts by status (status: count)' title: By Status type: object by_status_tag: additionalProperties: type: integer description: 'Domain counts by status tag (status_tag: count), only status tags with at least one domain' propertyNames: $ref: '#/components/schemas/StatusTagType' title: By Status Tag type: object by_tld: additionalProperties: type: integer description: 'Domain counts by TLD (tld: count)' title: By Tld type: object expiring_soon: $ref: '#/components/schemas/DomainsExpiringSoon' description: Domains expiring soon total_count: description: Total number of domains including sub-organizations title: Total Count type: integer required: - total_count - by_status - by_status_tag - by_tld - by_organization - expiring_soon title: DomainSummaryData type: object DomainSummaryResponse: properties: domains: $ref: '#/components/schemas/DomainSummaryData' description: Domain summary data organization_id: description: The organization ID examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization required: - organization_id - domains title: DomainSummaryResponse type: object DomainTransferBulkCommand: properties: command: const: domain_transfer_bulk default: domain_transfer_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DomainTransferBulkPayload' description: Bulk domain transfer payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainTransferBulkCommand type: object DomainTransferBulkInstance: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Override attributes for this domain.\n\nAdditional attributes\ \ of the domain, keyed by attribute name. Values are strings.\n\nCustomer-settable\ \ keys:\n\n- `auto_renew_period`: `monthly` or `yearly`. All TLDs on create,\ \ transfer-in and update. Selects the\n period of the next renewal; the\ \ current expiry date does not move. On transfer-in without `period` it\ \ also sets the\n period added by the transfer. Omitted on create or\ \ transfer-in, it follows the term being bought: a one-month\n `period`\ \ renews monthly and anything else yearly, except a longer month-unit\ \ term, which leaves it unset: the next\n renewal then charges the term\ \ that was bought where the TLD still renews for that term, and the product's\ \ default\n billing period otherwise. Supplying `monthly` where the TLD\ \ sells no one-month renewal is rejected on create,\n transfer-in and\ \ update; a `monthly` stored before that rule applied is ignored at renewal.\n\ - `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 6 type: string - type: 'null' description: The auth code for this domain (required by some TLDs) title: Auth Code contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - type: 'null' description: Override contacts for this domain create_zone: anyOf: - type: boolean - type: 'null' description: Override create_zone for this domain title: Create Zone expected_price: anyOf: - $ref: '#/components/schemas/StrictMoneyDecimal' - type: 'null' description: Expected price for premium domain confirmation. Required only for premium domains; must be set per-instance because each premium domain has its own price. name: description: The domain to transfer title: Name type: string nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: Override nameservers for this domain title: Nameservers period: anyOf: - $ref: '#/components/schemas/DomainPeriod' - type: 'null' description: Override period for this domain renewal_mode: anyOf: - $ref: '#/components/schemas/RenewalMode' - type: 'null' description: Override renewal mode for this domain required: - name title: DomainTransferBulkInstance type: object DomainTransferBulkPayload: properties: instances: description: List of domains to transfer (1-1000) items: $ref: '#/components/schemas/DomainTransferBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/DomainTransferBulkTemplate' description: Shared settings for all domains required: - template - instances title: DomainTransferBulkPayload type: object DomainTransferBulkTemplate: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Additional attributes of the domain, keyed by attribute name.\ \ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\ \ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\ \ the\n period of the next renewal; the current expiry date does not\ \ move. On transfer-in without `period` it also sets the\n period added\ \ by the transfer. Omitted on create or transfer-in, it follows the term\ \ being bought: a one-month\n `period` renews monthly and anything else\ \ yearly, except a longer month-unit term, which leaves it unset: the\ \ next\n renewal then charges the term that was bought where the TLD\ \ still renews for that term, and the product's default\n billing period\ \ otherwise. Supplying `monthly` where the TLD sells no one-month renewal\ \ is rejected on create,\n transfer-in and update; a `monthly` stored\ \ before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\ \ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" title: Attributes contacts: $ref: '#/components/schemas/DomainContactHandles' description: The contacts of the domain. Optional for transfers when all supported contact roles have a minimum of 0 in the TLD specification. create_zone: default: false description: Create a zone on OpusDNS nameserver infrastructure title: Create Zone type: boolean nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: The name servers for the domain title: Nameservers period: anyOf: - $ref: '#/components/schemas/DomainPeriod' - type: 'null' description: Additional registration period to add upon transfer completion renewal_mode: $ref: '#/components/schemas/RenewalMode' description: The renewal mode of the domain required: - renewal_mode title: DomainTransferBulkTemplate type: object DomainTransferCommand: properties: command: const: domain_transfer default: domain_transfer title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this command title: Idempotency Key payload: $ref: '#/components/schemas/DomainTransferPayloadData' description: Domain transfer payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainTransferCommand type: object DomainTransferIn: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Additional attributes of the domain, keyed by attribute name.\ \ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\ \ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\ \ the\n period of the next renewal; the current expiry date does not\ \ move. On transfer-in without `period` it also sets the\n period added\ \ by the transfer. Omitted on create or transfer-in, it follows the term\ \ being bought: a one-month\n `period` renews monthly and anything else\ \ yearly, except a longer month-unit term, which leaves it unset: the\ \ next\n renewal then charges the term that was bought where the TLD\ \ still renews for that term, and the product's default\n billing period\ \ otherwise. Supplying `monthly` where the TLD sells no one-month renewal\ \ is rejected on create,\n transfer-in and update; a `monthly` stored\ \ before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\ \ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" examples: - auto_renew_period: monthly title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 6 type: string - type: 'null' description: The auth code for the domain title: Auth Code contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - $ref: '#/components/schemas/ContactIdList' description: The contacts of the domain. Optional for transfers when all supported contact roles have a minimum of 0 in the TLD specification. title: Contacts create_zone: default: false description: Create a zone for the domain on OpusDNS nameserver infrastructure title: Create Zone type: boolean expected_price: anyOf: - $ref: '#/components/schemas/StrictMoneyDecimal' - type: 'null' description: Expected price for premium domain confirmation title: Expected Price name: description: The domain to be created title: Name type: string nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: The name servers for the domain title: Nameservers period: anyOf: - $ref: '#/components/schemas/DomainPeriod' - type: 'null' description: Additional registration period to add to the domain upon transfer completion. If omitted, the registry default policy will be applied. renewal_mode: $ref: '#/components/schemas/RenewalMode' description: The renewal mode of the domain required: - name - renewal_mode title: DomainTransferIn type: object DomainTransferPayloadData: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Additional attributes of the domain, keyed by attribute name.\ \ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\ \ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\ \ the\n period of the next renewal; the current expiry date does not\ \ move. On transfer-in without `period` it also sets the\n period added\ \ by the transfer. Omitted on create or transfer-in, it follows the term\ \ being bought: a one-month\n `period` renews monthly and anything else\ \ yearly, except a longer month-unit term, which leaves it unset: the\ \ next\n renewal then charges the term that was bought where the TLD\ \ still renews for that term, and the product's default\n billing period\ \ otherwise. Supplying `monthly` where the TLD sells no one-month renewal\ \ is rejected on create,\n transfer-in and update; a `monthly` stored\ \ before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\ \ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" examples: - auto_renew_period: monthly title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 6 type: string - type: 'null' description: The auth code for the domain title: Auth Code contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - $ref: '#/components/schemas/ContactIdList' description: The contacts of the domain. Optional for transfers when all supported contact roles have a minimum of 0 in the TLD specification. title: Contacts create_zone: default: false description: Create a zone for the domain on OpusDNS nameserver infrastructure title: Create Zone type: boolean expected_price: anyOf: - $ref: '#/components/schemas/StrictMoneyDecimal' - type: 'null' description: Expected price for premium domain confirmation title: Expected Price name: description: The domain to be created title: Name type: string nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: The name servers for the domain title: Nameservers period: anyOf: - $ref: '#/components/schemas/DomainPeriod' - type: 'null' description: Additional registration period to add to the domain upon transfer completion. If omitted, the registry default policy will be applied. renewal_mode: $ref: '#/components/schemas/RenewalMode' description: The renewal mode of the domain required: - name - renewal_mode title: DomainTransferPayloadData type: object DomainTransferWorkerPayload: properties: domain: $ref: '#/components/schemas/DomainTransferPayloadData' operation: title: Operation type: string type: enum: - domain_transfer - domain_transfer_bulk title: Type type: string required: - type - operation - domain title: DomainTransferWorkerPayload type: object DomainTransitRequest: properties: disconnect: description: Disconnect the domain from current nameserver and update to DENIC nameserver title: Disconnect type: boolean required: - disconnect title: DomainTransitRequest type: object DomainTransitResponse: properties: name: description: The domain name that was transited title: Name type: string success: description: Whether the transit operation was successful title: Success type: boolean required: - name - success title: DomainTransitResponse type: object DomainUpdate: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Additional attributes of the domain, keyed by attribute name.\ \ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\ \ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\ \ the\n period of the next renewal; the current expiry date does not\ \ move. On transfer-in without `period` it also sets the\n period added\ \ by the transfer. Omitted on create or transfer-in, it follows the term\ \ being bought: a one-month\n `period` renews monthly and anything else\ \ yearly, except a longer month-unit term, which leaves it unset: the\ \ next\n renewal then charges the term that was bought where the TLD\ \ still renews for that term, and the product's default\n billing period\ \ otherwise. Supplying `monthly` where the TLD sells no one-month renewal\ \ is rejected on create,\n transfer-in and update; a `monthly` stored\ \ before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\ \ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" examples: - auto_renew_period: monthly title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The new auth code for the domain title: Auth Code contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - $ref: '#/components/schemas/ContactIdList' - type: 'null' description: The new contacts of the domain examples: - admin: contact_01h45ytscbebyvny4gc8cr8ma2 billing: contact_01h45ytscbebyvny4gc8cr8ma2 registrant: contact_01h45ytscbebyvny4gc8cr8ma2 tech: contact_01h45ytscbebyvny4gc8cr8ma2 title: Contacts nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: The new name servers for the domain title: Nameservers renewal_mode: anyOf: - $ref: '#/components/schemas/RenewalMode' - type: 'null' description: The new renewal mode of the domain status_changes: anyOf: - $ref: '#/components/schemas/StatusChanges' - type: 'null' description: Statuses to add or remove relative to current state statuses: anyOf: - items: $ref: '#/components/schemas/DomainClientStatus' type: array - type: 'null' description: The new statuses of the domain title: Statuses title: DomainUpdate type: object DomainUpdateBulkCommand: properties: command: const: domain_update_bulk default: domain_update_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/DomainUpdateBulkPayload' description: Bulk domain update payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainUpdateBulkCommand type: object DomainUpdateBulkInstance: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Override attributes for this domain.\n\nAdditional attributes\ \ of the domain, keyed by attribute name. Values are strings.\n\nCustomer-settable\ \ keys:\n\n- `auto_renew_period`: `monthly` or `yearly`. All TLDs on create,\ \ transfer-in and update. Selects the\n period of the next renewal; the\ \ current expiry date does not move. On transfer-in without `period` it\ \ also sets the\n period added by the transfer. Omitted on create or\ \ transfer-in, it follows the term being bought: a one-month\n `period`\ \ renews monthly and anything else yearly, except a longer month-unit\ \ term, which leaves it unset: the next\n renewal then charges the term\ \ that was bought where the TLD still renews for that term, and the product's\ \ default\n billing period otherwise. Supplying `monthly` where the TLD\ \ sells no one-month renewal is rejected on create,\n transfer-in and\ \ update; a `monthly` stored before that rule applied is ignored at renewal.\n\ - `music_registrant_attestation`: `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Override auth code for this domain title: Auth Code contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - type: 'null' description: Override contacts for this domain domain_id: anyOf: - type: string - type: 'null' description: The domain ID to update title: Domain Id name: anyOf: - type: string - type: 'null' description: The domain name to update title: Name nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: Override nameservers for this domain title: Nameservers renewal_mode: anyOf: - $ref: '#/components/schemas/RenewalMode' - type: 'null' description: Override renewal mode for this domain status_changes: anyOf: - $ref: '#/components/schemas/StatusChanges' - type: 'null' description: Override status changes for this domain statuses: anyOf: - items: $ref: '#/components/schemas/DomainClientStatus' type: array - type: 'null' description: Override statuses for this domain title: Statuses title: DomainUpdateBulkInstance type: object DomainUpdateBulkPayload: properties: instances: description: List of domains to update (1-1000) items: $ref: '#/components/schemas/DomainUpdateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/DomainUpdateBulkTemplate' description: Shared settings for all domain updates required: - template - instances title: DomainUpdateBulkPayload type: object DomainUpdateBulkTemplate: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Additional attributes of the domain, keyed by attribute name.\ \ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\ \ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\ \ the\n period of the next renewal; the current expiry date does not\ \ move. On transfer-in without `period` it also sets the\n period added\ \ by the transfer. Omitted on create or transfer-in, it follows the term\ \ being bought: a one-month\n `period` renews monthly and anything else\ \ yearly, except a longer month-unit term, which leaves it unset: the\ \ next\n renewal then charges the term that was bought where the TLD\ \ still renews for that term, and the product's default\n billing period\ \ otherwise. Supplying `monthly` where the TLD sells no one-month renewal\ \ is rejected on create,\n transfer-in and update; a `monthly` stored\ \ before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\ \ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" title: Attributes contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - type: 'null' description: The new contacts of the domain nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: The new name servers for the domain title: Nameservers renewal_mode: anyOf: - $ref: '#/components/schemas/RenewalMode' - type: 'null' description: The new renewal mode of the domain status_changes: anyOf: - $ref: '#/components/schemas/StatusChanges' - type: 'null' description: Statuses to add or remove relative to current state statuses: anyOf: - items: $ref: '#/components/schemas/DomainClientStatus' type: array - type: 'null' description: The new statuses of the domain title: Statuses title: DomainUpdateBulkTemplate type: object DomainUpdateCommand: properties: command: const: domain_update default: domain_update title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this command title: Idempotency Key payload: $ref: '#/components/schemas/DomainUpdatePayloadData' description: Domain update payload version: default: v1 description: Command version title: Version type: string required: - payload title: DomainUpdateCommand type: object DomainUpdatePayloadData: properties: attributes: anyOf: - additionalProperties: type: string propertyNames: $ref: '#/components/schemas/DomainAttributeKey' type: object - type: 'null' description: "Additional attributes of the domain, keyed by attribute name.\ \ Values are strings.\n\nCustomer-settable keys:\n\n- `auto_renew_period`:\ \ `monthly` or `yearly`. All TLDs on create, transfer-in and update. Selects\ \ the\n period of the next renewal; the current expiry date does not\ \ move. On transfer-in without `period` it also sets the\n period added\ \ by the transfer. Omitted on create or transfer-in, it follows the term\ \ being bought: a one-month\n `period` renews monthly and anything else\ \ yearly, except a longer month-unit term, which leaves it unset: the\ \ next\n renewal then charges the term that was bought where the TLD\ \ still renews for that term, and the product's default\n billing period\ \ otherwise. Supplying `monthly` where the TLD sells no one-month renewal\ \ is rejected on create,\n transfer-in and update; a `monthly` stored\ \ before that rule applied is ignored at renewal.\n- `music_registrant_attestation`:\ \ `true`. `.music` registration.\n- `nic_it_compliance_confirmation`:\ \ `true`. `.it` registration and transfer.\n- `travel_industry_acknowledgement`:\ \ `true`. `.travel` registration.\n- `internet_ee_registrant_agreement`:\ \ `true`. `.ee` registration.\n- `punktum_dk_terms_acceptance`: `true`.\ \ `.dk` registration and registrant change.\n- `de_general_request_contact`,\ \ `de_abuse_contact`: id of a contact whose `.de` attribute set has `DE_CONTACT_TYPE`\ \ =\n `REQUEST`. `.de` only.\n\nBoolean keys also accept `1` and `yes`.\n\ \nWritten by the platform and rejected if supplied: `verification_required`,\ \ `promotion`, `promotion_eligibility`,\n`nor_id_declaration`, `nor_id_declaration_token`,\ \ `punktum_dk_tracking_no`, `domain_contact_attributes`,\n`registry_reseller_id`.\ \ They are never returned under `attributes`; inline contact attributes\ \ surface on the matching\n`contacts` entry instead.\n\nDerived from the\ \ signed `.no` applicant declaration and ignored if supplied on create:\ \ `nor_id_applicant_version`,\n`nor_id_applicant_accept_name`, `nor_id_applicant_accept_date`.\n\ \nOn update, every registry stores the supplied attributes, and the update\ \ is not sent to the registry unless they\nstore; a registry that rejects\ \ the change stores nothing. An empty value removes the stored attribute,\ \ except for\n`auto_renew_period`, whose only accepted values are `monthly`\ \ and `yearly`. `.dk` also reads\n`punktum_dk_terms_acceptance` to confirm\ \ a registrant change. An update cannot change what the registrant accepted\ \ at\nregistration, so these are rejected on update: `music_registrant_attestation`,\ \ `nic_it_compliance_confirmation`,\n`travel_industry_acknowledgement`,\ \ `internet_ee_registrant_agreement` and the three `nor_id_applicant_*`\ \ keys.\n`punktum_dk_terms_acceptance` stays settable for a registrant\ \ change but cannot be removed with an empty value.\n" examples: - auto_renew_period: monthly title: Attributes auth_code: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The new auth code for the domain title: Auth Code contacts: anyOf: - $ref: '#/components/schemas/DomainContactHandles' - $ref: '#/components/schemas/ContactIdList' - type: 'null' description: The new contacts of the domain examples: - admin: contact_01h45ytscbebyvny4gc8cr8ma2 billing: contact_01h45ytscbebyvny4gc8cr8ma2 registrant: contact_01h45ytscbebyvny4gc8cr8ma2 tech: contact_01h45ytscbebyvny4gc8cr8ma2 title: Contacts domain_id: description: Domain ID to update title: Domain Id type: string nameservers: anyOf: - items: $ref: '#/components/schemas/Nameserver' type: array - type: 'null' description: The new name servers for the domain title: Nameservers renewal_mode: anyOf: - $ref: '#/components/schemas/RenewalMode' - type: 'null' description: The new renewal mode of the domain status_changes: anyOf: - $ref: '#/components/schemas/StatusChanges' - type: 'null' description: Statuses to add or remove relative to current state statuses: anyOf: - items: $ref: '#/components/schemas/DomainClientStatus' type: array - type: 'null' description: The new statuses of the domain title: Statuses required: - domain_id title: DomainUpdatePayloadData type: object DomainUpdateWorkerPayload: properties: domain: $ref: '#/components/schemas/DomainUpdatePayloadData' operation: title: Operation type: string type: enum: - domain_update - domain_update_bulk title: Type type: string required: - type - operation - domain title: DomainUpdateWorkerPayload type: object DomainVerificationDetails: properties: detail_type: const: domain_verification default: domain_verification title: Detail Type type: string domain_id: title: Domain Id type: string registrants: items: $ref: '#/components/schemas/VerificationRegistrantDetails' title: Registrants type: array verification_claims: items: $ref: '#/components/schemas/VerificationClaimType' title: Verification Claims type: array verification_deadlines: items: $ref: '#/components/schemas/VerificationDeadline' title: Verification Deadlines type: array required: - domain_id title: DomainVerificationDetails type: object DomainWithdrawRequest: properties: zone_delete: description: 'Informs the registry whether the zone for that domain has been already deleted - as took from the docs: "(...) the registrar informs the registry that he has stopped the nameservice for the specified domain"' title: Zone Delete type: boolean required: - zone_delete title: DomainWithdrawRequest type: object DomainWithdrawResponse: properties: detail: anyOf: - type: string - type: 'null' description: Why the withdraw did not succeed title: Detail name: description: The domain name that was withdrawn title: Name type: string success: description: Whether the withdraw operation was successful title: Success type: boolean required: - name - success title: DomainWithdrawResponse type: object DomainsContext: properties: context_id: examples: - ctx_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Context Id type: string x-typeid-prefix: ctx conversation_id: examples: - conv_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Conversation Id type: string x-typeid-prefix: conv created_at: format: date-time title: Created At type: string kind: const: domains default: domains title: Kind type: string organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization payload: $ref: '#/components/schemas/ContextPayload_RegistrarDomain_' user_id: title: User Id type: string required: - context_id - conversation_id - organization_id - user_id - created_at - payload title: DomainsContext type: object DomainsContextCreate: properties: kind: const: domains default: domains title: Kind type: string payload: $ref: '#/components/schemas/ContextPayload_RegistrarDomain_' required: - payload title: DomainsContextCreate type: object DomainsExpiringSoon: properties: next_30_days: description: Number of domains expiring in the next 30 days title: Next 30 Days type: integer next_60_days: description: Number of domains expiring in the next 60 days title: Next 60 Days type: integer next_90_days: description: Number of domains expiring in the next 90 days title: Next 90 Days type: integer required: - next_30_days - next_60_days - next_90_days title: DomainsExpiringSoon type: object DuplicateCommand: properties: existing_batch_id: anyOf: - examples: - batch_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: batch - type: 'null' description: "batch_id of the batch the existing job belongs to. Use this\ \ with /v1/jobs/{batch_id} to check status \u2014 the batch_id returned\ \ at the top level of this response will 404 if no new jobs were created." title: Existing Batch Id existing_job_id: description: ID of the previously-created job whose idempotency_key matched this command examples: - job_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^job_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Existing Job Id type: string x-typeid-prefix: job index: description: Index of the duplicate command in the request title: Index type: integer instance_index: anyOf: - type: integer - type: 'null' description: Index within a bulk command's instances[] for per-instance duplicates title: Instance Index resource_key: anyOf: - type: string - type: 'null' description: Resource identifier (zone name, domain name, contact email) for this duplicate title: Resource Key required: - index - existing_job_id title: DuplicateCommand type: object EmailForwardAlias: properties: alias: title: Alias type: string email_forward_alias_id: examples: - email_forward_alias_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^email_forward_alias_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Email Forward Alias Id type: string x-typeid-prefix: email_forward_alias forward_to: items: format: email type: string minItems: 1 title: Forward To type: array required: - alias - forward_to - email_forward_alias_id title: EmailForwardAlias type: object EmailForwardAliasCreate: properties: alias: title: Alias type: string forward_to: items: format: email type: string minItems: 1 title: Forward To type: array required: - alias - forward_to title: EmailForwardAliasCreate type: object EmailForwardAliasMetrics: properties: alias: description: Email alias address title: Alias type: string by_status: additionalProperties: type: integer description: Log counts grouped by status propertyNames: $ref: '#/components/schemas/EmailForwardLogStatus' title: By Status type: object total_logs: description: Total number of logs for this alias title: Total Logs type: integer required: - alias - total_logs - by_status title: EmailForwardAliasMetrics type: object EmailForwardAliasUpdate: properties: forward_to: items: format: email type: string minItems: 1 title: Forward To type: array required: - forward_to title: EmailForwardAliasUpdate type: object EmailForwardCreate: properties: aliases: default: [] items: $ref: '#/components/schemas/EmailForwardAliasCreate' title: Aliases type: array enabled: default: false title: Enabled type: boolean hostname: title: Hostname type: string required: - hostname title: EmailForwardCreate type: object EmailForwardCreateBulkCommand: properties: command: const: email_forward_create_bulk default: email_forward_create_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/EmailForwardCreateBulkPayload' description: Bulk email forward create payload version: default: v1 description: Command version title: Version type: string required: - payload title: EmailForwardCreateBulkCommand type: object EmailForwardCreateBulkInstance: properties: aliases: anyOf: - items: $ref: '#/components/schemas/EmailForwardAliasCreate' type: array - type: 'null' description: Override aliases title: Aliases enabled: anyOf: - type: boolean - type: 'null' description: Override enabled setting for this hostname title: Enabled hostname: description: Hostname to create email forwarding for title: Hostname type: string required: - hostname title: EmailForwardCreateBulkInstance type: object EmailForwardCreateBulkPayload: properties: instances: description: List of email forwards to create (1-1000) items: $ref: '#/components/schemas/EmailForwardCreateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/EmailForwardCreateBulkTemplate' description: Shared settings for all email forwards required: - template - instances title: EmailForwardCreateBulkPayload type: object EmailForwardCreateBulkTemplate: properties: aliases: description: Aliases to create items: $ref: '#/components/schemas/EmailForwardAliasCreate' title: Aliases type: array auto_create_zone: default: false description: Create apex DNS zone automatically when missing title: Auto Create Zone type: boolean enabled: default: false description: Whether email forwarding should be enabled title: Enabled type: boolean title: EmailForwardCreateBulkTemplate type: object EmailForwardDeleteBulkCommand: properties: command: const: email_forward_delete_bulk default: email_forward_delete_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/EmailForwardDeleteBulkPayload' description: Bulk email forward delete payload version: default: v1 description: Command version title: Version type: string required: - payload title: EmailForwardDeleteBulkCommand type: object EmailForwardDeleteBulkInstance: properties: email_forward_id: anyOf: - examples: - email_forward_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: email_forward - type: 'null' description: Email forward ID to target title: Email Forward Id hostname: anyOf: - type: string - type: 'null' description: Hostname to target title: Hostname title: EmailForwardDeleteBulkInstance type: object EmailForwardDeleteBulkPayload: properties: instances: description: List of email forwards to delete (1-1000) items: $ref: '#/components/schemas/EmailForwardDeleteBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: EmailForwardDeleteBulkPayload type: object EmailForwardDisableBulkCommand: properties: command: const: email_forward_disable_bulk default: email_forward_disable_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/EmailForwardDisableBulkPayload' description: Bulk email forward disable payload version: default: v1 description: Command version title: Version type: string required: - payload title: EmailForwardDisableBulkCommand type: object EmailForwardDisableBulkInstance: properties: email_forward_id: anyOf: - examples: - email_forward_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: email_forward - type: 'null' description: Email forward ID to target title: Email Forward Id hostname: anyOf: - type: string - type: 'null' description: Hostname to target title: Hostname title: EmailForwardDisableBulkInstance type: object EmailForwardDisableBulkPayload: properties: instances: description: List of email forwards to disable (1-1000) items: $ref: '#/components/schemas/EmailForwardDisableBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: EmailForwardDisableBulkPayload type: object EmailForwardEnableBulkCommand: properties: command: const: email_forward_enable_bulk default: email_forward_enable_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/EmailForwardEnableBulkPayload' description: Bulk email forward enable payload version: default: v1 description: Command version title: Version type: string required: - payload title: EmailForwardEnableBulkCommand type: object EmailForwardEnableBulkInstance: properties: email_forward_id: anyOf: - examples: - email_forward_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: email_forward - type: 'null' description: Email forward ID to target title: Email Forward Id hostname: anyOf: - type: string - type: 'null' description: Hostname to target title: Hostname title: EmailForwardEnableBulkInstance type: object EmailForwardEnableBulkPayload: properties: instances: description: List of email forwards to enable (1-1000) items: $ref: '#/components/schemas/EmailForwardEnableBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: EmailForwardEnableBulkPayload type: object EmailForwardLog: properties: created_on: description: Timestamp when email was received by ImprovMX format: date-time title: Created On type: string domain: description: Domain name title: Domain type: string events: description: List of processing events items: $ref: '#/components/schemas/EmailForwardLogEvent' title: Events type: array final_status: $ref: '#/components/schemas/EmailForwardLogStatus' description: Final status of the email (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE) forward_email: description: Forward destination email address title: Forward Email type: string forward_name: anyOf: - type: string - type: 'null' description: Forward destination name title: Forward Name hostname: description: Hostname that received the email title: Hostname type: string log_id: description: Unique ID of the log from ImprovMX title: Log Id type: string message_id: description: Email message ID title: Message Id type: string recipient_email: description: Recipient email address (the alias) title: Recipient Email type: string recipient_name: anyOf: - type: string - type: 'null' description: Recipient name title: Recipient Name sender_email: description: Sender email address title: Sender Email type: string sender_name: anyOf: - type: string - type: 'null' description: Sender name title: Sender Name subject: description: Email subject title: Subject type: string synced_on: description: Timestamp when record was synced to ClickHouse format: date-time title: Synced On type: string transport: description: Transport method (mx or smtp) title: Transport type: string required: - log_id - domain - sender_email - recipient_email - forward_email - subject - hostname - message_id - transport - final_status - created_on - synced_on title: EmailForwardLog type: object EmailForwardLogEvent: properties: code: description: Event status code title: Code type: integer created: description: Timestamp when the event occurred format: date-time title: Created type: string id: description: Event ID title: Id type: string local: description: ImprovMX server that processed the event title: Local type: string message: description: Event message title: Message type: string server: description: Server that processed the event title: Server type: string status: description: Event status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE) title: Status type: string required: - code - created - id - local - message - server - status title: EmailForwardLogEvent type: object EmailForwardLogSortField: enum: - log_id - sender_email - recipient_email - forward_email - final_status - created_on - synced_on title: EmailForwardLogSortField type: string EmailForwardLogStatus: enum: - UNKNOWN - QUEUED - DELIVERED - REFUSED - SOFT-BOUNCE - HARD-BOUNCE title: EmailForwardLogStatus type: string EmailForwardMetrics: properties: alias_count: anyOf: - type: integer - type: 'null' description: Number of aliases title: Alias Count by_alias: anyOf: - items: $ref: '#/components/schemas/EmailForwardAliasMetrics' type: array - type: 'null' description: Metrics breakdown per alias title: By Alias by_status: additionalProperties: type: integer description: Log counts grouped by status (QUEUED, DELIVERED, REFUSED, SOFT-BOUNCE, HARD-BOUNCE) propertyNames: $ref: '#/components/schemas/EmailForwardLogStatus' title: By Status type: object filters: $ref: '#/components/schemas/EmailForwardMetricsFilters' description: Applied filters rates: $ref: '#/components/schemas/EmailForwardMetricsRates' description: Rate percentages for each status total_logs: description: Total number of email forward logs title: Total Logs type: integer required: - total_logs - by_status - rates - filters title: EmailForwardMetrics type: object EmailForwardMetricsFilters: properties: domain: description: Domain name title: Domain type: string end_time: anyOf: - type: string - type: 'null' description: End time filter (RFC3339) title: End Time include_aliases: anyOf: - type: boolean - type: 'null' description: Whether alias breakdown is included title: Include Aliases start_time: anyOf: - type: string - type: 'null' description: Start time filter (RFC3339) title: Start Time required: - domain title: EmailForwardMetricsFilters type: object EmailForwardMetricsRates: properties: bounce_rate: description: Bounce rate percentage title: Bounce Rate type: number delivery_rate: description: Delivery rate percentage title: Delivery Rate type: number queued_rate: description: Queued rate percentage title: Queued Rate type: number refused_rate: description: Refused rate percentage title: Refused Rate type: number required: - delivery_rate - refused_rate - queued_rate - bounce_rate title: EmailForwardMetricsRates type: object EmailForwardResponse: properties: aliases: items: $ref: '#/components/schemas/EmailForwardAlias' title: Aliases type: array created_on: format: date-time title: Created On type: string email_forward_id: examples: - email_forward_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Email Forward Id type: string x-typeid-prefix: email_forward enabled: title: Enabled type: boolean hostname: title: Hostname type: string updated_on: format: date-time title: Updated On type: string required: - email_forward_id - hostname - enabled - aliases - created_on - updated_on title: EmailForwardResponse type: object EmailForwardSortField: enum: - hostname - enabled - created_on - updated_on title: EmailForwardSortField type: string EmailForwardUpdateBulkCommand: properties: command: const: email_forward_update_bulk default: email_forward_update_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/EmailForwardUpdateBulkPayload' description: Bulk email forward update payload version: default: v1 description: Command version title: Version type: string required: - payload title: EmailForwardUpdateBulkCommand type: object EmailForwardUpdateBulkInstance: properties: aliases: anyOf: - items: $ref: '#/components/schemas/EmailForwardAliasCreate' type: array - type: 'null' description: Override aliases (replace-all) title: Aliases email_forward_id: anyOf: - examples: - email_forward_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^email_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: email_forward - type: 'null' description: Email forward ID to target title: Email Forward Id enabled: anyOf: - type: boolean - type: 'null' description: Override enabled setting title: Enabled hostname: anyOf: - type: string - type: 'null' description: Hostname to target title: Hostname title: EmailForwardUpdateBulkInstance type: object EmailForwardUpdateBulkPayload: properties: instances: description: List of email forwards to update (1-1000) items: $ref: '#/components/schemas/EmailForwardUpdateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/EmailForwardUpdateBulkTemplate' description: Shared settings for all email forwards required: - template - instances title: EmailForwardUpdateBulkPayload type: object EmailForwardUpdateBulkTemplate: properties: aliases: anyOf: - items: $ref: '#/components/schemas/EmailForwardAliasCreate' type: array - type: 'null' description: Aliases to set (replace-all) title: Aliases enabled: description: Whether email forwarding should be enabled title: Enabled type: boolean required: - enabled title: EmailForwardUpdateBulkTemplate type: object EmailForwardZone: properties: email_forwards: items: $ref: '#/components/schemas/EmailForwardResponse' title: Email Forwards type: array zone_id: examples: - zone_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^zone_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Zone Id type: string x-typeid-prefix: zone zone_name: title: Zone Name type: string required: - zone_id - zone_name - email_forwards title: EmailForwardZone type: object EmailForwardZoneSortField: enum: - name - created_on - updated_on title: EmailForwardZoneSortField type: string EmailForwardsContext: properties: context_id: examples: - ctx_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^ctx_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Context Id type: string x-typeid-prefix: ctx conversation_id: examples: - conv_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Conversation Id type: string x-typeid-prefix: conv created_at: format: date-time title: Created At type: string kind: const: email_forwards default: email_forwards title: Kind type: string organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization payload: $ref: '#/components/schemas/ContextPayload_EmailForwardResponse_' user_id: title: User Id type: string required: - context_id - conversation_id - organization_id - user_id - created_at - payload title: EmailForwardsContext type: object EmailForwardsContextCreate: properties: kind: const: email_forwards default: email_forwards title: Kind type: string payload: $ref: '#/components/schemas/ContextPayload_EmailForwardResponse_' required: - payload title: EmailForwardsContextCreate type: object EmailVerificationPolicy: properties: communication: $ref: '#/components/schemas/Communication' contact_roles: description: For which type of Contacts this verification needs to be done items: $ref: '#/components/schemas/DomainContactType' title: Contact Roles type: array enabled: description: Whether this Verification is enabled title: Enabled type: boolean suspension_delay: description: After how many Days should the domain be suspended title: Suspension Delay type: string suspension_on_failure: description: Should the Domain be suspended if the verification was not successfull title: Suspension On Failure type: boolean trigger: description: The operations that will trigger this verification items: type: string title: Trigger type: array validity_period: anyOf: - $ref: '#/components/schemas/PeriodStr' - type: 'null' verification_method: title: Verification Method type: string required: - enabled - contact_roles - trigger - validity_period - suspension_on_failure - suspension_delay - verification_method - communication title: EmailVerificationPolicy type: object EmailVerificationStatus: enum: - verified - pending - canceled title: EmailVerificationStatus type: string EventData: properties: details: anyOf: - discriminator: mapping: domain_renewal: '#/components/schemas/DomainRenewalDetails' domain_verification: '#/components/schemas/DomainVerificationDetails' propertyName: detail_type oneOf: - $ref: '#/components/schemas/DomainRenewalDetails' - $ref: '#/components/schemas/DomainVerificationDetails' - type: 'null' title: Details error: anyOf: - $ref: '#/components/schemas/EventError' - type: 'null' message: title: Message type: string version: $ref: '#/components/schemas/EventVersion' default: '1.0' required: - message title: EventData type: object EventError: properties: code: title: Code type: string detail: title: Detail type: string required: - code - detail title: EventError type: object EventObjectType: enum: - DOMAIN - CONTACT - HOST - ACCOUNT - VANITY_NS_SET - RAW - UNKNOWN title: EventObjectType type: string EventResponse: properties: acknowledged_on: anyOf: - format: date-time type: string - type: 'null' description: When the event was acknowledged title: Acknowledged On created_on: description: When the event was created format: date-time title: Created On type: string event_data: $ref: '#/components/schemas/EventData' event_id: examples: - event_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^event_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Event Id type: string x-typeid-prefix: event object_id: anyOf: - type: string - type: 'null' description: The id of the object that the event is about title: Object Id object_type: $ref: '#/components/schemas/EventObjectType' default: RAW description: The type of object that the event is about subtype: anyOf: - $ref: '#/components/schemas/EventSubtype' - type: 'null' description: The specific type/result of operation (considering the type property), more detailed (e.g., 'NOTIFICATION' with the 'DOMAIN_MODIFICATION' class) type: anyOf: - $ref: '#/components/schemas/EventType' - type: 'null' description: The type of the event - indicates the kind of operation occurring (e.g., 'ACCOUNT_CREATE', 'DOMAIN_MODIFICATION') required: - event_data - created_on title: EventResponse type: object EventSortField: enum: - object_id - created_on title: EventSortField type: string EventSubtype: enum: - NOTIFICATION - SUCCESS - FAILURE - CANCELED title: EventSubtype type: string EventType: enum: - REGISTRATION - RENEWAL - MODIFICATION - DELETION - INBOUND_TRANSFER - OUTBOUND_TRANSFER - TRANSIT - WITHDRAW - VERIFICATION - BALANCE - VANITY_NS_PROVISION - VANITY_NS_SUSPENSION - VANITY_NS_RESTORATION - VANITY_NS_TERMINATION - CLONE title: EventType type: string EventVersion: enum: - '1.0' title: EventVersion type: string ExecutingEntity: enum: - user - organization - system title: ExecutingEntity type: string Footer: properties: legal_entity: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' title: Legal Entity lines: anyOf: - items: maxLength: 255 minLength: 1 type: string type: array - type: 'null' title: Lines vat_id: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' title: Vat Id title: Footer type: object GeneralAvailabilityBase: properties: start_date: description: Start date of general availability format: date-time title: Start Date type: string required: - start_date title: GeneralAvailabilityBase type: object GeoStatsBucket: properties: key: title: Key type: string total: title: Total type: integer required: - key - total title: GeoStatsBucket type: object GetPricesResponse: properties: prices: description: List of prices items: $ref: '#/components/schemas/PriceInfo' title: Prices type: array required: - prices title: GetPricesResponse type: object HTTPMethod: description: "HTTP methods and descriptions\n\nMethods from the following RFCs\ \ are all observed:\n\n * RFC 9110: HTTP Semantics, obsoletes 7231, which\ \ obsoleted 2616\n * RFC 5789: PATCH Method for HTTP" enum: - CONNECT - DELETE - GET - HEAD - OPTIONS - PATCH - POST - PUT - TRACE title: HTTPMethod type: string HTTPValidationError: properties: errors: items: $ref: '#/components/schemas/ValidationError' type: array status: title: Status code type: integer title: title: Problem title type: string type: title: Problem type type: string required: - type - title - status - errors title: RequestValidationError type: object HolderEntitlement: enum: - owner - assignee - licensee title: HolderEntitlement type: string HostCreate: properties: hostname: description: Hostname of the host object examples: - ns1.example.com title: Hostname type: string ip_addresses: description: List of IP addresses for the host object examples: - - 192.0.2.53 - 2001:db8::53 items: format: ipvanyaddress type: string minItems: 1 title: Ip Addresses type: array required: - hostname - ip_addresses title: HostCreate type: object HostIpSchema: properties: address: description: IP address of the host object format: ipvanyaddress title: Address type: string created_on: description: The date/time the entry was created on format: date-time title: Created On type: string host_id: default: None examples: - host_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Host Id type: string x-typeid-prefix: host host_ip_id: examples: - host_ip_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^host_ip_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Host Ip Id type: string x-typeid-prefix: host_ip type: $ref: '#/components/schemas/IPAddressType' description: IP address type updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string required: - address - type title: HostIpSchema type: object HostResponse: properties: created_on: description: Timestamp when the host was created format: date-time title: Created On type: string host_id: description: Unique identifier of the host object examples: - host_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Host Id type: string x-typeid-prefix: host hostname: description: Hostname of the host object examples: - ns1.example.com title: Hostname type: string ip_addresses: description: The ip addresses of the Host Object items: format: ipvanyaddress type: string title: Ip Addresses type: array updated_on: description: Timestamp when the host was last updated format: date-time title: Updated On type: string required: - host_id - hostname - created_on - updated_on title: HostResponse type: object HostSchema: properties: created_on: description: The date/time the entry was created on format: date-time title: Created On type: string domain_id: default: None description: The domain that the host object belongs to examples: - domain_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Domain Id type: string x-typeid-prefix: domain host_id: examples: - host_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^host_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Host Id type: string x-typeid-prefix: host hostname: description: Hostname of the host object title: Hostname type: string registry_account_id: anyOf: - examples: - registry_account_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^registry_account_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: registry_account - type: 'null' description: The registry account that the host object belongs to title: Registry Account Id status: $ref: '#/components/schemas/HostStatus' default: inactive description: Status of the host object updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string required: - hostname title: HostSchema type: object HostStatus: enum: - requested_create - pending_create - active - inactive - pending_delete title: HostStatus type: string HostUpdate: properties: ip_addresses: description: List of IP addresses for the host object examples: - - 192.0.2.53 - 2001:db8::53 items: format: ipvanyaddress type: string minItems: 1 title: Ip Addresses type: array required: - ip_addresses title: HostUpdate type: object HttpProtocol: enum: - http - https title: HttpProtocol type: string HttpRedirectListResponse: properties: protected: default: false title: Protected type: boolean redirect_code: $ref: '#/components/schemas/RedirectCode' request_hostname: title: Request Hostname type: string request_path: title: Request Path type: string request_protocol: $ref: '#/components/schemas/HttpProtocol' request_subdomain: anyOf: - type: string - type: 'null' title: Request Subdomain target_hostname: title: Target Hostname type: string target_path: title: Target Path type: string target_protocol: $ref: '#/components/schemas/HttpProtocol' required: - request_path - target_protocol - target_hostname - target_path - redirect_code - request_protocol - request_hostname title: HttpRedirectListResponse type: object HttpRedirectRemove: properties: request_hostname: title: Request Hostname type: string request_path: title: Request Path type: string request_protocol: $ref: '#/components/schemas/HttpProtocol' request_subdomain: anyOf: - type: string - type: 'null' title: Request Subdomain required: - request_protocol - request_hostname - request_path title: HttpRedirectRemove type: object HttpRedirectRequest: properties: redirect_code: $ref: '#/components/schemas/RedirectCode' request_path: title: Request Path type: string target_hostname: title: Target Hostname type: string target_path: title: Target Path type: string target_protocol: $ref: '#/components/schemas/HttpProtocol' required: - request_path - target_protocol - target_hostname - target_path - redirect_code title: HttpRedirectRequest type: object HttpRedirectUpsert: properties: redirect_code: $ref: '#/components/schemas/RedirectCode' request_hostname: title: Request Hostname type: string request_path: title: Request Path type: string request_protocol: $ref: '#/components/schemas/HttpProtocol' request_subdomain: anyOf: - type: string - type: 'null' title: Request Subdomain target_hostname: title: Target Hostname type: string target_path: title: Target Path type: string target_protocol: $ref: '#/components/schemas/HttpProtocol' required: - request_path - target_protocol - target_hostname - target_path - redirect_code - request_protocol - request_hostname title: HttpRedirectUpsert type: object IPAddressType: enum: - v4 - v6 title: IPAddressType type: string IdentityVerificationPolicy: description: 'A registry that requires the contact to have been identity-verified before it accepts it. The vocabulary is the contact-verification service''s, because that service is what the claims are checked against. What a registry accepts as evidence is a policy of its own and does not follow from the claim: `.dk` wants a photo ID for `NAME`, while a registry happy with a written attestation would leave `accepted_proofs` out.' properties: contact_roles: description: For which type of Contacts this verification needs to be done items: $ref: '#/components/schemas/DomainContactType' title: Contact Roles type: array enabled: description: Whether this Verification is enabled title: Enabled type: boolean required_claims: description: The claims that must be verified before a contact can be used on this TLD items: $ref: '#/components/schemas/RequiredClaim' minItems: 1 title: Required Claims type: array suspension_delay: description: After how many Days should the domain be suspended title: Suspension Delay type: string suspension_on_failure: description: Should the Domain be suspended if the verification was not successfull title: Suspension On Failure type: boolean trigger: description: The operations that will trigger this verification items: type: string title: Trigger type: array validity_period: anyOf: - $ref: '#/components/schemas/PeriodStr' - type: 'null' required: - enabled - contact_roles - trigger - validity_period - suspension_on_failure - suspension_delay - required_claims title: IdentityVerificationPolicy type: object IdnBase: properties: idn_capable: description: IDN allowed title: Idn Capable type: boolean idn_tables: anyOf: - items: type: string type: array - type: 'null' description: Allowed IDN characters, file with the IDN codes title: Idn Tables required: - idn_capable title: IdnBase type: object InvoiceDocumentType: description: 'Customer-facing document class. Orthogonal to `InvoiceResponseType`: prepaid-credit invoices are receipts, everything else billable is an invoice. Documents billing classifies as neither are never returned.' enum: - invoice - receipt title: InvoiceDocumentType type: string InvoiceResponse: properties: amount: description: Total invoice amount pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Amount type: string currency: $ref: '#/components/schemas/Currency' description: Invoice currency document_type: $ref: '#/components/schemas/InvoiceDocumentType' description: Customer-facing document class external_id: description: Lago ID (external) for this invoice title: External Id type: string fees_amount: description: Fees amount pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Fees Amount type: string file_url: anyOf: - type: string - type: 'null' description: URL to invoice PDF file title: File Url invoice_type: $ref: '#/components/schemas/InvoiceResponseType' description: Invoice type issuing_date: description: Invoice issuing date format: date-time title: Issuing Date type: string number: description: Invoice number title: Number type: string payment_due_date: description: Payment due date format: date-time title: Payment Due Date type: string payment_overdue: description: Whether payment is overdue title: Payment Overdue type: boolean payment_status: $ref: '#/components/schemas/InvoiceResponsePaymentStatus' description: Payment status status: $ref: '#/components/schemas/InvoiceResponseStatus' description: Invoice status taxes_amount: description: Taxes amount pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Taxes Amount type: string required: - external_id - number - issuing_date - payment_due_date - invoice_type - document_type - status - payment_status - payment_overdue - currency - amount - fees_amount - taxes_amount - file_url title: InvoiceResponse type: object InvoiceResponsePaymentStatus: enum: - pending - failed - succeeded title: InvoiceResponsePaymentStatus type: string InvoiceResponseStatus: enum: - draft - finalized - failed - pending - voided title: InvoiceResponseStatus type: string InvoiceResponseType: enum: - subscription - add_on - credit - one_off - advance_charges - progressive_billing title: InvoiceResponseType type: string IpRestrictionCreate: description: 'Create an IP restriction for an organization. Accepts either a single IP address or a CIDR network range. Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).' properties: ip_network: description: IP address or CIDR network range. Individual IPs can be specified without CIDR notation. examples: - 192.0.2.1 - 192.0.2.0/24 - 2001:db8::1 - 2001:db8::/32 format: ipvanynetwork title: Ip Network type: string organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization required: - ip_network title: IpRestrictionCreate type: object IpRestrictionResponse: properties: created_on: format: date-time title: Created On type: string ip_network: description: IP address or CIDR network range. Single IPs are returned with /32 (IPv4) or /128 (IPv6) notation. examples: - 192.0.2.1/32 - 192.0.2.0/24 - 2001:db8::1/128 - 2001:db8::/32 format: ipvanynetwork title: Ip Network type: string ip_restriction_id: title: Ip Restriction Id type: integer last_used_on: anyOf: - format: date-time type: string - type: 'null' title: Last Used On organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization required: - ip_restriction_id - organization_id - ip_network - created_on title: IpRestrictionResponse type: object IpRestrictionUpdate: description: 'Update an existing IP restriction. You can update the IP network range or the last usage timestamp.' properties: ip_network: anyOf: - format: ipvanynetwork type: string - type: 'null' description: IP address or CIDR network range to replace the existing restriction. examples: - 192.0.2.1 - 192.0.2.0/24 - 2001:db8::1 - 2001:db8::/32 title: Ip Network last_used_on: anyOf: - format: date-time type: string - type: 'null' description: Timestamp of the last usage. title: Last Used On title: IpRestrictionUpdate type: object JobBatchMetadataResponse: properties: batch_id: description: TypeID identifying this batch examples: - batch_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Batch Id type: string x-typeid-prefix: batch created_on: description: Timestamp when the batch was created (UTC) format: date-time title: Created On type: string finished_at: anyOf: - format: date-time type: string - type: 'null' description: Timestamp when the last job finished (UTC) title: Finished At job_counts: $ref: '#/components/schemas/JobCountsByStatus' description: Number of jobs in each status label: anyOf: - type: string - type: 'null' description: Human-readable label for this batch title: Label started_at: anyOf: - format: date-time type: string - type: 'null' description: Timestamp when the first job started (UTC) title: Started At status: $ref: '#/components/schemas/BatchStatus' description: 'Batch status: pending (jobs still processing) or complete (all done)' total_jobs: description: Total number of jobs in this batch title: Total Jobs type: integer required: - batch_id - status - job_counts - total_jobs - created_on title: JobBatchMetadataResponse type: object JobBatchRequest: properties: commands: description: List of commands to execute items: discriminator: mapping: contact_create: '#/components/schemas/ContactCreateCommand' contact_create_bulk: '#/components/schemas/ContactCreateBulkCommand' dns_zone_create: '#/components/schemas/DnsZoneCreateCommand' dns_zone_create_bulk: '#/components/schemas/DnsZoneCreateBulkCommand' dns_zone_patch_records_bulk: '#/components/schemas/DnsZonePatchRecordsBulkCommand' dns_zone_patch_rrsets_bulk: '#/components/schemas/DnsZonePatchRrsetsBulkCommand' dns_zone_restamp_vanity_ns_bulk: '#/components/schemas/DnsZoneRestampVanityNsBulkCommand' dns_zone_update: '#/components/schemas/DnsZoneUpdateCommand' dns_zone_update_bulk: '#/components/schemas/DnsZoneUpdateBulkCommand' domain_create: '#/components/schemas/DomainCreateCommand' domain_create_bulk: '#/components/schemas/DomainCreateBulkCommand' domain_forward_create_bulk: '#/components/schemas/DomainForwardCreateBulkCommand' domain_forward_delete_bulk: '#/components/schemas/DomainForwardDeleteBulkCommand' domain_forward_disable_bulk: '#/components/schemas/DomainForwardDisableBulkCommand' domain_forward_enable_bulk: '#/components/schemas/DomainForwardEnableBulkCommand' domain_forward_update_bulk: '#/components/schemas/DomainForwardUpdateBulkCommand' domain_transfer: '#/components/schemas/DomainTransferCommand' domain_transfer_bulk: '#/components/schemas/DomainTransferBulkCommand' domain_update: '#/components/schemas/DomainUpdateCommand' domain_update_bulk: '#/components/schemas/DomainUpdateBulkCommand' email_forward_create_bulk: '#/components/schemas/EmailForwardCreateBulkCommand' email_forward_delete_bulk: '#/components/schemas/EmailForwardDeleteBulkCommand' email_forward_disable_bulk: '#/components/schemas/EmailForwardDisableBulkCommand' email_forward_enable_bulk: '#/components/schemas/EmailForwardEnableBulkCommand' email_forward_update_bulk: '#/components/schemas/EmailForwardUpdateBulkCommand' parking_create_bulk: '#/components/schemas/ParkingCreateBulkCommand' parking_delete_bulk: '#/components/schemas/ParkingDeleteBulkCommand' parking_disable_bulk: '#/components/schemas/ParkingDisableBulkCommand' parking_enable_bulk: '#/components/schemas/ParkingEnableBulkCommand' propertyName: command oneOf: - $ref: '#/components/schemas/DomainCreateCommand' - $ref: '#/components/schemas/DomainUpdateCommand' - $ref: '#/components/schemas/DomainTransferCommand' - $ref: '#/components/schemas/DnsZoneCreateCommand' - $ref: '#/components/schemas/DnsZoneUpdateCommand' - $ref: '#/components/schemas/DomainCreateBulkCommand' - $ref: '#/components/schemas/DomainTransferBulkCommand' - $ref: '#/components/schemas/DomainUpdateBulkCommand' - $ref: '#/components/schemas/DnsZoneCreateBulkCommand' - $ref: '#/components/schemas/DnsZoneUpdateBulkCommand' - $ref: '#/components/schemas/DnsZonePatchRrsetsBulkCommand' - $ref: '#/components/schemas/DnsZonePatchRecordsBulkCommand' - $ref: '#/components/schemas/DnsZoneRestampVanityNsBulkCommand' - $ref: '#/components/schemas/ContactCreateBulkCommand' - $ref: '#/components/schemas/ContactCreateCommand' - $ref: '#/components/schemas/ParkingCreateBulkCommand' - $ref: '#/components/schemas/ParkingEnableBulkCommand' - $ref: '#/components/schemas/ParkingDisableBulkCommand' - $ref: '#/components/schemas/ParkingDeleteBulkCommand' - $ref: '#/components/schemas/EmailForwardCreateBulkCommand' - $ref: '#/components/schemas/EmailForwardEnableBulkCommand' - $ref: '#/components/schemas/EmailForwardDisableBulkCommand' - $ref: '#/components/schemas/EmailForwardDeleteBulkCommand' - $ref: '#/components/schemas/EmailForwardUpdateBulkCommand' - $ref: '#/components/schemas/DomainForwardCreateBulkCommand' - $ref: '#/components/schemas/DomainForwardUpdateBulkCommand' - $ref: '#/components/schemas/DomainForwardEnableBulkCommand' - $ref: '#/components/schemas/DomainForwardDisableBulkCommand' - $ref: '#/components/schemas/DomainForwardDeleteBulkCommand' maxItems: 50000 title: Commands type: array label: anyOf: - type: string - type: 'null' description: Human-readable label for this batch title: Label not_before: anyOf: - format: date-time type: string - type: 'null' description: Earliest time jobs can execute (UTC). If not provided, jobs run immediately. title: Not Before paused: default: false description: If true, jobs are created in paused state and must be explicitly resumed title: Paused type: boolean required: - commands title: JobBatchRequest type: object JobBatchRetryResponse: properties: batch_id: description: TypeID identifying this batch examples: - batch_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Batch Id type: string x-typeid-prefix: batch blocked_count: default: 0 description: Number of retried jobs held behind the topic rate limit or backlog (BLOCKED) title: Blocked Count type: integer queued_count: default: 0 description: Number of retried jobs dispatched immediately (QUEUED) title: Queued Count type: integer retried_count: description: Number of FAILED/DEAD_LETTER jobs reset for retry title: Retried Count type: integer required: - batch_id - retried_count title: JobBatchRetryResponse type: object JobBatchStatusResponse: properties: batch_id: description: TypeID identifying this batch. All jobs in a batch share the same batch_id, while each job has its own unique job_id. examples: - batch_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^batch_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Batch Id type: string x-typeid-prefix: batch blocked: default: 0 description: Number of jobs waiting for eligibility (scheduled, serial blocked, or no tokens) title: Blocked type: integer canceled: description: Number of jobs that were canceled title: Canceled type: integer dead_letter: description: Number of jobs that permanently failed after exhausting retries title: Dead Letter type: integer failed: description: Number of jobs that failed execution title: Failed type: integer label: anyOf: - type: string - type: 'null' description: Human-readable label for this batch title: Label paused: default: 0 description: Number of jobs in paused state title: Paused type: integer progress_percentage: description: Percentage of jobs in a terminal state (succeeded, failed, canceled, or dead_letter), 0-100 title: Progress Percentage type: number queued: description: Number of jobs awaiting processing title: Queued type: integer running: description: Number of jobs currently being executed title: Running type: integer succeeded: description: Number of jobs that completed successfully title: Succeeded type: integer total: description: Total number of jobs in the batch title: Total type: integer required: - batch_id - total - queued - running - succeeded - failed - canceled - dead_letter - progress_percentage title: JobBatchStatusResponse type: object JobCountsByStatus: properties: blocked: default: 0 title: Blocked type: integer canceled: default: 0 title: Canceled type: integer dead_letter: default: 0 title: Dead Letter type: integer failed: default: 0 title: Failed type: integer paused: default: 0 title: Paused type: integer queued: default: 0 title: Queued type: integer running: default: 0 title: Running type: integer succeeded: default: 0 title: Succeeded type: integer title: JobCountsByStatus type: object JobResponse: properties: attempts: description: Number of execution attempts made for this job title: Attempts type: integer command: anyOf: - type: string - type: 'null' description: Command name (e.g., 'domain_create', 'dns_zone_update') title: Command created_on: description: Timestamp when the job was created (UTC) format: date-time title: Created On type: string display: anyOf: - type: string - type: 'null' description: Human-readable description of this job title: Display domain_name: anyOf: - type: string - type: 'null' description: Domain name associated with this job title: Domain Name error_class: anyOf: - type: string - type: 'null' description: Error type if the job failed (e.g., ValidationError, TimeoutError) title: Error Class error_code: anyOf: - type: string - type: 'null' description: Stable semantic error code propagated verbatim from the failing upstream service (e.g. 'ERROR_DOMAIN_TRANSFER_INVALID_AUTH_CODE'). Suitable for i18n / per-error UI branching. Null when the job did not fail or the upstream error did not carry a code. title: Error Code error_details: anyOf: - additionalProperties: true type: object - type: 'null' description: "Full upstream problem-details payload (RFC 9457) preserved\ \ verbatim \u2014 e.g. type/title/status/code/detail plus service-specific\ \ extras like domain_name, reason. Null when the failure didn't originate\ \ from a typed upstream response." title: Error Details error_message: anyOf: - type: string - type: 'null' description: Detailed error message if the job failed title: Error Message finished_at: anyOf: - format: date-time type: string - type: 'null' description: Timestamp when job execution completed (UTC) title: Finished At job_id: description: Unique identifier for this individual job examples: - job_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^job_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Job Id type: string x-typeid-prefix: job operation: anyOf: - type: string - type: 'null' description: Operation type (e.g., 'create', 'update', 'transfer') title: Operation paused_at: anyOf: - format: date-time type: string - type: 'null' description: Timestamp when job was paused (UTC) title: Paused At payload: anyOf: - discriminator: mapping: contact_create: '#/components/schemas/ContactCreateWorkerPayload' contact_create_bulk: '#/components/schemas/ContactCreateWorkerPayload' dns_zone_create: '#/components/schemas/DnsZoneCreateWorkerPayload' dns_zone_create_bulk: '#/components/schemas/DnsZoneCreateWorkerPayload' dns_zone_patch_records_bulk: '#/components/schemas/DnsZonePatchRecordsWorkerPayload' dns_zone_patch_rrsets_bulk: '#/components/schemas/DnsZonePatchRrsetsWorkerPayload' dns_zone_restamp_vanity_ns_bulk: '#/components/schemas/DnsZoneRestampVanityNsWorkerPayload' dns_zone_update: '#/components/schemas/DnsZoneUpdateWorkerPayload' dns_zone_update_bulk: '#/components/schemas/DnsZoneUpdateWorkerPayload' domain_create: '#/components/schemas/DomainCreateWorkerPayload' domain_create_bulk: '#/components/schemas/DomainCreateWorkerPayload' domain_transfer: '#/components/schemas/DomainTransferWorkerPayload' domain_transfer_bulk: '#/components/schemas/DomainTransferWorkerPayload' domain_update: '#/components/schemas/DomainUpdateWorkerPayload' domain_update_bulk: '#/components/schemas/DomainUpdateWorkerPayload' parking_create_bulk: '#/components/schemas/ParkingCreateWorkerPayload' parking_delete_bulk: '#/components/schemas/ParkingDeleteWorkerPayload' parking_disable_bulk: '#/components/schemas/ParkingDisableWorkerPayload' parking_enable_bulk: '#/components/schemas/ParkingEnableWorkerPayload' propertyName: type oneOf: - $ref: '#/components/schemas/DomainCreateWorkerPayload' - $ref: '#/components/schemas/DomainUpdateWorkerPayload' - $ref: '#/components/schemas/DomainTransferWorkerPayload' - $ref: '#/components/schemas/DnsZoneCreateWorkerPayload' - $ref: '#/components/schemas/DnsZoneUpdateWorkerPayload' - $ref: '#/components/schemas/DnsZonePatchRrsetsWorkerPayload' - $ref: '#/components/schemas/DnsZonePatchRecordsWorkerPayload' - $ref: '#/components/schemas/DnsZoneRestampVanityNsWorkerPayload' - $ref: '#/components/schemas/ContactCreateWorkerPayload' - $ref: '#/components/schemas/ParkingCreateWorkerPayload' - $ref: '#/components/schemas/ParkingEnableWorkerPayload' - $ref: '#/components/schemas/ParkingDisableWorkerPayload' - $ref: '#/components/schemas/ParkingDeleteWorkerPayload' - additionalProperties: true type: object - type: 'null' description: The original request payload for this job title: Payload resource_key: anyOf: - type: string - type: 'null' description: Resource identifier for this job title: Resource Key result: anyOf: - discriminator: mapping: contact_create: '#/components/schemas/ContactCreateWorkerResult' contact_create_bulk: '#/components/schemas/ContactCreateWorkerResult' dns_zone_create: '#/components/schemas/DnsZoneCreateWorkerResult' dns_zone_create_bulk: '#/components/schemas/DnsZoneCreateWorkerResult' domain_create: '#/components/schemas/DomainCreateWorkerResult' domain_create_bulk: '#/components/schemas/DomainCreateWorkerResult' propertyName: type oneOf: - $ref: '#/components/schemas/ContactCreateWorkerResult' - $ref: '#/components/schemas/DomainCreateWorkerResult' - $ref: '#/components/schemas/DnsZoneCreateWorkerResult' - additionalProperties: true type: object - type: 'null' description: Structured result data from successful job execution (e.g. created entity IDs). Typed when the worker emits a known `type` discriminator; raw dict otherwise. title: Result started_at: anyOf: - format: date-time type: string - type: 'null' description: Timestamp when job execution began (UTC) title: Started At status: $ref: '#/components/schemas/JobStatus' description: 'Current job status: blocked, queued, paused, running, succeeded, failed, canceled, or dead_letter' required: - job_id - status - created_on - attempts title: JobResponse type: object JobStatus: enum: - blocked - queued - paused - running - succeeded - failed - canceled - dead_letter title: JobStatus type: string JsonValue: {} LaunchPhaseBase: properties: allocation: anyOf: - $ref: '#/components/schemas/AllocationMethodType' - type: 'null' description: Allocation method end_date: anyOf: - format: date-time type: string - type: 'null' description: End date of the phase title: End Date smd_required: anyOf: - type: boolean - type: 'null' description: Whether an SMD file is required for participation title: Smd Required start_date: anyOf: - format: date-time type: string - type: 'null' description: Start date of the phase title: Start Date supported: description: Whether this phase is supported title: Supported type: boolean type: $ref: '#/components/schemas/LaunchPhaseType' description: Type of launch phase required: - type - supported title: LaunchPhaseBase type: object LaunchPhaseType: enum: - sunrise - landrush - eap title: LaunchPhaseType type: string LaunchPhasesBase: properties: general_availability: $ref: '#/components/schemas/GeneralAvailabilityBase' phases: default: [] items: $ref: '#/components/schemas/LaunchPhaseBase' title: Phases type: array trademark_claims: anyOf: - $ref: '#/components/schemas/TrademarkClaimsBase' - type: 'null' required: - general_availability title: LaunchPhasesBase type: object Legal: properties: privacy_url: anyOf: - type: string - type: 'null' title: Privacy Url terms_url: anyOf: - type: string - type: 'null' title: Terms Url title: Legal type: object LegalRequirementBase: properties: key: description: Unique identifier for the legal requirement title: Key type: string operations: description: Operations this requirement applies to items: $ref: '#/components/schemas/LegalRequirementOperationType' title: Operations type: array type: $ref: '#/components/schemas/LegalRequirementType' description: Whether this is an informational notice or requires explicit confirmation url: anyOf: - format: uri maxLength: 2083 minLength: 1 type: string - type: 'null' description: Link to the legal document title: Url required: - key - type - operations title: LegalRequirementBase type: object LegalRequirementOperationType: enum: - registration - transfer - renewal - registrant_change title: LegalRequirementOperationType type: string LegalRequirementType: enum: - notice - confirmation title: LegalRequirementType type: string LevelOfAssurance: enum: - HIGH - LOW - SUBSTANTIAL title: LevelOfAssurance type: string ListBrandingAssetsResponse: properties: assets: description: Uploaded assets, most recent first items: $ref: '#/components/schemas/BrandingAsset' title: Assets type: array title: ListBrandingAssetsResponse type: object ListVanityNameserverSetsRes: properties: pagination: $ref: '#/components/schemas/PaginationMetadataDTO' description: Pagination metadata results: description: Sets owned by the org, newest first; includes non-ACTIVE rows items: $ref: '#/components/schemas/VanityNameserverSetSummaryDTO' title: Results type: array required: - pagination title: ListVanityNameserverSetsRes type: object ListZonesReferencingSetRes: properties: pagination: $ref: '#/components/schemas/PaginationMetadataDTO' description: Pagination metadata results: description: Zones whose apex is branded by the set, ordered by zone name items: $ref: '#/components/schemas/DnsZoneDTO' title: Results type: array required: - pagination title: ListZonesReferencingSetRes type: object LocalPresenceBase: properties: eligible_countries: anyOf: - items: pattern: ^\w{2}$ type: string type: array - type: 'null' description: ISO 3166-1 Alpha-2 country code title: Eligible Countries exemptions: anyOf: - items: $ref: '#/components/schemas/AttributeCondition' type: array - type: 'null' title: Exemptions required: description: Whether a local presence is required to register and maintain a domain name title: Required type: boolean requirement: anyOf: - items: $ref: '#/components/schemas/LocalPresenceRequirementType' type: array - type: 'null' description: Type of local presence requirement title: Requirement type: anyOf: - items: $ref: '#/components/schemas/DomainContactType' type: array - type: 'null' description: Who must meet the requirement title: Type required: - required title: LocalPresenceBase type: object LocalPresenceRequirementType: enum: - physical_address - business_entity title: LocalPresenceRequirementType type: string Logo: properties: dark: anyOf: - type: string - type: 'null' title: Dark favicon: anyOf: - type: string - type: 'null' title: Favicon icon: anyOf: - type: string - type: 'null' title: Icon light: anyOf: - type: string - type: 'null' title: Light title: Logo type: object MailTemplate: description: One editable transactional email template in the catalog. properties: blocks: additionalProperties: $ref: '#/components/schemas/MailTemplateBlock' description: Org-editable content blocks title: Blocks type: object category: $ref: '#/components/schemas/MailTemplateCategory' default: unknown description: Template category for grouping in the editor label: default: '' description: Human-readable template name for display title: Label type: string locales: description: Supported locales, first is the fallback items: type: string title: Locales type: array subject: additionalProperties: type: string description: Subject line per locale title: Subject type: object variables: additionalProperties: $ref: '#/components/schemas/MailTemplateVariable' description: Per-send variables title: Variables type: object version: default: '' description: Template revision (major.minor) title: Version type: string title: MailTemplate type: object MailTemplateBlock: properties: default: additionalProperties: type: string description: Default copy per locale title: Default type: object label: default: '' description: Human-readable field name for the editor title: Label type: string max_len: default: 0 description: Maximum override text length title: Max Len type: integer multiline: default: false description: Render the editor field as a textarea title: Multiline type: boolean title: MailTemplateBlock type: object MailTemplateCatalogRes: additionalProperties: $ref: '#/components/schemas/MailTemplate' description: The editable-template catalog keyed by template name. title: MailTemplateCatalogRes type: object MailTemplateCategory: description: Category a template is grouped under in the editor. An unrecognised value decodes to `unknown`. enum: - organization - billing - user_account - icann_policy - tld_specific - unknown title: MailTemplateCategory type: string MailTemplateVariable: properties: required: default: false title: Required type: boolean sample: default: '' description: Sample value shown in previews title: Sample type: string type: default: text description: Value type driving render-time escaping (text or url) title: Type type: string title: MailTemplateVariable type: object MemoryFact: properties: created_at: format: date-time title: Created At type: string expires_at: anyOf: - format: date-time type: string - type: 'null' title: Expires At fact_id: examples: - fact_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^fact_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Fact Id type: string x-typeid-prefix: fact key: maxLength: 200 title: Key type: string kind: $ref: '#/components/schemas/MemoryFactKind' organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization updated_at: format: date-time title: Updated At type: string value: additionalProperties: true title: Value type: object required: - fact_id - organization_id - kind - key - created_at - updated_at title: MemoryFact type: object MemoryFactCreateRequest: properties: key: maxLength: 200 minLength: 1 title: Key type: string kind: $ref: '#/components/schemas/MemoryFactKind' ttl_seconds: anyOf: - minimum: 1.0 type: integer - type: 'null' description: Optional TTL; if set, the fact expires after this many seconds. title: Ttl Seconds value: additionalProperties: true title: Value type: object required: - kind - key title: MemoryFactCreateRequest type: object MemoryFactKind: enum: - preference - note - other title: MemoryFactKind type: string MemoryFactListResponse: properties: next_cursor: anyOf: - type: string - type: 'null' title: Next Cursor results: items: $ref: '#/components/schemas/MemoryFact' title: Results type: array required: - results title: MemoryFactListResponse type: object MemoryFactPatchRequest: properties: ttl_seconds: anyOf: - minimum: 1.0 type: integer - type: 'null' title: Ttl Seconds value: anyOf: - additionalProperties: true type: object - type: 'null' title: Value title: MemoryFactPatchRequest type: object Message: properties: content: title: Content type: string conversation_id: examples: - conv_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^conv_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Conversation Id type: string x-typeid-prefix: conv created_at: format: date-time title: Created At type: string message_id: examples: - msg_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^msg_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Message Id type: string x-typeid-prefix: msg metadata: additionalProperties: true title: Metadata type: object role: $ref: '#/components/schemas/MessageRole' required: - message_id - conversation_id - role - content - created_at title: Message type: object MessageCreateRequest: properties: content: title: Content type: string metadata: additionalProperties: true title: Metadata type: object n8n_history_id: anyOf: - type: integer - type: 'null' description: Optional reference to the originating n8n_chat_histories row. title: N8N History Id role: $ref: '#/components/schemas/MessageRole' required: - role - content title: MessageCreateRequest type: object MessageListResponse: properties: pagination: anyOf: - $ref: '#/components/schemas/PaginationMetadata' - type: 'null' description: Omitted when the `recent` query parameter is used. results: items: $ref: '#/components/schemas/Message' title: Results type: array required: - results title: MessageListResponse type: object MessageRole: enum: - user - assistant - system - tool title: MessageRole type: string MetricsGrouping: enum: - url - fqdn - domain - forward - rule title: MetricsGrouping type: string Nameserver: properties: hostname: description: The name server of the domain examples: - ns1.example.com title: Hostname type: string ip_addresses: description: The ip addresses of the name server examples: - - 0.0.0.0 - 127.0.0.1 - - 2001:db8::1 - 2001:db8::2 items: format: ipvanyaddress type: string title: Ip Addresses type: array required: - hostname title: Nameserver type: object NizzaClaim: enum: - EMAIL - PHONE - ADDRESS - NAME - LEGAL_ENTITY title: NizzaClaim type: string NizzaVerificationProof: enum: - IDCARD - PASSPORT - POPULATION_REGISTER - RESIDENCE_PERMIT - PROOF_OF_ARRIVAL - DRIVERS_LICENCE - COMPANY_REGISTER - COMPANY_STATEMENT - BANK_ACCOUNT - ONLINE_PAYMENT_ACCOUNT - UTILITY_ACCOUNT - BANK_STATEMENT - TAX_STATEMENT - WRITTEN_ATTESTATION - DIGITAL_ATTESTATION - POSTAL_VER_TRANSACTION_LOG - EMAIL_VER_TRANSACTION_LOG - PHONE_VER_TRANSACTION_LOG - ADDRESS_DATABASE title: NizzaVerificationProof type: string NorIdDeclarationConfirmRequest: properties: accept_name: description: The full name of the person signing the applicant declaration. For private individuals this is the subscriber personally; for organizations it must be an authorized representative. maxLength: 255 minLength: 1 title: Accept Name type: string required: - accept_name title: NorIdDeclarationConfirmRequest type: object NorIdDeclarationResponse: properties: declaration_contract_text: description: The fixed Norwegian declaration contract text title: Declaration Contract Text type: string declaration_header: description: The fixed Norwegian declaration header title: Declaration Header type: string declaration_introduction: description: The fixed Norwegian declaration introduction title: Declaration Introduction type: string declaration_version: description: The applicant declaration text version title: Declaration Version type: string domain_name: description: The domain name the declaration applies to title: Domain Name type: string expires_on: description: When the unconfirmed create request expires format: date-time title: Expires On type: string identity_type: anyOf: - type: string - type: 'null' description: The subscriber identity type title: Identity Type identity_value: anyOf: - type: string - type: 'null' description: The subscriber identity (organization number or Person-ID) title: Identity Value organization_id: description: The organization that owns the domain; used to brand the page examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization status: $ref: '#/components/schemas/NorIdDeclarationStatus' description: The declaration status subscriber_name: description: The domain name subscriber (registrant) title: Subscriber Name type: string required: - organization_id - domain_name - subscriber_name - declaration_version - declaration_header - declaration_introduction - declaration_contract_text - status - expires_on title: NorIdDeclarationResponse type: object NorIdDeclarationStatus: enum: - pending - confirmed - completed - expired - failed title: NorIdDeclarationStatus type: string NorIdResellerDeclarationRequest: properties: accept_date: anyOf: - format: date-time type: string - type: 'null' description: UTC timestamp of the declaration signature. Only provide it when the declaration was signed out-of-band (e.g. via Norid's own tool); defaults to the submission time. title: Accept Date accept_name: description: The full name of the person signing the applicant declaration. For private individuals this is the subscriber personally; for organizations it must be an authorized representative. maxLength: 255 minLength: 1 title: Accept Name type: string required: - accept_name title: NorIdResellerDeclarationRequest type: object ObjectEventType: enum: - CREATED - UPDATED - DELETED - IMPORTED - SYNCED_AFTER_IMPORT - TRANSFER_STARTED - TRANSFER_COMPLETED - TRANSFER_OUT_STARTED - TRANSFER_OUT_COMPLETED - RENEWED - RESTORED - BILLING_TRANSACTION_RESERVED - BILLING_TRANSACTION_SUCCEEDED - BILLING_TRANSACTION_FAILED - BILLING_TRANSACTION_CANCELLED title: ObjectEventType type: string ObjectLog: properties: action: $ref: '#/components/schemas/ObjectEventType' description: Action performed created_on: description: Timestamp when the log was created format: date-time title: Created On type: string details: anyOf: - additionalProperties: true type: object - type: 'null' description: Changes made to the object title: Details object_id: description: ID of the object title: Object Id type: string object_log_id: description: Unique ID of the log title: Object Log Id type: string object_type: description: Type of the object title: Object Type type: string performed_by_id: anyOf: - type: string - type: 'null' description: ID of the actor who performed the action title: Performed By Id performed_by_type: anyOf: - $ref: '#/components/schemas/ExecutingEntity' - type: 'null' description: Type of the actor who performed the action server_request_id: anyOf: - type: string - type: 'null' description: Server request ID title: Server Request Id required: - object_log_id - object_id - object_type - action - created_on title: ObjectLog type: object ObjectLogSortField: enum: - object_log_id - object_id - object_type - action - created_on - server_request_id - performed_by_type - performed_by_id title: ObjectLogSortField type: string ObjectTagChanges: properties: add: description: Object TypeIDs or resource names to tag. TypeIDs and names may be mixed. items: description: A TypeID (e.g. domain_01h45ytscbebyvny4gc8cr8ma2) or a resource name (e.g. example.com) examples: - domain_01h45ytscbebyvny4gc8cr8ma2 - example.com type: string maxItems: 1000 title: Add type: array remove: description: Object TypeIDs or resource names to untag. TypeIDs and names may be mixed. items: description: A TypeID (e.g. domain_01h45ytscbebyvny4gc8cr8ma2) or a resource name (e.g. example.com) examples: - domain_01h45ytscbebyvny4gc8cr8ma2 - example.com type: string maxItems: 1000 title: Remove type: array title: ObjectTagChanges type: object ObjectTagChangesResponse: properties: added: description: Number of objects tagged title: Added type: integer removed: description: Number of objects untagged title: Removed type: integer unresolved: description: References that could not be resolved items: type: string title: Unresolved type: array required: - added - removed title: ObjectTagChangesResponse type: object Organization: properties: address_1: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: First line of the organization's address. title: Address 1 address_2: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Second line of the organization's address. title: Address 2 attributes: items: $ref: '#/components/schemas/OrganizationAttribute' title: Attributes type: array billing_mode: $ref: '#/components/schemas/BillingMode' default: consolidated description: Whether the organization is billed on its own account (INDEPENDENT) or rolled up to its parent (CONSOLIDATED). business_number: anyOf: - maxLength: 100 minLength: 1 type: string - type: 'null' description: Government issued business identifier for the organization issued. title: Business Number city: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: City of the organization's address. title: City country_code: anyOf: - maxLength: 2 pattern: ^\w{2}$ type: string - type: 'null' description: ISO 3166-1 alpha-2 country code, plus XK (Kosovo). title: Country Code created_on: description: The date/time the entry was created on format: date-time title: Created On type: string currency: anyOf: - $ref: '#/components/schemas/Currency' - type: 'null' description: The currency used by the organization. default_locale: anyOf: - examples: - en_US type: string - type: 'null' description: Default locale for the organization. title: Default Locale deleted_on: anyOf: - format: date-time type: string - type: 'null' description: The date/time the entry was deleted on title: Deleted On keycloak_organization_id: anyOf: - type: string - type: 'null' description: Keycloak organization id title: Keycloak Organization Id name: description: Name of the organization. maxLength: 255 minLength: 1 title: Name type: string organization_id: description: Unique identifier for the organization. examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization parent_organization_id: anyOf: - examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: organization - type: 'null' description: ID of the parent organization. title: Parent Organization Id postal_code: anyOf: - maxLength: 20 minLength: 1 type: string - type: 'null' description: Postal code of the organization's address. title: Postal Code state: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: State or province of the organization's address. title: State status: $ref: '#/components/schemas/OrganizationStatus' default: active description: Status of the organization. tax_id: anyOf: - maxLength: 50 minLength: 1 type: string - type: 'null' description: Tax ID of the organization. title: Tax Id tax_id_type: anyOf: - maxLength: 50 minLength: 1 type: string - type: 'null' description: Type of tax ID for the organization. title: Tax Id Type tax_rate: anyOf: - pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$) type: string - type: 'null' description: Tax rate for the organization. title: Tax Rate users: items: $ref: '#/components/schemas/User' title: Users type: array required: - name title: Organization type: object OrganizationAttribute: properties: created_on: description: The date/time the entry was created on format: date-time title: Created On type: string key: description: Key of the attribute. minLength: 1 title: Key type: string organization_attribute_id: title: Organization Attribute Id type: integer private: default: false description: When true, the attribute is private and not visible to users. title: Private type: boolean protected: default: false description: When true, the attribute is protected and cannot be modified by users. title: Protected type: boolean updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string value: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: Value of the attribute. required: - key - organization_attribute_id title: OrganizationAttribute type: object OrganizationAttributeCreate: properties: key: description: Key of the attribute. minLength: 1 title: Key type: string private: default: false description: When true, the attribute is private and not visible to users. title: Private type: boolean protected: default: false description: When true, the attribute is protected and cannot be modified by users. title: Protected type: boolean value: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: Value of the attribute. required: - key title: OrganizationAttributeCreate type: object OrganizationAttributeResponse: properties: created_on: description: The date/time the entry was created on format: date-time title: Created On type: string key: description: Key of the attribute. minLength: 1 title: Key type: string organization_attribute_id: title: Organization Attribute Id type: integer protected: default: false description: When true, the attribute is protected and cannot be modified by users. title: Protected type: boolean updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string value: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: Value of the attribute. required: - key - organization_attribute_id title: OrganizationAttributeResponse type: object OrganizationAttributeUpdate: properties: key: description: Key of the attribute. minLength: 1 title: Key type: string private: default: false description: When true, the attribute is private and not visible to users. title: Private type: boolean protected: default: false description: When true, the attribute is protected and cannot be modified by users. title: Protected type: boolean value: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: Value of the attribute. required: - key title: OrganizationAttributeUpdate type: object OrganizationCreate: properties: address_1: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: First line of the organization's address. title: Address 1 address_2: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Second line of the organization's address. title: Address 2 attributes: description: List of attributes for the organization. items: $ref: '#/components/schemas/OrganizationAttributeCreate' title: Attributes type: array billing_mode: $ref: '#/components/schemas/BillingMode' default: consolidated description: Whether the organization is billed on its own account (INDEPENDENT) or rolled up to its parent (CONSOLIDATED). INDEPENDENT is only permitted for eligible sub-organizations. Cannot be changed after creation. business_number: anyOf: - maxLength: 100 minLength: 1 type: string - type: 'null' description: Government issued business identifier for the organization issued. title: Business Number city: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: City of the organization's address. title: City country_code: anyOf: - maxLength: 2 pattern: ^\w{2}$ type: string - type: 'null' description: ISO 3166-1 alpha-2 country code, plus XK (Kosovo). title: Country Code currency: anyOf: - $ref: '#/components/schemas/Currency' - type: 'null' description: The currency used by the organization. default_locale: anyOf: - examples: - en_US type: string - type: 'null' description: Default locale for the organization. title: Default Locale name: description: Name of the organization. maxLength: 255 minLength: 1 title: Name type: string parent_organization_id: anyOf: - examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: organization - type: 'null' description: ID of the parent organization. title: Parent Organization Id postal_code: anyOf: - maxLength: 20 minLength: 1 type: string - type: 'null' description: Postal code of the organization's address. title: Postal Code state: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: State or province of the organization's address. title: State tax_id: anyOf: - maxLength: 50 minLength: 1 type: string - type: 'null' description: Tax ID of the organization. title: Tax Id tax_id_type: anyOf: - maxLength: 50 minLength: 1 type: string - type: 'null' description: Type of tax ID for the organization. title: Tax Id Type tax_rate: anyOf: - type: number - pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$) type: string - type: 'null' description: Tax rate for the organization. title: Tax Rate users: description: List of users that needs to be created with the organization. items: $ref: '#/components/schemas/UserCreate' title: Users type: array required: - name title: OrganizationCreate type: object OrganizationCredential: properties: api_key_description: anyOf: - type: string - type: 'null' description: Description of the organization credential. title: Api Key Description api_key_id: description: Unique identifier of the organization credential. examples: - api_key_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^api_key_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Api Key Id type: string x-typeid-prefix: api_key api_key_name: anyOf: - type: string - type: 'null' description: Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed. title: Api Key Name created_on: description: The date/time the entry was created on format: date-time title: Created On type: string deleted_on: anyOf: - format: date-time type: string - type: 'null' description: The date/time the entry was deleted on title: Deleted On expires_at: anyOf: - format: date-time type: string - type: 'null' description: The date and time the credential expiration. title: Expires At last_used_on: anyOf: - format: date-time type: string - type: 'null' description: The date/time the entry was last used on title: Last Used On organization_id: default: None examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization role: anyOf: - $ref: '#/components/schemas/PublicRole' - $ref: '#/components/schemas/CustomRoleLabel' - type: 'null' title: Role status: $ref: '#/components/schemas/OrganizationCredentialStatus' description: The status of the organization credential. readOnly: true required: - api_key_id - status title: OrganizationCredential type: object OrganizationCredentialStatus: enum: - active - expired - revoked title: OrganizationCredentialStatus type: string OrganizationSortField: enum: - created_on - name - country_code title: OrganizationSortField type: string OrganizationStatus: enum: - active - inactive title: OrganizationStatus type: string OrganizationTokenResponse: properties: access_token: examples: - eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwczovL2FwaS5vcHVzZG5zLmNvbSJ9.signature title: Access Token type: string expires_in: examples: - 3600 title: Expires In type: integer token_type: default: Bearer examples: - Bearer title: Token Type type: string required: - access_token - expires_in title: OrganizationTokenResponse type: object OrganizationUpdate: properties: address_1: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: First line of the organization's address. title: Address 1 address_2: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Second line of the organization's address. title: Address 2 business_number: anyOf: - maxLength: 100 minLength: 1 type: string - type: 'null' description: Government issued business identifier for the organization issued. title: Business Number city: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: City of the organization's address. title: City country_code: anyOf: - description: ISO 3166-1 alpha-2 country code, plus XK (Kosovo). maxLength: 2 minLength: 2 pattern: ^\w{2}$ type: string - type: 'null' title: Country Code default_locale: anyOf: - examples: - en_US type: string - type: 'null' description: Default locale for the organization. title: Default Locale name: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Name of the organization. title: Name postal_code: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Postal code of the organization's address. title: Postal Code state: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: State or province of the organization's address. title: State tax_id: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Tax ID of the organization. title: Tax Id tax_id_type: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Type of tax ID for the organization. title: Tax Id Type tax_rate: anyOf: - type: number - pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,6}|(?=[\d.]{1,11}0*$)\d{0,6}\.\d{0,4}0*$) type: string - type: 'null' description: Tax rate for the organization. title: Tax Rate title: OrganizationUpdate type: object OrganizationWithBillingData: properties: account_balance: anyOf: - pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ type: string - type: 'null' title: Account Balance address_1: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: First line of the organization's address. title: Address 1 address_2: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: Second line of the organization's address. title: Address 2 attributes: items: $ref: '#/components/schemas/OrganizationAttribute' title: Attributes type: array billing_metadata: $ref: '#/components/schemas/BillingMetadata' billing_mode: $ref: '#/components/schemas/BillingMode' default: consolidated description: Whether the organization is billed on its own account (INDEPENDENT) or rolled up to its parent (CONSOLIDATED). business_number: anyOf: - maxLength: 100 minLength: 1 type: string - type: 'null' description: Government issued business identifier for the organization issued. title: Business Number city: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: City of the organization's address. title: City country_code: anyOf: - maxLength: 2 pattern: ^\w{2}$ type: string - type: 'null' description: ISO 3166-1 alpha-2 country code, plus XK (Kosovo). title: Country Code created_on: description: The date/time the entry was created on format: date-time title: Created On type: string currency: anyOf: - $ref: '#/components/schemas/Currency' - type: 'null' description: The currency used by the organization. default_locale: anyOf: - examples: - en_US type: string - type: 'null' description: Default locale for the organization. title: Default Locale deleted_on: anyOf: - format: date-time type: string - type: 'null' description: The date/time the entry was deleted on title: Deleted On keycloak_organization_id: anyOf: - type: string - type: 'null' description: Keycloak organization id title: Keycloak Organization Id name: description: Name of the organization. maxLength: 255 minLength: 1 title: Name type: string organization_id: description: Unique identifier for the organization. examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization parent_organization_id: anyOf: - examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: organization - type: 'null' description: ID of the parent organization. title: Parent Organization Id postal_code: anyOf: - maxLength: 20 minLength: 1 type: string - type: 'null' description: Postal code of the organization's address. title: Postal Code state: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: State or province of the organization's address. title: State status: $ref: '#/components/schemas/OrganizationStatus' default: active description: Status of the organization. tax_id: anyOf: - maxLength: 50 minLength: 1 type: string - type: 'null' description: Tax ID of the organization. title: Tax Id tax_id_type: anyOf: - maxLength: 50 minLength: 1 type: string - type: 'null' description: Type of tax ID for the organization. title: Tax Id Type tax_rate: anyOf: - pattern: ^(?!^[-+.]*$)[+-]?0*(?:\d{0,8}|(?=[\d.]{1,11}0*$)\d{0,8}\.\d{0,2}0*$) type: string - type: 'null' description: Tax rate for the organization. title: Tax Rate users: items: $ref: '#/components/schemas/User' title: Users type: array required: - name title: OrganizationWithBillingData type: object OutboundTransferAction: enum: - approve - reject title: OutboundTransferAction type: string OutboundTransferRequest: properties: action: $ref: '#/components/schemas/OutboundTransferAction' description: Whether to approve or reject the pending outbound transfer required: - action title: OutboundTransferRequest type: object OutboundTransferResponse: properties: action: $ref: '#/components/schemas/OutboundTransferAction' description: The action that was applied to the outbound transfer domain_id: description: The ID of the domain whose outbound transfer was resolved examples: - domain_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^domain_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Domain Id type: string x-typeid-prefix: domain domain_name: description: The name of the domain whose outbound transfer was resolved title: Domain Name type: string required: - domain_id - domain_name - action title: OutboundTransferResponse type: object PageResponse_EmailForwardLog_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/EmailForwardLog' title: Results type: array required: - results - pagination title: PageResponse[EmailForwardLog] type: object PageResponse_JobBatchMetadataResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/JobBatchMetadataResponse' title: Results type: array required: - results - pagination title: PageResponse[JobBatchMetadataResponse] type: object PageResponse_JobResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/JobResponse' title: Results type: array required: - results - pagination title: PageResponse[JobResponse] type: object PageResponse_ObjectLog_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/ObjectLog' title: Results type: array required: - results - pagination title: PageResponse[ObjectLog] type: object PageResponse_ParkingResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/ParkingResponse' title: Results type: array required: - results - pagination title: PageResponse[ParkingResponse] type: object PageResponse_RequestHistory_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/RequestHistory' title: Results type: array required: - results - pagination title: PageResponse[RequestHistory] type: object PaginationMetadata: properties: current_page: title: Current Page type: integer has_next_page: title: Has Next Page type: boolean has_previous_page: title: Has Previous Page type: boolean page_size: title: Page Size type: integer total_items: title: Total Items type: integer total_pages: title: Total Pages type: integer required: - total_pages - total_items - current_page - page_size - has_next_page - has_previous_page title: PaginationMetadata type: object PaginationMetadataDTO: properties: current_page: description: Current page number title: Current Page type: integer has_next_page: description: Whether there is a next page title: Has Next Page type: boolean has_previous_page: description: Whether there is a previous page title: Has Previous Page type: boolean page_size: description: Items per page title: Page Size type: integer total_items: description: Total number of items title: Total Items type: integer total_pages: description: Total number of pages title: Total Pages type: integer required: - total_pages - total_items - current_page - page_size - has_next_page - has_previous_page title: PaginationMetadataDTO type: object Pagination_BillingTransactionResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/BillingTransactionResponse' title: Results type: array required: - results - pagination title: Pagination[BillingTransactionResponse] type: object Pagination_ContactAttributeSetResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/ContactAttributeSetResponse' title: Results type: array required: - results - pagination title: Pagination[ContactAttributeSetResponse] type: object Pagination_ContactResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/ContactResponse' title: Results type: array required: - results - pagination title: Pagination[ContactResponse] type: object Pagination_DnsZoneResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/DnsZoneResponse' title: Results type: array required: - results - pagination title: Pagination[DnsZoneResponse] type: object Pagination_DomainForwardZone_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/DomainForwardZone' title: Results type: array required: - results - pagination title: Pagination[DomainForwardZone] type: object Pagination_DomainForward_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/DomainForward' title: Results type: array required: - results - pagination title: Pagination[DomainForward] type: object Pagination_DomainResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/DomainResponse' title: Results type: array required: - results - pagination title: Pagination[DomainResponse] type: object Pagination_EmailForwardResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/EmailForwardResponse' title: Results type: array required: - results - pagination title: Pagination[EmailForwardResponse] type: object Pagination_EmailForwardZone_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/EmailForwardZone' title: Results type: array required: - results - pagination title: Pagination[EmailForwardZone] type: object Pagination_EventResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/EventResponse' title: Results type: array required: - results - pagination title: Pagination[EventResponse] type: object Pagination_InvoiceResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/InvoiceResponse' title: Results type: array required: - results - pagination title: Pagination[InvoiceResponse] type: object Pagination_Organization_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/Organization' title: Results type: array required: - results - pagination title: Pagination[Organization] type: object Pagination_TagResponse_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/TagResponse' title: Results type: array required: - results - pagination title: Pagination[TagResponse] type: object Pagination_UserPublicWithRole_: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/UserPublicWithRole' title: Results type: array required: - results - pagination title: Pagination[UserPublicWithRole] type: object Palette: properties: accent: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Accent accent_foreground: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Accent Foreground background: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Background body: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Body body_foreground: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Body Foreground border: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Border card: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Card card_foreground: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Card Foreground chart_colors: anyOf: - items: pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string type: array - type: 'null' title: Chart Colors danger: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Danger foreground: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Foreground info: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Info input: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Input link: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Link muted: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Muted muted_foreground: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Muted Foreground primary: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Primary primary_foreground: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Primary Foreground secondary: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Secondary secondary_foreground: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Secondary Foreground sidebar: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Sidebar sidebar_accent: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Sidebar Accent sidebar_accent_foreground: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Sidebar Accent Foreground sidebar_border: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Sidebar Border sidebar_foreground: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Sidebar Foreground success: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Success table: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Table table_header: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Table Header table_row: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Table Row table_row_interactive: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Table Row Interactive tag_colors: anyOf: - items: pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string type: array - type: 'null' title: Tag Colors warning: anyOf: - pattern: ^#([0-9a-fA-F]{3}|[0-9a-fA-F]{6})$ type: string - type: 'null' title: Warning title: Palette type: object ParkingActionPayloadData: properties: parking_reference: title: Parking Reference type: string required: - parking_reference title: ParkingActionPayloadData type: object ParkingAgreementAcceptance: description: Parking agreement acceptance details. properties: accepted: description: Whether the agreement has been accepted title: Accepted type: boolean url: description: URL where the parking agreement can be found format: uri maxLength: 2083 minLength: 1 title: Url type: string version: description: Version of the parking agreement being accepted title: Version type: string required: - version - accepted - url title: ParkingAgreementAcceptance type: object ParkingCreateBulkCommand: properties: command: const: parking_create_bulk default: parking_create_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/ParkingCreateBulkPayload' description: Bulk parking creation payload version: default: v1 description: Command version title: Version type: string required: - payload title: ParkingCreateBulkCommand type: object ParkingCreateBulkInstance: properties: domain: description: The domain name for the parking ad title: Domain type: string enabled: anyOf: - type: boolean - type: 'null' description: Override enabled setting for this domain title: Enabled required: - domain title: ParkingCreateBulkInstance type: object ParkingCreateBulkPayload: properties: instances: description: List of parking entries to create (1-1000) items: $ref: '#/components/schemas/ParkingCreateBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array template: $ref: '#/components/schemas/ParkingCreateBulkTemplate' description: Shared settings for all parking entries required: - template - instances title: ParkingCreateBulkPayload type: object ParkingCreateBulkTemplate: properties: enabled: default: false description: Whether to enable parking immediately after creation title: Enabled type: boolean title: ParkingCreateBulkTemplate type: object ParkingCreatePayloadData: properties: domain: title: Domain type: string enabled: default: false title: Enabled type: boolean required: - domain title: ParkingCreatePayloadData type: object ParkingCreateWorkerPayload: properties: operation: title: Operation type: string parking: $ref: '#/components/schemas/ParkingCreatePayloadData' type: const: parking_create_bulk title: Type type: string required: - type - operation - parking title: ParkingCreateWorkerPayload type: object ParkingDeleteBulkCommand: properties: command: const: parking_delete_bulk default: parking_delete_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/ParkingDeleteBulkPayload' description: Bulk parking delete payload version: default: v1 description: Command version title: Version type: string required: - payload title: ParkingDeleteBulkCommand type: object ParkingDeleteBulkInstance: properties: parking_reference: anyOf: - examples: - parking_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: parking - type: string description: The parking ID or domain name of the entry to delete title: Parking Reference required: - parking_reference title: ParkingDeleteBulkInstance type: object ParkingDeleteBulkPayload: properties: instances: description: List of parking entries to delete (1-1000) items: $ref: '#/components/schemas/ParkingDeleteBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: ParkingDeleteBulkPayload type: object ParkingDeleteWorkerPayload: properties: operation: title: Operation type: string parking: $ref: '#/components/schemas/ParkingActionPayloadData' type: const: parking_delete_bulk title: Type type: string required: - type - operation - parking title: ParkingDeleteWorkerPayload type: object ParkingDisableBulkCommand: properties: command: const: parking_disable_bulk default: parking_disable_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/ParkingDisableBulkPayload' description: Bulk parking disable payload version: default: v1 description: Command version title: Version type: string required: - payload title: ParkingDisableBulkCommand type: object ParkingDisableBulkInstance: properties: parking_reference: anyOf: - examples: - parking_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: parking - type: string description: The parking ID or domain name of the entry to disable title: Parking Reference required: - parking_reference title: ParkingDisableBulkInstance type: object ParkingDisableBulkPayload: properties: instances: description: List of parking entries to disable (1-1000) items: $ref: '#/components/schemas/ParkingDisableBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: ParkingDisableBulkPayload type: object ParkingDisableWorkerPayload: properties: operation: title: Operation type: string parking: $ref: '#/components/schemas/ParkingActionPayloadData' type: const: parking_disable_bulk title: Type type: string required: - type - operation - parking title: ParkingDisableWorkerPayload type: object ParkingEnableBulkCommand: properties: command: const: parking_enable_bulk default: parking_enable_bulk title: Command type: string idempotency_key: anyOf: - type: string - type: 'null' description: Idempotency key for this bulk command title: Idempotency Key payload: $ref: '#/components/schemas/ParkingEnableBulkPayload' description: Bulk parking enable payload version: default: v1 description: Command version title: Version type: string required: - payload title: ParkingEnableBulkCommand type: object ParkingEnableBulkInstance: properties: parking_reference: anyOf: - examples: - parking_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: parking - type: string description: The parking ID or domain name of the entry to enable title: Parking Reference required: - parking_reference title: ParkingEnableBulkInstance type: object ParkingEnableBulkPayload: properties: instances: description: List of parking entries to enable (1-1000) items: $ref: '#/components/schemas/ParkingEnableBulkInstance' maxItems: 1000 minItems: 1 title: Instances type: array required: - instances title: ParkingEnableBulkPayload type: object ParkingEnableWorkerPayload: properties: operation: title: Operation type: string parking: $ref: '#/components/schemas/ParkingActionPayloadData' type: const: parking_enable_bulk title: Type type: string required: - type - operation - parking title: ParkingEnableWorkerPayload type: object ParkingMetricsResponse: properties: metrics: $ref: '#/components/schemas/ParkingStatistics' description: Metrics for the parking entry renewal_cost: description: Yearly renewal cost for the parked domain pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Renewal Cost type: string renewal_cost_currency: $ref: '#/components/schemas/Currency' description: Currency code for renewal cost (e.g., USD, EUR) revenue_progress: description: Revenue progress percentage towards covering renewal cost pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Revenue Progress type: string required: - metrics - renewal_cost - renewal_cost_currency - revenue_progress title: ParkingMetricsResponse type: object ParkingResponse: properties: compliance_status: anyOf: - $ref: '#/components/schemas/ComplianceStatus' - type: 'null' description: The compliance status of the parking ad content_language: anyOf: - type: string - type: 'null' description: The primary language code for the ad content title: Content Language content_url: anyOf: - type: string - type: 'null' description: The content URL for approved parking ads title: Content Url created_on: description: When the parking entry was created format: date-time title: Created On type: string domain: description: The domain name for the parking ad title: Domain type: string enabled: description: Whether parking is enabled title: Enabled type: boolean note: anyOf: - type: string - type: 'null' description: Additional notes about the parking ad title: Note parking_id: description: Unique identifier for the parking entry examples: - parking_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Parking Id type: string x-typeid-prefix: parking updated_on: description: When the parking entry was last updated format: date-time title: Updated On type: string required: - parking_id - domain - enabled - created_on - updated_on title: ParkingResponse type: object ParkingSignupRequest: description: Request to sign up for parking (accept parking agreement). properties: agreement: $ref: '#/components/schemas/ParkingAgreementAcceptance' description: Parking agreement acceptance required: - agreement title: ParkingSignupRequest type: object ParkingSignupResponse: description: Response after parking signup. properties: agreement_stored: description: Whether the agreement acceptance was stored title: Agreement Stored type: boolean success: description: Whether the signup was successful title: Success type: boolean required: - success - agreement_stored title: ParkingSignupResponse type: object ParkingSignupStatusResponse: description: Response for checking parking signup status. properties: accepted_at: anyOf: - format: date-time type: string - type: 'null' description: When the agreement was accepted title: Accepted At agreement_version: anyOf: - type: string - type: 'null' description: Version of the accepted agreement title: Agreement Version has_accepted_agreement: description: Whether the organization has accepted the parking agreement title: Has Accepted Agreement type: boolean required: - has_accepted_agreement title: ParkingSignupStatusResponse type: object ParkingSortField: enum: - domain - created_on - updated_on title: ParkingSortField type: string ParkingStatistics: properties: conversions: description: Number of conversions title: Conversions type: integer revenue: description: Total revenue pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Revenue type: string revenue_currency: $ref: '#/components/schemas/Currency' description: Currency code for revenue (e.g., USD, EUR) rpc: description: Revenue per click pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Rpc type: string rpm: description: Revenue per mille (thousand views) pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Rpm type: string views: description: Number of views title: Views type: integer required: - views - conversions - rpc - rpm - revenue - revenue_currency title: ParkingStatistics type: object ParkingTotalMetricsResponse: properties: total_count: description: Total number of parking entries title: Total Count type: integer total_metrics: $ref: '#/components/schemas/ParkingStatistics' description: Aggregated metrics for all parking entries required: - total_count - total_metrics title: ParkingTotalMetricsResponse type: object PatchOp: enum: - upsert - remove title: PatchOp type: string Period: properties: unit: $ref: '#/components/schemas/PeriodUnit' description: The unit of the period value: description: Amount of time in the unit exclusiveMinimum: 0.0 title: Value type: integer required: - value - unit title: Period type: object PeriodList: anyOf: - items: $ref: '#/components/schemas/Period' type: array - type: 'null' PeriodStr: anyOf: - $ref: '#/components/schemas/Period' - type: 'null' PeriodUnit: enum: - y - m - d title: PeriodUnit type: string PlatformStatsBucket: properties: key: title: Key type: string total: title: Total type: integer unique: title: Unique type: integer required: - key - total - unique title: PlatformStatsBucket type: object PostTransferRequirements: enum: - update_contacts - tld_specific title: PostTransferRequirements type: string PostalAddressType: enum: - loc - int title: PostalAddressType type: string PremiumAffectsType: enum: - registration - delete - renewal - update - transfer - restore - custom title: PremiumAffectsType type: string PremiumDomainsBase: properties: affects: anyOf: - items: $ref: '#/components/schemas/PremiumAffectsType' type: array - type: 'null' description: What operations are affected by premium status title: Affects source: anyOf: - $ref: '#/components/schemas/PremiumSourceType' - type: 'null' description: Source of premium domain information supported: description: Whether the registry has premium domains title: Supported type: boolean required: - supported title: PremiumDomainsBase type: object PremiumPriceEntryRes: description: A single premium price entry for a specific action properties: action: description: The action (e.g., create, renew, transfer) title: Action type: string currency: description: Currency of the price title: Currency type: string price: description: Customer-facing price after markup pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Price type: string required: - action - price - currency title: PremiumPriceEntryRes type: object PremiumPricingAction: properties: action: description: The action this price applies to (e.g., create, renew, transfer) examples: - create title: Action type: string currency: description: ISO 4217 currency code examples: - EUR title: Currency type: string price: description: Price for the action examples: - '625.00' pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Price type: string required: - action - price - currency title: PremiumPricingAction type: object PremiumPricingRes: description: Premium pricing details for a domain properties: prices: description: Premium prices per action items: $ref: '#/components/schemas/PremiumPriceEntryRes' title: Prices type: array required: - prices title: PremiumPricingRes type: object PremiumPricingResponse: properties: prices: description: Premium prices per action items: $ref: '#/components/schemas/PremiumPricingAction' title: Prices type: array required: - prices title: PremiumPricingResponse type: object PremiumSourceType: enum: - EPP - API - CSV - manual title: PremiumSourceType type: string PreviewMailReq: properties: branding_document: anyOf: - $ref: '#/components/schemas/BrandingDocument' - type: 'null' description: Draft branding document to render the preview with; omit to preview with the default OpusDNS branding. Only the fields the template uses are applied, the rest are ignored. language_code: description: Locale to render in (e.g. en); falls back to the template's default title: Language Code type: string template_name: description: Template to render, as listed by the template catalog title: Template Name type: string required: - template_name - language_code title: PreviewMailReq type: object PreviewMailRes: properties: html: title: Html type: string subject: title: Subject type: string text: title: Text type: string required: - subject - html - text title: PreviewMailRes type: object PriceInfo: properties: currency: title: Currency type: string period: anyOf: - $ref: '#/components/schemas/PricingPeriod' - type: 'null' description: Pricing period (e.g., 1 year, 2 months) price: title: Price type: string product_action: anyOf: - type: string - type: 'null' title: Product Action product_class: anyOf: - type: string - type: 'null' title: Product Class product_type: title: Product Type type: string required: - product_type - price - currency title: PriceInfo type: object PricingPeriod: properties: unit: $ref: '#/components/schemas/PeriodUnit' description: The unit of the period value: description: Amount of time in the unit exclusiveMinimum: 0.0 title: Value type: integer required: - value - unit title: PricingPeriod type: object Problem: properties: detail: anyOf: - type: string - type: 'null' title: Problem detail status: title: Status code type: integer title: title: Problem title type: string type: title: Problem type type: string required: - type - title - status title: Problem type: object ProductCreateRes: properties: product_name: description: The product name title: Product Name type: string subscribable_id: description: The created resource ID title: Subscribable Id type: string subscription_id: description: The created subscription ID examples: - subscription_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^subscription_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Subscription Id type: string x-typeid-prefix: subscription required: - subscription_id - subscribable_id - product_name title: ProductCreateRes type: object Protocol: enum: - http - https title: Protocol type: string PublicAuthRequestForm: properties: client_id: description: The organization ID associated with the credentials. examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Client Id type: string x-typeid-prefix: organization client_secret: description: Your client secret. examples: - TLKI8chiHU1s123VUgEAMLZDvX6cVW title: Client Secret type: string grant_type: description: The grant type for the authentication request (should always be 'client_credentials'). examples: - client_credentials title: Grant Type type: string required: - grant_type - client_id - client_secret title: PublicAuthRequestForm type: object PublicPermission: examples: - domains:read - domains:manage - domains:delete type: string PublicPermissionSet: properties: permissions: items: $ref: '#/components/schemas/PublicPermission' title: Permissions type: array title: PublicPermissionSet type: object PublicReportListRes: properties: pagination: $ref: '#/components/schemas/PaginationMetadata' results: items: $ref: '#/components/schemas/PublicReportRes' title: Results type: array required: - results - pagination title: PublicReportListRes type: object PublicReportRes: properties: created_on: format: date-time title: Created On type: string file_size_bytes: anyOf: - type: integer - type: 'null' title: File Size Bytes generated_on: anyOf: - format: date-time type: string - type: 'null' title: Generated On organization_id: examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization record_count: anyOf: - type: integer - type: 'null' title: Record Count report_id: examples: - report_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^report_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Report Id type: string x-typeid-prefix: report report_type: $ref: '#/components/schemas/ReportType' status: $ref: '#/components/schemas/ReportStatus' trigger_type: $ref: '#/components/schemas/ReportTriggerType' updated_on: format: date-time title: Updated On type: string required: - report_id - organization_id - report_type - status - trigger_type - created_on - updated_on title: PublicReportRes type: object PublicResource: enum: - organization - domains - domain_auth_codes - contacts - dns - hosts - email_forwards - domain_forwards - parking - events - jobs - billing - users - api_keys - registrar_credentials - tags - audit_logs - vanity_ns - whitelabel_branding - ai_concierge - ai_concierge_waitlist title: PublicResource type: string PublicRole: enum: - owner - admin - viewer - domain_manager - dns_manager - billing_manager title: PublicRole type: string PublicRoleAssignment: properties: role: anyOf: - $ref: '#/components/schemas/PublicRole' - $ref: '#/components/schemas/CustomRoleLabel' - type: 'null' title: Role title: PublicRoleAssignment type: object PublicRoleAssignmentRequest: properties: role: anyOf: - $ref: '#/components/schemas/AssignablePublicRole' - $ref: '#/components/schemas/CustomRoleLabel' - type: 'null' title: Role title: PublicRoleAssignmentRequest type: object PublicRoleDefinition: description: "A role as listed/read through the public API \u2014 built-in or\ \ custom." properties: built_in: description: Built-in roles are immutable; custom roles are organization-owned. title: Built In type: boolean created_on: anyOf: - format: date-time type: string - type: 'null' description: Creation time (custom roles only). title: Created On description: anyOf: - type: string - type: 'null' description: Description of the role. title: Description label: $ref: '#/components/schemas/CustomRoleLabel' description: Per-organization unique identifier (snake_case, e.g. 'support_staff'). Used as the URL path parameter. name: description: Display name of the role (e.g. 'Support Staff'). title: Name type: string permissions: description: Permissions the role grants, as `resource:scope` strings. items: $ref: '#/components/schemas/PublicPermission' title: Permissions type: array updated_on: anyOf: - format: date-time type: string - type: 'null' description: Last update time (custom roles only). title: Updated On required: - label - name - built_in - permissions title: PublicRoleDefinition type: object PublicScope: enum: - read - manage - delete title: PublicScope type: string RdapBase: properties: rdap_server: anyOf: - format: uri maxLength: 2083 minLength: 1 type: string - type: 'null' description: RDAP server URL title: Rdap Server title: RdapBase type: object RedirectCode: enum: - 301 - 302 - 307 - 308 title: RedirectCode type: integer ReferrerStatsBucket: properties: key: title: Key type: string total: title: Total type: integer unique: title: Unique type: integer required: - key - total - unique title: ReferrerStatsBucket type: object RegistrantChangeType: enum: - update - trade title: RegistrantChangeType type: string Registrar: enum: - INTERNETX - MONIKER - DOMAIN_BESTELLSYSTEM - CENTRALNIC - NICMANAGER - OPUSDNS - ENOM - OPENSRS - NIC_DIRECT title: Registrar type: string RegistrarContact: properties: city: anyOf: - type: string - type: 'null' title: City country: anyOf: - type: string - type: 'null' title: Country email: anyOf: - type: string - type: 'null' title: Email fax: anyOf: - type: string - type: 'null' title: Fax first_name: anyOf: - type: string - type: 'null' title: First Name id: anyOf: - type: string - type: 'null' description: Contact ID (required for OpusDNS-native contacts, may be null for registrar-sourced) title: Id last_name: anyOf: - type: string - type: 'null' title: Last Name org: anyOf: - type: string - type: 'null' title: Org phone: anyOf: - type: string - type: 'null' title: Phone postal_code: anyOf: - type: string - type: 'null' title: Postal Code state: anyOf: - type: string - type: 'null' title: State street: anyOf: - type: string - type: 'null' title: Street title: anyOf: - type: string - type: 'null' title: Title title: RegistrarContact type: object RegistrarDomain: properties: contacts: additionalProperties: $ref: '#/components/schemas/RegistrarContact' default: {} title: Contacts type: object contacts_dedup: default: [] items: $ref: '#/components/schemas/RegistrarContact' title: Contacts Dedup type: array expiry_date: anyOf: - type: string - type: 'null' title: Expiry Date name: title: Name type: string nameservers: default: [] items: $ref: '#/components/schemas/RegistrarNameserver' title: Nameservers type: array registrar: anyOf: - type: string - type: 'null' title: Registrar statuses: items: type: string title: Statuses type: array zone: anyOf: - $ref: '#/components/schemas/RegistrarZone' - type: 'null' required: - name title: RegistrarDomain type: object RegistrarNameserver: properties: hostname: default: '' title: Hostname type: string ip_addresses: default: [] items: type: string title: Ip Addresses type: array title: RegistrarNameserver type: object RegistrarRRSet: properties: name: title: Name type: string priority: anyOf: - type: integer - type: 'null' title: Priority record: default: [] items: $ref: '#/components/schemas/RegistrarRecord' title: Record type: array ttl: title: Ttl type: integer type: title: Type type: string required: - name - ttl - type title: RegistrarRRSet type: object RegistrarRecord: properties: rdata: title: Rdata type: string required: - rdata title: RegistrarRecord type: object RegistrarZone: properties: name: title: Name type: string rrsets: default: [] items: $ref: '#/components/schemas/RegistrarRRSet' title: Rrsets type: array required: - name title: RegistrarZone type: object RegistryHandleAttributeType: description: Registry handle attribute types for type-safe attribute key access. enum: - at-ext-contact:type - DE_CONTACT_TYPE - DE_GENERAL_REQUEST_URI_TEMPLATE - DE_ABUSE_URI_TEMPLATE - dnsbe:type - eurid:type - AFNIC_CONTACT_TYPE - AFNIC_PP_FIRST_NAME - AFNIC_PM_LEGAL_STATUS - AFNIC_PM_SIREN - AFNIC_PM_VAT - AFNIC_PM_TRADEMARK - AFNIC_PM_ASSOC_WALDEC - AFNIC_PM_ASSOC_PUBL_DATE - AFNIC_PM_ASSOC_PUBL_ANNOUNCE - AFNIC_PM_ASSOC_PUBL_PAGE - AFNIC_PM_ASSOC_DECL - AFNIC_PM_DUNS - AFNIC_PM_LOCAL - AFNIC_ID_STATUS - AFNIC_REACHABLE_MEDIA - AFNIC_REACHABLE_STATUS - AFNIC_RESTRICTED_PUBLICATION - ROTLD_CONTACT_TYPE - ROTLD_CNP_FISCAL_CODE - ROTLD_ID_NUMBER - ROTLD_REGISTRATION_NUMBER - ROTLD_DOMAIN_NAME - NOMINET_CONTACT_TYPE - NOMINET_CO_NO - NOMINET_TRAD_NAME - CIRA_CPR - SIDN_LEGAL_FORM - SIDN_LEGAL_REG_NO - SIDN_REGISTRANT_TYPE - SIDN_REGISTRATION_NUMBER - US_NEXUS_CATEGORY - US_NEXUS_COUNTRY_CODE - US_APP_PURPOSE - NIC_IT_ENTITY_TYPE - NIC_IT_REG_CODE - CZ_NIC_IDENT_TYPE - CZ_NIC_IDENT_VALUE - CZ_NIC_VAT - CZ_NIC_NOTIFY_EMAIL - DNS_LU_CONTACT_ROLE - SK_NIC_LEGAL_FORM - SK_NIC_IDENT_VALUE - NIC_LV_REG_NR - NIC_LV_VAT_NR - DOMREG_LT_CONTACT_ROLE - DOMREG_LT_ORG_CODE - NOR_ID_CONTACT_TYPE - NOR_ID_IDENTITY_TYPE - NOR_ID_IDENTITY_VALUE - REGISTRY_SE_ORG_NO - REGISTRY_SE_VAT_NO - DNS_PT_VAT - DNS_PT_MOBILE - DNS_PT_NIS2_VALIDATED_ON - PUNKTUM_DK_USER_TYPE - PUNKTUM_DK_CVR - PUNKTUM_DK_PNUMBER - PUNKTUM_DK_EAN - PUNKTUM_DK_SECONDARY_EMAIL - PUNKTUM_DK_MOBILEPHONE - PUNKTUM_DK_SOLE_PROPRIETORSHIP - PUNKTUM_DK_CONTACT_VERIFIED - INTERNET_EE_IDENT_TYPE - INTERNET_EE_IDENT_CC - INTERNET_EE_IDENT_VALUE title: RegistryHandleAttributeType type: string RegistryLockBase: properties: prevents: anyOf: - items: type: string type: array - type: 'null' description: What operations are prevented by registry lock title: Prevents removal_process: anyOf: - type: string - type: 'null' description: Process for unlocking the domain title: Removal Process requires_manual_request: anyOf: - type: boolean - type: 'null' description: Whether a manual request is required title: Requires Manual Request supported: description: Whether the registry provides a Registry Lock feature title: Supported type: boolean required: - supported title: RegistryLockBase type: object RegistryServiceBackend: enum: - afnic - centralnic - cira - switch - nicat - verisign - pir - gmo - google - denic - identity_digital - godaddy - dns_belgium - eurid - rotld - nominet_uk - radix - sidn - sidn_hello - tucows - dot_ua - nic_it - dns_lu - restena_lu - cz_nic - ras_manual - ras_external - register_si - sk_nic - dot_blog - nic_lv - domreg_lt - nor_id - website_ws - dns_pt - punktum_dk - nic_mexico - internet_ee - channel_isles - registry_se - nask - dns_belgium_gtld - nominet_dragon - red_es - internet_nz - zacr - traficom - ie_registry - nic_im - cn_nic - forth - dns_hr - nixi - is_nic - sg_nic - ke_nic - tld_box - ryce - cocca - amazon - tango title: RegistryServiceBackend type: string RenewalMode: enum: - renew - expire title: RenewalMode type: string RenewalModeDTO: description: "Wire mirror of the domain `RenewalMode` vocabulary \u2014 local\ \ so dns_client doesn't\npull schema imports. The subscription itself has\ \ no renewal_mode column; api-nameserver\nderives this from whether a renewal\ \ is scheduled." enum: - renew - expire title: RenewalModeDTO type: string ReportStatus: enum: - pending - generating - completed - failed - empty title: ReportStatus type: string ReportTriggerType: enum: - on_demand - scheduled title: ReportTriggerType type: string ReportType: enum: - domain_inventory - dns_zone_summary - dns_zone_records - domain_forwards - expiring_domains - email_forwards - registrar_portfolio_pdf - billing_transactions - billing_transactions_monthly - suborg_billing_transactions_monthly - agp_deletions title: ReportType type: string RequestHistory: properties: client_ip: description: Client IP address format: ipvanyaddress title: Client Ip type: string duration: description: Request duration in milliseconds title: Duration type: number method: $ref: '#/components/schemas/HTTPMethod' description: HTTP method path: description: Request path title: Path type: string performed_by_id: anyOf: - type: string - type: 'null' description: ID of the actor who performed the request title: Performed By Id performed_by_type: anyOf: - $ref: '#/components/schemas/ExecutingEntity' - type: 'null' description: Type of the actor who performed the request request_body: anyOf: - additionalProperties: true type: object - items: {} type: array - type: 'null' description: Request body title: Request Body request_completed_at: description: Timestamp when the request completed format: date-time title: Request Completed At type: string request_started_at: description: Timestamp when the request started format: date-time title: Request Started At type: string response_body: anyOf: - additionalProperties: true type: object - items: {} type: array - type: 'null' description: Response body title: Response Body server_request_id: description: Unique ID of the request title: Server Request Id type: string status_code: description: HTTP status code title: Status Code type: integer required: - server_request_id - method - path - status_code - duration - client_ip - request_started_at - request_completed_at title: RequestHistory type: object RequestHistorySortField: enum: - method - path - status_code - duration - server_request_id - performed_by_type - performed_by_id - created_on - request_started_at - request_completed_at title: RequestHistorySortField type: string RequiredClaim: properties: accepted_proofs: anyOf: - items: $ref: '#/components/schemas/NizzaVerificationProof' type: array - type: 'null' description: The evidence the registry accepts for this claim; any proof is accepted when omitted title: Accepted Proofs claim: $ref: '#/components/schemas/NizzaClaim' description: Which contact claim the registry requires to have been verified required: - claim title: RequiredClaim type: object ReservedDomainsBase: properties: source: anyOf: - $ref: '#/components/schemas/ReservedSourceType' - type: 'null' description: Source of reserved domain information supported: description: Registry provides a reserved list title: Supported type: boolean url: anyOf: - format: uri maxLength: 2083 minLength: 1 type: string - type: 'null' description: Link to reserved list title: Url required: - supported title: ReservedDomainsBase type: object ReservedSourceType: enum: - API - CSV - manual title: ReservedSourceType type: string RgpOperations: properties: report: default: true description: Whether registry supports RGP restore report title: Report type: boolean request: default: true description: Whether registry supports RGP restore request title: Request type: boolean title: RgpOperations type: object SetRenewalModeReq: properties: renewal_mode: $ref: '#/components/schemas/RenewalModeDTO' description: expire cancels the set at period end (serves out the term), renew un-cancels (resumes auto-renew) required: - renewal_mode title: SetRenewalModeReq type: object SetVanityNameserverSetDefaultRes: properties: vanity_nameserver_set: $ref: '#/components/schemas/VanityNameserverSetDTO' description: The set that is now the org's default (or unchanged set on a no-op 200). required: - vanity_nameserver_set title: SetVanityNameserverSetDefaultRes type: object SignupCreate: properties: agreements: anyOf: - items: $ref: '#/components/schemas/UserAgreementAcceptance' type: array - type: 'null' description: User agreement acceptances. title: Agreements organization: $ref: '#/components/schemas/OrganizationCreate' description: Organization signup. terms_of_service: anyOf: - $ref: '#/components/schemas/TermsOfServiceAccept' - type: 'null' description: Terms of service acceptance (legacy). user: $ref: '#/components/schemas/UserCreate' description: User signup to platform. required: - user - organization title: SignupCreate type: object SignupResponse: properties: organization: $ref: '#/components/schemas/Organization' user: $ref: '#/components/schemas/User' required: - user - organization title: SignupResponse type: object SldLength: properties: max: description: Maximum length of a domain name maximum: 63.0 title: Max type: integer min: description: Minimum length of a domain name minimum: 1.0 title: Min type: integer required: - min - max title: SldLength type: object SortOrder: enum: - asc - desc title: SortOrder type: string StatusChanges: properties: add: description: Statuses to add to the domain items: $ref: '#/components/schemas/DomainClientStatus' title: Add type: array remove: description: Statuses to remove from the domain items: $ref: '#/components/schemas/DomainClientStatus' title: Remove type: array title: StatusChanges type: object StatusCodeStatsBucket: properties: key: title: Key type: string total: title: Total type: integer required: - key - total title: StatusCodeStatsBucket type: object StatusTagResponse: properties: color: $ref: '#/components/schemas/TagColor' description: The color of the tag description: anyOf: - type: string - type: 'null' description: Additional information about this status tag title: Description label: description: The label of the tag maxLength: 255 minLength: 1 title: Label type: string tag_type: $ref: '#/components/schemas/StatusTagType' description: The status tag type identifier required: - tag_type - label - color title: StatusTagResponse type: object StatusTagType: enum: - VERIFICATION_REQUIRED - CREATE_REQUESTED - INBOUND_TRANSFER_PENDING - OUTBOUND_TRANSFER_PENDING - EXTERNAL - IMPORT_REQUESTED - IMPORT_PENDING - DNSSEC_PENDING title: StatusTagType type: string StrictMoneyDecimal: examples: - '12.50' pattern: ^\d{1,8}\.\d{2}$ type: string Support: properties: email: anyOf: - pattern: ^[^@\s]+@[^@\s]+\.[^@\s]+$ type: string - type: 'null' title: Email help_center_url: anyOf: - type: string - type: 'null' title: Help Center Url status_url: anyOf: - type: string - type: 'null' title: Status Url url: anyOf: - type: string - type: 'null' title: Url title: Support type: object SyncOperationType: enum: - registration - renewal - transfer title: SyncOperationType type: string TLDType: enum: - gTLD - ccTLD title: TLDType type: string TagColor: enum: - color-1 - color-2 - color-3 - color-4 - color-5 - color-6 - color-7 - color-8 - color-9 - color-10 title: TagColor type: string TagCreate: properties: color: anyOf: - $ref: '#/components/schemas/TagColor' - type: 'null' default: color-1 description: The color of the tag description: anyOf: - maxLength: 1024 type: string - type: 'null' description: Optional description of the tag title: Description label: description: A human-readable label for the tag maxLength: 50 minLength: 1 title: Label type: string type: $ref: '#/components/schemas/TagType' description: Which category a tag applies to, cannot be changed once created required: - label - type title: TagCreate type: object TagEnrichedResponse: properties: color: $ref: '#/components/schemas/TagColor' description: The color of the tag label: description: The label of the tag maxLength: 255 minLength: 1 title: Label type: string tag_id: description: The unique identifier of the tag examples: - tag_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Tag Id type: string x-typeid-prefix: tag required: - tag_id - label - color title: TagEnrichedResponse type: object TagFilterMode: enum: - match_any - match_all - match_none title: TagFilterMode type: string TagResponse: properties: color: $ref: '#/components/schemas/TagColor' description: The color of the tag created_on: description: The date/time the tag was created on format: date-time title: Created On type: string description: anyOf: - maxLength: 1024 type: string - type: 'null' description: Optional description of the tag title: Description label: description: The label of the tag maxLength: 255 minLength: 1 title: Label type: string object_count: default: 0 description: Number of objects tagged with this tag title: Object Count type: integer tag_id: description: The unique identifier of the tag examples: - tag_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^tag_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Tag Id type: string x-typeid-prefix: tag type: $ref: '#/components/schemas/TagType' description: Which category a tag applies to, cannot be changed once created updated_on: description: The date/time the tag was last updated on format: date-time title: Updated On type: string required: - tag_id - label - type - color - created_on - updated_on title: TagResponse type: object TagSortField: enum: - label - created_on - updated_on title: TagSortField type: string TagType: enum: - DOMAIN - CONTACT - ZONE title: TagType type: string TagUpdate: properties: color: anyOf: - $ref: '#/components/schemas/TagColor' - type: 'null' description: The color of the tag description: anyOf: - maxLength: 1024 type: string - type: 'null' description: Optional description of the tag title: Description label: anyOf: - maxLength: 50 minLength: 1 type: string - type: 'null' description: A human-readable label for the tag title: Label title: TagUpdate type: object TermsOfServiceAccept: properties: accepted: description: The organization accepts Terms of Service. title: Accepted type: boolean required: - accepted title: TermsOfServiceAccept type: object Theme: properties: dark: anyOf: - $ref: '#/components/schemas/Palette' - type: 'null' font_family: anyOf: - pattern: ^[0-9a-zA-Z, -]{1,128}$ type: string - type: 'null' title: Font Family font_url: anyOf: - type: string - type: 'null' title: Font Url light: anyOf: - $ref: '#/components/schemas/Palette' - type: 'null' radius: anyOf: - pattern: ^[0-9a-zA-Z.% ]{1,32}$ type: string - type: 'null' title: Radius title: Theme type: object TimeRange: enum: - 1h - 1d - 7d - 30d - 1y title: TimeRange type: string TimeSeriesBucket: properties: timestamp: format: date-time title: Timestamp type: string total: title: Total type: integer required: - timestamp - total title: TimeSeriesBucket type: object TldBase: properties: name: description: The TLD being configured title: Name type: string third_level_structure: default: [] description: Name of the third levels (name and overrides) items: type: string title: Third Level Structure type: array type: $ref: '#/components/schemas/TLDType' description: The type of the TLD (e.g., gTLD, ccTLD) required: - name - type title: TldBase type: object TldResponseShort: properties: tld: examples: - com - org - net title: Tld type: string type: $ref: '#/components/schemas/TLDType' examples: - gTLD - ccTLD required: - tld - type title: TldResponseShort type: object TldSpecificationResponse: properties: characters: $ref: '#/components/schemas/SldLength' description: Character limits for domain names contacts: anyOf: - $ref: '#/components/schemas/ContactsBase' - type: 'null' description: Contacts configuration dns_configuration: $ref: '#/components/schemas/DnsConfigurationBase' description: DNS configuration domain_lifecycle: $ref: '#/components/schemas/DomainLifecycleBase' description: Domain lifecycle configuration domain_statuses: $ref: '#/components/schemas/DomainStatusesBase' description: Domain statuses configuration idn: $ref: '#/components/schemas/IdnBase' description: IDN configuration launch_phases: anyOf: - $ref: '#/components/schemas/LaunchPhasesBase' - type: 'null' description: Launch phases configuration legal_requirements: description: Legal requirements that must be met for this TLD items: $ref: '#/components/schemas/LegalRequirementBase' title: Legal Requirements type: array local_presence: anyOf: - $ref: '#/components/schemas/LocalPresenceBase' - type: 'null' description: Local presence requirements parking_enabled: default: false description: Whether parking is enabled for this TLD title: Parking Enabled type: boolean premium_domains: anyOf: - $ref: '#/components/schemas/PremiumDomainsBase' - type: 'null' description: Premium domains configuration rdap: anyOf: - $ref: '#/components/schemas/RdapBase' - type: 'null' description: RDAP configuration registry_lock: anyOf: - $ref: '#/components/schemas/RegistryLockBase' - type: 'null' description: Registry lock configuration reserved_domains: anyOf: - $ref: '#/components/schemas/ReservedDomainsBase' - type: 'null' description: Reserved domains configuration tlds: description: List of TLDs being configured items: $ref: '#/components/schemas/TldBase' title: Tlds type: array transfer_policies: $ref: '#/components/schemas/TransferPoliciesBase' description: Transfer policies configuration verification_policies: anyOf: - additionalProperties: $ref: '#/components/schemas/VerificationPolicy' propertyNames: $ref: '#/components/schemas/VerificationPolicyType' type: object - type: 'null' description: Verification Policy Configuration title: Verification Policies whois: anyOf: - $ref: '#/components/schemas/WhoisBase' - type: 'null' description: WHOIS configuration required: - tlds - domain_lifecycle - domain_statuses - characters - idn - dns_configuration - transfer_policies title: TldSpecificationResponse type: object TmAddr: description: Address information (addrType in RFC 9361) properties: cc: description: ISO 3166-2 two-character country code maxLength: 2 minLength: 2 title: Cc type: string city: title: City type: string pc: anyOf: - type: string - type: 'null' title: Pc sp: anyOf: - type: string - type: 'null' title: Sp street: items: type: string maxItems: 3 minItems: 1 title: Street type: array required: - street - city - cc title: TmAddr type: object TmClaim: description: A single trademark claim within a notice (claimType in RFC 9361) properties: class_descs: description: Nice Classification descriptions items: $ref: '#/components/schemas/TmClassDesc' title: Class Descs type: array contacts: description: Zero or more contacts/representatives items: $ref: '#/components/schemas/TmContact' title: Contacts type: array goods_and_services: description: Full description of goods and services title: Goods And Services type: string holders: description: One or more holders of the mark items: $ref: '#/components/schemas/TmHolder' minItems: 1 title: Holders type: array jur_desc: $ref: '#/components/schemas/TmJurDesc' description: Jurisdiction where the mark is protected mark_name: description: Mark text string title: Mark Name type: string not_exact_match: anyOf: - $ref: '#/components/schemas/TmNotExactMatch' - type: 'null' description: Present if claim added by non-exact match rule required: - mark_name - holders - jur_desc - goods_and_services title: TmClaim type: object TmClassDesc: description: Nice Classification description (classDescType in RFC 9361) properties: class_num: description: Nice Classification class number title: Class Num type: integer description: description: Description of the class in English title: Description type: string required: - class_num - description title: TmClassDesc type: object TmContact: description: Contact / representative of the mark (contactType in RFC 9361) properties: addr: $ref: '#/components/schemas/TmAddr' email: title: Email type: string fax: anyOf: - type: string - type: 'null' title: Fax name: title: Name type: string org: anyOf: - type: string - type: 'null' title: Org type: $ref: '#/components/schemas/ContactType' voice: title: Voice type: string required: - type - name - addr - voice - email title: TmContact type: object TmCourt: description: Court resolution reference (courtType in RFC 9361) properties: cc: description: ISO 3166-2 jurisdiction country code maxLength: 2 minLength: 2 title: Cc type: string court_name: description: Name of the court title: Court Name type: string ref_num: description: Reference number of the court resolution title: Ref Num type: string region: description: Region(s) within the jurisdiction items: type: string title: Region type: array required: - ref_num - cc - court_name title: TmCourt type: object TmHolder: description: Holder of the mark (holderType in RFC 9361). name or org must be set. properties: addr: $ref: '#/components/schemas/TmAddr' email: anyOf: - type: string - type: 'null' title: Email entitlement: $ref: '#/components/schemas/HolderEntitlement' fax: anyOf: - type: string - type: 'null' title: Fax name: anyOf: - type: string - type: 'null' title: Name org: anyOf: - type: string - type: 'null' title: Org voice: anyOf: - type: string - type: 'null' title: Voice required: - entitlement - addr title: TmHolder type: object TmJurDesc: description: Jurisdiction description (jurDescType in RFC 9361) properties: description: description: Name of jurisdiction in English title: Description type: string jur_cc: description: WIPO ST.3 two-character jurisdiction code maxLength: 2 minLength: 2 title: Jur Cc type: string required: - jur_cc - description title: TmJurDesc type: object TmNotExactMatch: description: Signals claim was added by non-exact match rules (noExactMatchType in RFC 9361) properties: court: items: $ref: '#/components/schemas/TmCourt' title: Court type: array intro: default: 'This domain name label has previously been found to be used or registered abusively against the following trademarks according to the referenced decisions:' description: Introductory text for the non-exact match section title: Intro type: string udrp: items: $ref: '#/components/schemas/TmUdrp' title: Udrp type: array title: TmNotExactMatch type: object TmUdrp: description: UDRP case reference (udrpType in RFC 9361) properties: case_no: description: UDRP case number title: Case No type: string udrp_provider: description: Name of the UDRP provider title: Udrp Provider type: string required: - case_no - udrp_provider title: TmUdrp type: object TrademarkClaimsBase: properties: end_date: anyOf: - format: date-time type: string - type: 'null' description: End date of trademark claims title: End Date start_date: anyOf: - format: date-time type: string - type: 'null' description: Start date of trademark claims title: Start Date supported: description: Whether trademark claims are supported title: Supported type: boolean tmch_required: anyOf: - type: boolean - type: 'null' description: If true, claim notifications are mandatory within the timeframe title: Tmch Required required: - supported title: TrademarkClaimsBase type: object TransferAckType: enum: - none - registrar - registrant - both title: TransferAckType type: string TransferLockPolicyBase: properties: supported_by_registrar: description: Whether the registrar supports transfer locks title: Supported By Registrar type: boolean supported_by_registry: description: Whether the registry supports transfer locks title: Supported By Registry type: boolean required: - supported_by_registry - supported_by_registrar title: TransferLockPolicyBase type: object TransferPoliciesBase: properties: authinfo_max_length: anyOf: - minimum: 1.0 type: integer - type: 'null' description: Maximum length of the auth info title: Authinfo Max Length authinfo_min_length: anyOf: - minimum: 1.0 type: integer - type: 'null' description: Minimum length of the auth info title: Authinfo Min Length authinfo_pattern: anyOf: - type: string - type: 'null' description: Regex pattern for validating auth info title: Authinfo Pattern authinfo_required: description: Whether an auth info is required for transfers title: Authinfo Required type: boolean authinfo_set_by_registrar: default: true description: Whether the registrar can set the auth info, or whether the registry controls it title: Authinfo Set By Registrar type: boolean authinfo_time_limited: anyOf: - type: boolean - type: 'null' description: Whether an auth info has a time limit title: Authinfo Time Limited authinfo_validity_period: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: Validity period of the auth info (e.g., '5D' for 5 days) title: Authinfo Validity Period contacts_in_transfer_command: default: false description: Whether the registry takes the domain contacts on the transfer command itself title: Contacts In Transfer Command type: boolean info_contact_authinfo: anyOf: - type: boolean - type: 'null' description: Whether querying a foreign contact with authinfo is possible title: Info Contact Authinfo info_domain_authinfo: anyOf: - type: boolean - type: 'null' description: Whether querying a foreign domain with authinfo is possible title: Info Domain Authinfo post_transfer_requirements: anyOf: - items: $ref: '#/components/schemas/PostTransferRequirements' type: array - type: 'null' description: 'Post-transfer requirements: lists the behaviors, as in [''update_contacts'', ''set_transfer_lock''] or [ ''tld_specific'' ] for specific behavior' title: Post Transfer Requirements transfer_ack: anyOf: - $ref: '#/components/schemas/TransferAckType' - type: 'null' description: Whether a transfer can be approved transfer_email_required: anyOf: - type: boolean - type: 'null' description: Whether an email confirmation is required to perform the transfer title: Transfer Email Required transfer_lock_policy: $ref: '#/components/schemas/TransferLockPolicyBase' description: Transfer lock policy transfer_nack: anyOf: - $ref: '#/components/schemas/TransferAckType' - type: 'null' description: Whether a transfer can be denied transfer_renewal_period: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: If transfer_renews_domain is true, the renewal period (e.g., '1Y' for 1 year) title: Transfer Renewal Period transfer_renews_domain: anyOf: - type: boolean - type: 'null' description: Whether a transfer triggers a domain renewal title: Transfer Renews Domain transfer_time: anyOf: - examples: - P5D - P1Y pattern: ^\-?P?(\d+Y)?(\d+M)?(\d+D)?T?(\d+H)?(\d+M)?(\d+S)?$ type: string - type: 'null' description: Time duration of transfers in ISO 8601 format (e.g., 5D, -7D) according to the policy, 0 = real-time title: Transfer Time required: - transfer_lock_policy - authinfo_required title: TransferPoliciesBase type: object UsageGranularity: enum: - day - week - month title: UsageGranularity type: string UsageProduct: enum: - ai_inference title: UsageProduct type: string User: properties: created_on: description: The date/time the entry was created on format: date-time title: Created On type: string email: description: The user's email address format: email title: Email type: string first_name: description: The user's first name maxLength: 255 minLength: 1 title: First Name type: string keycloak_user_id: anyOf: - type: string - type: 'null' description: Keycloak user id title: Keycloak User Id last_name: description: The user's last name maxLength: 255 minLength: 1 title: Last Name type: string locale: examples: - en_US title: Locale type: string organization_id: default: None description: The user's organization id examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization phone: anyOf: - format: phone type: string - type: 'null' description: The user's phone number examples: - '+1.2125552368' title: Phone updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string user_id: examples: - user_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: User Id type: string x-typeid-prefix: user username: description: The user's unique username maxLength: 128 minLength: 3 pattern: ^[a-zA-Z0-9\-+_@.]+$ title: Username type: string required: - username - first_name - last_name - email - locale title: User type: object UserAgentStatsBucket: properties: key: title: Key type: string total: title: Total type: integer unique: title: Unique type: integer required: - key - total - unique title: UserAgentStatsBucket type: object UserAgreementAcceptance: properties: accepted: description: Whether the agreement has been accepted. title: Accepted type: boolean type: $ref: '#/components/schemas/AgreementType' description: Type of agreement being accepted. url: anyOf: - format: uri maxLength: 2083 minLength: 1 type: string - type: 'null' description: URL where the agreement can be found. title: Url version: anyOf: - type: string - type: 'null' description: Version of the agreement being accepted. title: Version required: - type - accepted title: UserAgreementAcceptance type: object UserAttributeBase: properties: key: description: Key of the attribute. minLength: 1 title: Key type: string value: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: Value of the attribute. required: - key title: UserAttributeBase type: object UserAttributeResponse: properties: key: description: Key of the attribute. minLength: 1 title: Key type: string value: anyOf: - $ref: '#/components/schemas/JsonValue' - type: 'null' description: Value of the attribute. required: - key title: UserAttributeResponse type: object UserCreate: properties: email: description: The user's email address format: email title: Email type: string first_name: description: The user's first name maxLength: 255 minLength: 1 title: First Name type: string last_name: description: The user's last name maxLength: 255 minLength: 1 title: Last Name type: string locale: examples: - en_US title: Locale type: string password: anyOf: - examples: - correcthorsebatterystaple type: string - type: 'null' description: Plaintext password for hashing during creation title: Password phone: anyOf: - format: phone type: string - type: 'null' description: The user's phone number examples: - '+1.2125552368' title: Phone user_attributes: anyOf: - items: $ref: '#/components/schemas/UserAttributeBase' type: array - type: 'null' description: User attributes title: User Attributes username: description: The user's unique username maxLength: 128 minLength: 3 pattern: ^[a-zA-Z0-9\-+_@.]+$ title: Username type: string required: - username - first_name - last_name - email - locale title: UserCreate type: object UserOrganizationMeta: properties: currency: anyOf: - $ref: '#/components/schemas/Currency' - type: 'null' description: Currency used by the user's organization. parent_organization_id: anyOf: - examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ type: string x-typeid-prefix: organization - type: 'null' description: ID of the parent organization, if any. title: Parent Organization Id title: UserOrganizationMeta type: object UserProfile: properties: created_on: description: The date/time the entry was created on format: date-time title: Created On type: string email: description: The user's email address format: email title: Email type: string first_name: description: The user's first name maxLength: 255 minLength: 1 title: First Name type: string last_name: description: The user's last name maxLength: 255 minLength: 1 title: Last Name type: string locale: examples: - en_US title: Locale type: string organization: anyOf: - $ref: '#/components/schemas/UserOrganizationMeta' - type: 'null' organization_id: default: None description: The user's organization id examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization permissions: anyOf: - items: $ref: '#/components/schemas/PublicPermission' type: array - type: 'null' title: Permissions phone: anyOf: - format: phone type: string - type: 'null' description: The user's phone number examples: - '+1.2125552368' title: Phone role: anyOf: - $ref: '#/components/schemas/PublicRole' - $ref: '#/components/schemas/CustomRoleLabel' - type: 'null' title: Role updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string user_attributes: additionalProperties: $ref: '#/components/schemas/JsonValue' description: All of the user attributes examples: - array: - 1 - 2 - 3 bool: true number: 1 string: value2 title: User Attributes type: object user_id: examples: - user_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: User Id type: string x-typeid-prefix: user username: description: The user's unique username maxLength: 128 minLength: 3 pattern: ^[a-zA-Z0-9\-+_@.]+$ title: Username type: string required: - username - first_name - last_name - email - locale title: UserProfile type: object UserPublic: properties: created_on: description: The date/time the entry was created on format: date-time title: Created On type: string email: description: The user's email address format: email title: Email type: string first_name: description: The user's first name maxLength: 255 minLength: 1 title: First Name type: string last_name: description: The user's last name maxLength: 255 minLength: 1 title: Last Name type: string locale: examples: - en_US title: Locale type: string organization_id: default: None description: The user's organization id examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization phone: anyOf: - format: phone type: string - type: 'null' description: The user's phone number examples: - '+1.2125552368' title: Phone updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string user_id: examples: - user_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: User Id type: string x-typeid-prefix: user username: description: The user's unique username maxLength: 128 minLength: 3 pattern: ^[a-zA-Z0-9\-+_@.]+$ title: Username type: string required: - username - first_name - last_name - email - locale title: UserPublic type: object UserPublicWithAttributes: properties: created_on: description: The date/time the entry was created on format: date-time title: Created On type: string email: description: The user's email address format: email title: Email type: string first_name: description: The user's first name maxLength: 255 minLength: 1 title: First Name type: string last_name: description: The user's last name maxLength: 255 minLength: 1 title: Last Name type: string locale: examples: - en_US title: Locale type: string organization_id: default: None description: The user's organization id examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization phone: anyOf: - format: phone type: string - type: 'null' description: The user's phone number examples: - '+1.2125552368' title: Phone updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string user_attributes: additionalProperties: $ref: '#/components/schemas/JsonValue' description: All of the user attributes examples: - array: - 1 - 2 - 3 bool: true number: 1 string: value2 title: User Attributes type: object user_id: examples: - user_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: User Id type: string x-typeid-prefix: user username: description: The user's unique username maxLength: 128 minLength: 3 pattern: ^[a-zA-Z0-9\-+_@.]+$ title: Username type: string required: - username - first_name - last_name - email - locale title: UserPublicWithAttributes type: object UserPublicWithRole: properties: created_on: description: The date/time the entry was created on format: date-time title: Created On type: string email: description: The user's email address format: email title: Email type: string first_name: description: The user's first name maxLength: 255 minLength: 1 title: First Name type: string last_name: description: The user's last name maxLength: 255 minLength: 1 title: Last Name type: string locale: examples: - en_US title: Locale type: string organization_id: default: None description: The user's organization id examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization phone: anyOf: - format: phone type: string - type: 'null' description: The user's phone number examples: - '+1.2125552368' title: Phone role: anyOf: - $ref: '#/components/schemas/PublicRole' - $ref: '#/components/schemas/CustomRoleLabel' - type: 'null' title: Role updated_on: description: The date/time the entry was last updated on format: date-time title: Updated On type: string user_id: examples: - user_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^user_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: User Id type: string x-typeid-prefix: user username: description: The user's unique username maxLength: 128 minLength: 3 pattern: ^[a-zA-Z0-9\-+_@.]+$ title: Username type: string required: - username - first_name - last_name - email - locale title: UserPublicWithRole type: object UserSortField: enum: - created_on - username - email title: UserSortField type: string UserTokenResponse: properties: access_token: examples: - eyJhbGciOiJSUzI1NiJ9.eyJpc3MiOiJodHRwczovL2FwaS5vcHVzZG5zLmNvbSJ9.signature title: Access Token type: string expires_in: examples: - 3600 title: Expires In type: integer refresh_expires_in: examples: - 86400 title: Refresh Expires In type: integer refresh_token: examples: - eyJhbGciOiJSUzI1NiJ9.eyJ0eXBlIjoicmVmcmVzaCJ9.signature title: Refresh Token type: string token_type: default: Bearer examples: - Bearer title: Token Type type: string required: - access_token - expires_in - refresh_token - refresh_expires_in title: UserTokenResponse type: object UserUpdate: properties: email: anyOf: - format: email type: string - type: 'null' description: The user's email address title: Email first_name: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The user's first name title: First Name last_name: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The user's last name title: Last Name locale: anyOf: - examples: - en_US type: string - type: 'null' description: The user's locale title: Locale phone: anyOf: - format: phone type: string - type: 'null' description: The user's phone number title: Phone user_attributes: anyOf: - items: $ref: '#/components/schemas/UserAttributeBase' type: array - type: 'null' description: User attributes title: User Attributes username: anyOf: - maxLength: 255 minLength: 1 type: string - type: 'null' description: The user's unique username title: Username title: UserUpdate type: object ValidationError: properties: ctx: title: Context type: object input: title: Input loc: items: anyOf: - type: string - type: integer title: Location type: array msg: title: Message type: string type: title: Error Type type: string required: - loc - msg - type title: ValidationError type: object VanityNameserverDTO: properties: hostname: description: Fully-qualified hostname of the vanity nameserver title: Hostname type: string position: description: Ordering within the set; lowest position becomes SOA MNAME minimum: 0.0 title: Position type: integer required: - hostname - position title: VanityNameserverDTO type: object VanityNameserverSetCreate: description: 'Public create request body. The owning org comes from auth context, and the anycast IPs are allocated server-side from `VanityNameserversConfig`, so neither is accepted here.' properties: hostnames: description: Fully-qualified vanity NS hostnames, ordered by intended position. items: type: string maxItems: 4 minItems: 1 title: Hostnames type: array name: description: Human-readable name for the set maxLength: 255 minLength: 1 title: Name type: string parent_domain_name: description: Apex domain of the vanity NS zone; all hostnames must be subdomains. title: Parent Domain Name type: string soa_rname: description: SOA RNAME stamped verbatim into the vanity NS zone maxLength: 255 minLength: 1 title: Soa Rname type: string required: - name - parent_domain_name - soa_rname - hostnames title: VanityNameserverSetCreate type: object VanityNameserverSetDTO: properties: name: description: Human-readable name for the vanity NS set title: Name type: string nameservers: description: Nameservers in the set, ordered by position items: $ref: '#/components/schemas/VanityNameserverDTO' title: Nameservers type: array parent_domain_name: description: Parent domain used as the apex of the vanity NS zone title: Parent Domain Name type: string set_id: description: Stable identifier for the vanity NS set examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Set Id type: string x-typeid-prefix: vns soa_rname: description: SOA RNAME used verbatim when creating vanity-branded zones title: Soa Rname type: string required: - set_id - name - parent_domain_name - soa_rname title: VanityNameserverSetDTO type: object VanityNameserverSetStatusDTO: description: "Wire mirror of `VanityNameserverSetStatus` \u2014 local so dns_client\ \ doesn't\npull schema imports." enum: - provisioning - active - suspended - failed - deleting title: VanityNameserverSetStatusDTO type: string VanityNameserverSetSummaryDTO: description: 'Status-aware variant of `VanityNameserverSetDTO` for list/get endpoints. `VanityNameserverSetDTO` stays the brandable-only read shape (always ACTIVE).' properties: expires_on: anyOf: - format: date-time type: string - type: 'null' description: When the vanity nameserver set's current service period ends (renews or lapses) title: Expires On grace_period_ends_at: anyOf: - format: date-time type: string - type: 'null' description: When the grace period ends, or null when the set is not in a grace period title: Grace Period Ends At is_default: description: Whether this is the org's default vanity NS set title: Is Default type: boolean name: description: Human-readable name for the vanity NS set title: Name type: string nameservers: description: Nameservers in the set, ordered by position items: $ref: '#/components/schemas/VanityNameserverDTO' title: Nameservers type: array organization_id: description: Owning organization examples: - organization_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Organization Id type: string x-typeid-prefix: organization parent_domain_name: description: Parent domain used as the apex of the vanity NS zone title: Parent Domain Name type: string renew_scheduled_at: anyOf: - format: date-time type: string - type: 'null' description: When the next automatic renewal is scheduled. Null when the set will not renew. title: Renew Scheduled At renewal_mode: anyOf: - $ref: '#/components/schemas/RenewalModeDTO' - type: 'null' description: Whether the set is set to renew or expire at the end of the current period set_id: description: Stable identifier for the vanity NS set examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Set Id type: string x-typeid-prefix: vns soa_rname: description: SOA RNAME used verbatim when creating vanity-branded zones title: Soa Rname type: string status: $ref: '#/components/schemas/VanityNameserverSetStatusDTO' description: Lifecycle status of the set required: - set_id - organization_id - name - parent_domain_name - soa_rname - status - is_default title: VanityNameserverSetSummaryDTO type: object VanityNsCheckConfidence: enum: - authoritative - best_effort title: VanityNsCheckConfidence type: string VanityNsCheckPublicReq: description: 'Public `/check` request body. The owning org comes from auth context, so only the set identifier is accepted here.' properties: set_id: description: The vanity NS set to diagnose examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Set Id type: string x-typeid-prefix: vns required: - set_id title: VanityNsCheckPublicReq type: object VanityNsCheckRes: properties: checks: description: Individual diagnostic checks items: $ref: '#/components/schemas/VanityNsCheckResultDTO' title: Checks type: array parent_domain_name: description: Parent domain of the set's vanity NS hostnames title: Parent Domain Name type: string set_id: description: The diagnosed set examples: - vns_01h45ytscbebyvny4gc8cr8ma2 format: typeid pattern: ^vns_[0-7][0-9a-hjkmnpq-tv-z]{25}$ title: Set Id type: string x-typeid-prefix: vns status: $ref: '#/components/schemas/VanityNameserverSetStatusDTO' description: Lifecycle status of the set at check time summary: $ref: '#/components/schemas/VanityNsCheckSummaryDTO' description: Synthesized overall verdict required: - set_id - parent_domain_name - status - summary title: VanityNsCheckRes type: object VanityNsCheckResultDTO: properties: confidence: $ref: '#/components/schemas/VanityNsCheckConfidence' description: How authoritative the observation is detail: description: Customer-facing explanation of the result title: Detail type: string id: description: Stable identifier for the individual check title: Id type: string label: description: Human-readable check name title: Label type: string observed: anyOf: - additionalProperties: true type: object - type: 'null' description: Structured observation (e.g. addresses seen, mismatches) for the customer title: Observed remediation: anyOf: - type: string - type: 'null' description: Suggested next step when the check did not pass title: Remediation severity: $ref: '#/components/schemas/VanityNsCheckSeverity' description: How much this check matters to the overall verdict source: $ref: '#/components/schemas/VanityNsCheckSource' description: Where the observation came from status: $ref: '#/components/schemas/VanityNsCheckStatus' description: Per-check verdict required: - id - label - status - severity - source - confidence - detail title: VanityNsCheckResultDTO type: object VanityNsCheckSeverity: enum: - required - recommended - optional title: VanityNsCheckSeverity type: string VanityNsCheckSource: enum: - public_dns - authoritative_dns - registry_epp title: VanityNsCheckSource type: string VanityNsCheckStatus: enum: - pass - fail - warn - info title: VanityNsCheckStatus type: string VanityNsCheckSummaryDTO: properties: detail: description: Customer-facing summary of the overall verdict title: Detail type: string state: $ref: '#/components/schemas/VanityNsCheckSummaryState' description: Overall verdict synthesized from the checks required: - state - detail title: VanityNsCheckSummaryDTO type: object VanityNsCheckSummaryState: description: Top-level verdict synthesized from the individual checks. enum: - ready - propagating - action_required - degraded title: VanityNsCheckSummaryState type: string VerificationClaimType: enum: - name - address - email - phone title: VerificationClaimType type: string VerificationDeadline: properties: date: format: date-time title: Date type: string type: $ref: '#/components/schemas/VerificationDeadlineType' required: - type - date title: VerificationDeadline type: object VerificationDeadlineType: enum: - dedelegation - deletion title: VerificationDeadlineType type: string VerificationPolicy: anyOf: - $ref: '#/components/schemas/EmailVerificationPolicy' - $ref: '#/components/schemas/IdentityVerificationPolicy' VerificationPolicyType: enum: - email_verification - identity_verification title: VerificationPolicyType type: string VerificationRegistrantDetails: properties: contact_id: title: Contact Id type: string email: title: Email type: string name: title: Name type: string required: - contact_id - name - email title: VerificationRegistrantDetails type: object VerificationResponse: properties: claims: description: Verification claims items: $ref: '#/components/schemas/VerificationClaimType' title: Claims type: array deadlines: description: Verification deadlines items: $ref: '#/components/schemas/VerificationDeadline' title: Deadlines type: array required: - claims title: VerificationResponse type: object VerificationType: enum: - api - email title: VerificationType type: string VisitsByKeyBucket: properties: key: title: Key type: string total: title: Total type: integer unique: title: Unique type: integer required: - key - total - unique title: VisitsByKeyBucket type: object WaitlistApplyRequest: description: What you say when applying for a product. properties: note: anyOf: - maxLength: 1000 minLength: 1 type: string - type: 'null' description: What you would use the product for examples: - We manage 12k domains for agency clients and triage renewals by hand. title: Note title: WaitlistApplyRequest type: object WaitlistEntryResponse: description: Your own waitlist application. properties: applied_on: description: When you applied format: date-time title: Applied On type: string decided_on: anyOf: - format: date-time type: string - type: 'null' description: When the application was decided; null while it is pending title: Decided On product: $ref: '#/components/schemas/WaitlistProduct' description: Product the application is for status: $ref: '#/components/schemas/WaitlistEntryStatus' description: Where the application stands required: - product - status - applied_on title: WaitlistEntryResponse type: object WaitlistEntryStatus: enum: - pending - granted - rejected title: WaitlistEntryStatus type: string WaitlistProduct: description: 'A product that is not generally available and is reached through the waitlist. The member value is the wire form used in URLs and API bodies; the column persists the member NAME (StringEnum binds `value.name`), so renaming a member is a data migration.' enum: - ai_concierge title: WaitlistProduct type: string WaitlistProductListResponse: description: The waitlisted products you may see. properties: products: description: Waitlisted products you may see items: $ref: '#/components/schemas/WaitlistProductState' title: Products type: array title: WaitlistProductListResponse type: object WaitlistProductState: description: A waitlisted product, and where your own application for it stands. properties: applied_on: anyOf: - format: date-time type: string - type: 'null' description: When you applied, if you have title: Applied On can_apply: description: Whether an apply from you would be accepted right now; false for an API key title: Can Apply type: boolean decided_on: anyOf: - format: date-time type: string - type: 'null' description: When your application was decided, if it was title: Decided On description: description: What the product does title: Description type: string display_name: description: Human-readable product name title: Display Name type: string product: $ref: '#/components/schemas/WaitlistProduct' description: Product key, used in the apply path status: anyOf: - $ref: '#/components/schemas/WaitlistEntryStatus' - type: 'null' description: Where your application stands; null until you apply, and for an API key required: - product - display_name - description - can_apply title: WaitlistProductState type: object WhitelabelBaseCreate: additionalProperties: false description: 'Create the base tier: served on a managed subdomain composed from `label`.' properties: label: description: Managed-subdomain label; composed into app.