{ "openapi": "3.1.0", "info": { "title": "MeowMeow Domains customer API", "version": "1.0.0", "description": "# MeowMeow Domains API v1\n\nBase URL: the same HTTPS origin as this document, /api/v1.\nOpenAPI: /api/v1/openapi.json. Human documentation: /api/docs.\nCreate a key in the Telegram bot: Profile > API > Create key.\nSet Authorization: Bearer YOUR_KEY. Never put a secret in a URL, source code,\nlogs, prompts shared with third parties or version control. Use an environment\nvariable or your agent's secret store. Keys are customer-scoped and revocable.\n\nOne key provides all API features for its owner's account. There are no key\ntypes, per-order or daily spending caps, or per-key request quotas. The key\ndoes not expire automatically. Purchases use the available account balance.\nCreate, replace or disable the key in Profile > API. Replacement immediately\ninvalidates the old key; update your agent with the new secret.\nDisabling a key does not cancel jobs already accepted. The API cannot enable\nautorenew. Never share your key with anyone you do not trust with your account.\n\nPurchase workflow:\n1. GET /account: check available balance and purchases_enabled.\n2. POST /domains/search {\"query\":\"my-project\",\"category\":\"basic\"}.\n Results contain available names only, indicative USD prices, not guarantees.\n3. POST /quotes with a new Idempotency-Key, e.g. a UUID:\n {\"names\":[\"example.com\"],\"kind\":\"registration\",\"period\":1,\n \"category\":\"basic\",\"configuration\":{\"mode\":\"skip\"}}.\n Exact quote, expiry, Prime pricing and total are returned; no purchase yet.\n Registration is one year. Renewals: kind renewal, period 1\u201310 subject to\n domain eligibility; inspect renewal_periods on GET /domains/{id}.\n4. Verify total and expiry against the user's explicit spending authorization.\n POST /orders/{id}/confirm with {} and a NEW Idempotency-Key.\n5. Poll GET /orders/{id}. A 202 means accepted, NOT registered or TLS ready.\n Item status succeeded means that item completed. partial means some items\n failed; inspect every item. unknown requires reconciliation, not repurchase.\n6. GET /domains to find the registered domain ID. GET /domains/{id} separately\n reports Cloudflare/TLS state. Certificate issuance is asynchronous.\n\nAll writes except read-only search require an Idempotency-Key (8\u2013128 ASCII\nletters/digits/._:-). Retry the SAME action with the SAME key and SAME JSON.\nReusing a key for a different payload returns 409. Stored responses may have an\nolder status: poll the resource for current state. If the response is lost, retry\nwith the same key. For request_processing or internal uncertainty, poll the\nreturned /requests/{request_id}. NEVER submit an uncertain purchase with a new\nkey. If no linked resource appears, contact support; do not guess the outcome.\n\nGET /domains/{id}/dns returns a local provider snapshot. To refresh it, queue\ndns.sync and poll the operation before reading it again. DNS changes are queued\nusing POST /domains/{id}/operations with {\"kind\":\"dns.add\",\"payload\":{\n\"record_type\":\"A\",\"name\":\"*\",\"content\":\"YOUR_PUBLIC_SERVER_IP\",\n\"ttl\":300,\"proxied\":false}}. Use a public routable IP you control.\nNames: @ apex, * wildcard, or a label. All owned domain changes are async.\nFor dns.rrset, supply expected from the corresponding snapshot's rrsets list\n(or empty_rrset_expected for a previously absent set), plus record_type, name\nand values [{content,ttl,proxied,priority,comment}]. An empty values list deletes\nthat name/type. A stale snapshot is rejected; do not overwrite unseen changes.\nNo internal provider IDs, checkpoint fields or foreign domains are accepted.\n\nNS changes use ns.set with nameservers (2\u201320 hostnames). native.configure\nswitches delegation to the registrar; cloudflare.connect connects Cloudflare\nand can change delegation. These can affect website availability: obtain the\nuser's approval before changing hosting/delegation. cloudflare.setting uses\nsetting/value; for GEO add countries, an array of ISO alpha-2 codes (e.g. [\"US\",\"DE\"]).\nGEO is per-domain, not a service preset. value=true requires a nonempty list;\nvalue=false disables the rule, and countries=[] clears the selection.\nOmitting countries reuses the domain's saved selection.\nAvailable values are in GET /domains/{id}. cloudflare.proxy uses\nenabled true/false. cloudflare.purge clears cache. New Cloudflare connections\nrequire Prime; existing entitled connections remain editable after expiry.\nCloudflare availability/SSL is not immediate or guaranteed by operation enqueue.\nRedirect and glue schemas are in OpenAPI. No external domain import/transfer.\n\nList pagination: GET /orders and /domains accept limit 1\u2013100, offset 0\u2013100000;\nresponse contains items,total,next_offset. Monetary values are decimal STRINGS\nin USD. Timestamps are ISO 8601. Error JSON: error.code,error.message,request_id.\nDo not rely on human message wording. 401 invalid key, 409 idempotency conflict\nor request in progress, 422 invalid/business request (including insufficient\nbalance), 503 provider/feature temporarily unavailable. Respect Retry-After.\nPagination and request-size validation are protocol constraints, not usage quotas.\nAPI never exposes registrar/Cloudflare credentials. Keep API keys private.\n" }, "servers": [ { "url": "/api/v1" } ], "paths": { "/account": { "get": { "summary": "Get account balance and purchase availability", "operationId": "get_account", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/catalog": { "get": { "summary": "Get indicative basic prices (.com first)", "operationId": "get_catalog", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Catalog" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/domains/search": { "post": { "summary": "Search available domains (read-only)", "operationId": "post_domains_search", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Search" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Search" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Search" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "query": { "type": "string" }, "category": { "type": "string", "enum": [ "basic", "protected" ] } }, "required": [ "query" ], "additionalProperties": false } } } } } }, "/quotes": { "post": { "summary": "Create exact quote, without purchasing", "operationId": "post_quotes", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{8,128}$" }, "description": "Unique action identifier. Reuse exactly on retries of the same request." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "names": { "type": "array", "items": { "type": "string" }, "minItems": 1, "maxItems": 50 }, "kind": { "type": "string", "enum": [ "registration", "renewal" ], "default": "registration" }, "category": { "type": "string", "enum": [ "basic", "protected" ], "default": "basic" }, "period": { "type": "integer", "minimum": 1, "maximum": 10, "default": 1 }, "configuration": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "skip", "a", "ns", "cloudflare" ] }, "ip": { "type": "string" }, "nameservers": { "type": "array", "items": { "type": "string" }, "minItems": 2, "maxItems": 20 } }, "required": [], "additionalProperties": false } }, "required": [ "names" ], "additionalProperties": false } } } } } }, "/orders": { "get": { "summary": "List own orders", "operationId": "get_orders", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 100000, "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Orders" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orders/{id}": { "get": { "summary": "Get current order and item states", "operationId": "get_orders_id", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/orders/{id}/confirm": { "post": { "summary": "Reserve funds and queue purchase", "operationId": "post_orders_id_confirm", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{8,128}$" }, "description": "Unique action identifier. Reuse exactly on retries of the same request." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } } } }, "/orders/{id}/cancel": { "post": { "summary": "Cancel an unconfirmed quote", "operationId": "post_orders_id_cancel", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{8,128}$" }, "description": "Unique action identifier. Reuse exactly on retries of the same request." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } } } }, "/domains": { "get": { "summary": "List own domains, including archived", "operationId": "get_domains", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "limit", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 } }, { "name": "offset", "in": "query", "schema": { "type": "integer", "minimum": 0, "maximum": 100000, "default": 0 } } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domains" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domains" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domains" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/domains/{id}": { "get": { "summary": "Get domain, delegation and Cloudflare state", "operationId": "get_domains_id", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Domain" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/domains/{id}/dns": { "get": { "summary": "Get DNS snapshot and compare-and-replace signatures", "operationId": "get_domains_id_dns", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNS" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNS" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DNS" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/domains/{id}/redirects": { "get": { "summary": "List redirects", "operationId": "get_domains_id_redirects", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Redirects" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Redirects" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Redirects" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/domains/{id}/glue": { "get": { "summary": "List own nameserver hosts", "operationId": "get_domains_id_glue", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Glue" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Glue" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Glue" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/domains/{id}/operations": { "post": { "summary": "Queue validated DNS/NS/Cloudflare/redirect/glue operation", "operationId": "post_domains_id_operations", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "pattern": "^[A-Za-z0-9._:-]{8,128}$" }, "description": "Unique action identifier. Reuse exactly on retries of the same request." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "type": "object", "properties": { "kind": { "const": "dns.add", "type": "string" }, "payload": { "type": "object", "properties": { "record_type": { "type": "string" }, "name": { "type": "string" }, "content": { "type": "string" }, "ttl": { "type": "integer" }, "priority": { "type": "integer" }, "proxied": { "type": "boolean" }, "comment": { "type": "string" } }, "required": [ "record_type", "name", "content" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "dns.update", "type": "string" }, "payload": { "type": "object", "properties": { "record_id": { "type": "integer" }, "record_type": { "type": "string" }, "name": { "type": "string" }, "content": { "type": "string" }, "ttl": { "type": "integer" }, "priority": { "type": "integer" }, "proxied": { "type": "boolean" }, "comment": { "type": "string" } }, "required": [ "record_id", "record_type", "name", "content" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "dns.delete", "type": "string" }, "payload": { "type": "object", "properties": { "record_id": { "type": "integer" } }, "required": [ "record_id" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "dns.sync", "type": "string" }, "payload": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "dns.rrset", "type": "string" }, "payload": { "type": "object", "properties": { "record_type": { "type": "string" }, "name": { "type": "string" }, "values": { "type": "array", "maxItems": 50, "items": { "type": "object", "properties": { "content": { "type": "string" }, "ttl": { "type": "integer" }, "priority": { "type": "integer" }, "proxied": { "type": "boolean" }, "comment": { "type": "string" } }, "required": [ "content" ], "additionalProperties": false } }, "expected": { "type": "string" } }, "required": [ "record_type", "name", "values", "expected" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "ns.set", "type": "string" }, "payload": { "type": "object", "properties": { "nameservers": { "type": "array", "items": { "type": "string" }, "minItems": 2, "maxItems": 20 } }, "required": [ "nameservers" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "native.configure", "type": "string" }, "payload": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "cloudflare.connect", "type": "string" }, "payload": { "type": "object", "properties": { "ip": { "type": "string" } }, "required": [], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "cloudflare.setting", "type": "string" }, "payload": { "type": "object", "properties": { "setting": { "type": "string" }, "value": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "type": "boolean" } ] }, "countries": { "type": "array", "items": { "type": "string", "pattern": "^[A-Za-z]{2}$" }, "maxItems": 249, "description": "ISO 3166-1 alpha-2 country codes; GEO only, saved per domain." } }, "required": [ "setting", "value" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "cloudflare.proxy", "type": "string" }, "payload": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "cloudflare.purge", "type": "string" }, "payload": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "glue.save", "type": "string" }, "payload": { "type": "object", "properties": { "name": { "type": "string" }, "ip": { "type": "string" }, "ip6": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "glue.delete", "type": "string" }, "payload": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "glue.sync", "type": "string" }, "payload": { "type": "object", "properties": {}, "required": [], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "redirect.save", "type": "string" }, "payload": { "type": "object", "properties": { "slug": { "type": "string" }, "target": { "type": "string" }, "status_code": { "type": "integer" }, "preserve_query": { "type": "boolean" }, "enabled": { "type": "boolean" }, "source_pattern": { "type": "string" } }, "required": [ "slug", "target" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false }, { "type": "object", "properties": { "kind": { "const": "redirect.delete", "type": "string" }, "payload": { "type": "object", "properties": { "redirect_id": { "type": "integer" } }, "required": [ "redirect_id" ], "additionalProperties": false } }, "required": [ "kind", "payload" ], "additionalProperties": false } ] } } } } } }, "/operations/{id}": { "get": { "summary": "Poll operation status; never blindly replay unknown", "operationId": "get_operations_id", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Operation" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/requests/{id}": { "get": { "summary": "Recover an idempotent request and linked resources", "operationId": "get_requests_id", "description": "Your API key supports this endpoint. See /api/agent-guide for retry and financial semantics.", "security": [ { "bearerAuth": [] } ], "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Domain: numeric ID; order/operation/request: UUID." } ], "responses": { "200": { "description": "Success", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } } }, "201": { "description": "Quote created", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } } }, "202": { "description": "Accepted; poll resource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Request" } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Invalid key", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "404": { "description": "Not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "409": { "description": "Idempotency conflict or request processing", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "422": { "description": "Validation/business error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Uncertain; poll request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "503": { "description": "Unavailable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "Error": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "error": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "message" ], "additionalProperties": false } }, "required": [ "request_id", "error" ], "additionalProperties": false }, "Account": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "currency": { "const": "USD" }, "balance": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "reserved": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "available": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "prime": { "type": "boolean" }, "prime_until": { "type": [ "string", "null" ], "format": "date-time" }, "purchases_enabled": { "type": "boolean" } }, "required": [ "request_id", "available", "purchases_enabled" ], "additionalProperties": false }, "Order": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "status": { "type": "string" }, "period": { "type": "integer" }, "category": { "type": "string" }, "currency": { "const": "USD" }, "total": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "prime_priced": { "type": "boolean" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "items": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "price": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "status": { "type": "string" } }, "required": [ "domain", "price", "status" ], "additionalProperties": false } } }, "required": [ "request_id", "id", "status", "total", "items" ], "additionalProperties": false }, "Operation": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "id": { "type": "string", "format": "uuid" }, "domain_id": { "type": "integer" }, "kind": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "needs_review": { "type": "boolean" }, "message": { "type": [ "string", "null" ] } }, "required": [ "request_id", "id", "status", "needs_review" ], "additionalProperties": false }, "Domain": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "id": { "type": "integer" }, "name": { "type": "string" }, "category": { "type": "string" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "autorenew": { "type": "boolean" }, "archived": { "type": "boolean" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "dns_backend": { "type": "string" }, "delegation": { "type": "string" }, "renewal_periods": { "type": "array", "items": { "type": "integer" } }, "cloudflare": { "type": "object", "properties": { "connected": { "type": "boolean" }, "status": { "type": "string" }, "ssl_status": { "type": "string" }, "origin_tls_status": { "type": "string" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "checked_at": { "type": [ "string", "null" ], "format": "date-time" }, "settings": { "type": "object" }, "geo_countries": { "type": "array", "items": { "type": "string" } }, "available_settings": { "type": "object" } }, "required": [], "additionalProperties": false } }, "required": [ "request_id", "id", "name", "cloudflare" ], "additionalProperties": false }, "Orders": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "status": { "type": "string" }, "period": { "type": "integer" }, "category": { "type": "string" }, "currency": { "const": "USD" }, "total": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "prime_priced": { "type": "boolean" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "items": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "price": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "status": { "type": "string" } }, "required": [ "domain", "price", "status" ], "additionalProperties": false } } }, "required": [ "id", "status", "total", "items" ], "additionalProperties": false } }, "total": { "type": "integer" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "request_id", "items", "total", "next_offset" ], "additionalProperties": false }, "Domains": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "category": { "type": "string" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "autorenew": { "type": "boolean" }, "archived": { "type": "boolean" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "dns_backend": { "type": "string" }, "delegation": { "type": "string" }, "renewal_periods": { "type": "array", "items": { "type": "integer" } }, "cloudflare": { "type": "object", "properties": { "connected": { "type": "boolean" }, "status": { "type": "string" }, "ssl_status": { "type": "string" }, "origin_tls_status": { "type": "string" }, "nameservers": { "type": "array", "items": { "type": "string" } }, "checked_at": { "type": [ "string", "null" ], "format": "date-time" }, "settings": { "type": "object" }, "geo_countries": { "type": "array", "items": { "type": "string" } }, "available_settings": { "type": "object" } }, "required": [], "additionalProperties": false } }, "required": [ "id", "name", "cloudflare" ], "additionalProperties": false } }, "total": { "type": "integer" }, "next_offset": { "type": [ "integer", "null" ] } }, "required": [ "request_id", "items", "total", "next_offset" ], "additionalProperties": false }, "Catalog": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "currency": { "const": "USD" }, "indicative": { "const": true }, "items": { "type": "array", "items": { "type": "object", "properties": { "extension": { "type": "string" }, "registration": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "renewal": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." } }, "required": [], "additionalProperties": false } } }, "required": [ "request_id", "items", "indicative" ], "additionalProperties": false }, "Search": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "currency": { "const": "USD" }, "indicative": { "const": true }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "price": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." } }, "required": [ "name", "price" ], "additionalProperties": false } } }, "required": [ "request_id", "items", "indicative" ], "additionalProperties": false }, "DNS": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "backend": { "type": "string" }, "delegation": { "type": "string" }, "snapshot": { "const": true }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "record_type": { "type": "string" }, "name": { "type": "string" }, "content": { "type": "string" }, "priority": { "type": [ "integer", "null" ] }, "ttl": { "type": "integer" }, "proxied": { "type": "boolean" }, "comment": { "type": "string" } }, "required": [], "additionalProperties": false } }, "rrsets": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "record_type": { "type": "string" }, "expected": { "type": "string" } }, "required": [], "additionalProperties": false } }, "empty_rrset_expected": { "type": "string" } }, "required": [ "request_id", "items", "rrsets", "empty_rrset_expected" ], "additionalProperties": false }, "Redirects": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "slug": { "type": "string" }, "target": { "type": "string" }, "enabled": { "type": "boolean" }, "status_code": { "type": "integer" }, "preserve_query": { "type": "boolean" }, "source_pattern": { "type": "string" } }, "required": [], "additionalProperties": false } } }, "required": [ "request_id", "items" ], "additionalProperties": false }, "Glue": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "ip": { "type": [ "string", "null" ] }, "ip6": { "type": [ "string", "null" ] } }, "required": [], "additionalProperties": false } } }, "required": [ "request_id", "items" ], "additionalProperties": false }, "Request": { "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid" }, "id": { "type": "string" }, "status": { "type": "string" }, "response": { "type": [ "object", "null" ] }, "response_status": { "type": [ "integer", "null" ] }, "order": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "kind": { "type": "string" }, "status": { "type": "string" }, "period": { "type": "integer" }, "category": { "type": "string" }, "currency": { "const": "USD" }, "total": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "prime_priced": { "type": "boolean" }, "expires_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "items": { "type": "array", "items": { "type": "object", "properties": { "domain": { "type": "string" }, "price": { "type": "string", "pattern": "^\\d+(\\.\\d+)?$", "description": "Decimal USD amount; never floating point." }, "status": { "type": "string" } }, "required": [ "domain", "price", "status" ], "additionalProperties": false } } }, "required": [ "id", "status", "total", "items" ], "additionalProperties": false }, { "type": "null" } ] }, "operation": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domain_id": { "type": "integer" }, "kind": { "type": "string" }, "status": { "type": "string" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "needs_review": { "type": "boolean" }, "message": { "type": [ "string", "null" ] } }, "required": [ "id", "status", "needs_review" ], "additionalProperties": false }, { "type": "null" } ] }, "message": { "type": "string" } }, "required": [ "request_id", "id", "status" ], "additionalProperties": false } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } } }