{"openapi":"3.1.0","info":{"title":"QuoAPI – Domains, TLS & Business Email API","version":"1.3.0","description":"Canonical QuoAPI public API contract. Provider details and internal routes are intentionally excluded."},"servers":[{"url":"https://api.quoapi.com"}],"tags":[{"name":"domains-api","description":"Manage domains, TLS certificates and business mailboxes as recurring API products."}],"paths":{"/v1/domain/search":{"post":{"operationId":"domain_search","summary":"Search domain","description":"Check domain availability.","tags":["domains-api"],"security":[{"BearerAuth":["domain.search"]}],"x-quoapi-capability":"domain.search","x-quoapi-contract-version":"1.3.0:domain.search","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","x-quoapi-widget":"text","title":"Domain","default":"example.com"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["domain"]},"example":{"domain":"example.com"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/domain/register":{"post":{"operationId":"domain_register","summary":"Register domain","description":"Register an available domain.","tags":["domains-api"],"security":[{"BearerAuth":["domain.register"]}],"x-quoapi-capability":"domain.register","x-quoapi-contract-version":"1.3.0:domain.register","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","x-quoapi-widget":"text","title":"Domain","default":"example.com"},"years":{"type":"number","x-quoapi-widget":"number","title":"Years","default":"1"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["domain","years"]},"example":{"domain":"example.com","years":"1"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/domain/transfer":{"post":{"operationId":"domain_transfer","summary":"Transfer domain","description":"Start a domain transfer.","tags":["domains-api"],"security":[{"BearerAuth":["domain.transfer"]}],"x-quoapi-capability":"domain.transfer","x-quoapi-contract-version":"1.3.0:domain.transfer","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","x-quoapi-widget":"text","title":"Domain","default":"example.com"},"auth_code":{"type":"string","x-quoapi-widget":"secret","title":"Auth Code","default":""},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["domain"]},"example":{"domain":"example.com","auth_code":""}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/domain/renew":{"post":{"operationId":"domain_renew","summary":"Renew domain","description":"Renew a domain.","tags":["domains-api"],"security":[{"BearerAuth":["domain.renew"]}],"x-quoapi-capability":"domain.renew","x-quoapi-contract-version":"1.3.0:domain.renew","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","x-quoapi-widget":"text","title":"Domain","default":"example.com"},"years":{"type":"number","x-quoapi-widget":"number","title":"Years","default":"1"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["domain","years"]},"example":{"domain":"example.com","years":"1"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/domain/whois":{"post":{"operationId":"domain_whois","summary":"Domain WHOIS","description":"Retrieve normalized registration metadata.","tags":["domains-api"],"security":[{"BearerAuth":["domain.whois"]}],"x-quoapi-capability":"domain.whois","x-quoapi-contract-version":"1.3.0:domain.whois","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","x-quoapi-widget":"text","title":"Domain","default":"example.com"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["domain"]},"example":{"domain":"example.com"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/tls/order":{"post":{"operationId":"tls_order","summary":"Order TLS certificate","description":"Order a supported TLS certificate.","tags":["domains-api"],"security":[{"BearerAuth":["tls.order"]}],"x-quoapi-capability":"tls.order","x-quoapi-contract-version":"1.3.0:tls.order","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","x-quoapi-widget":"text","title":"Domain","default":"example.com"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["domain"]},"example":{"domain":"example.com"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/tls/status":{"post":{"operationId":"tls_status","summary":"TLS order status","description":"Check certificate order status.","tags":["domains-api"],"security":[{"BearerAuth":["tls.status"]}],"x-quoapi-capability":"tls.status","x-quoapi-contract-version":"1.3.0:tls.status","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"order_id":{"type":"string","x-quoapi-widget":"text","title":"Order Id","default":"tls_demo_001"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["order_id"]},"example":{"order_id":"tls_demo_001"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/mailbox/create":{"post":{"operationId":"mailbox_create","summary":"Create mailbox","description":"Create a business mailbox.","tags":["domains-api"],"security":[{"BearerAuth":["mailbox.create"]}],"x-quoapi-capability":"mailbox.create","x-quoapi-contract-version":"1.3.0:mailbox.create","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"domain":{"type":"string","x-quoapi-widget":"text","title":"Domain","default":"example.com"},"local_part":{"type":"string","x-quoapi-widget":"text","title":"Local Part","default":"hello"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["domain","local_part"]},"example":{"domain":"example.com","local_part":"hello"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}},"/v1/mailbox/manage":{"post":{"operationId":"mailbox_manage","summary":"Manage mailbox","description":"Update mailbox settings.","tags":["domains-api"],"security":[{"BearerAuth":["mailbox.manage"]}],"x-quoapi-capability":"mailbox.manage","x-quoapi-contract-version":"1.3.0:mailbox.manage","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"mailbox_id":{"type":"string","x-quoapi-widget":"text","title":"Mailbox Id","default":"mbx_demo_001"},"country":{"type":"string","pattern":"^[A-Z]{2}$","x-quoapi-widget":"country","x-quoapi-hidden":true,"description":"Optional ISO 3166-1 alpha-2 routing context."},"currency":{"type":"string","pattern":"^[A-Z]{3}$","x-quoapi-widget":"currency","x-quoapi-hidden":true,"description":"Optional ISO 4217 commercial context."}},"additionalProperties":false,"required":["mailbox_id"]},"example":{"mailbox_id":"mbx_demo_001"}}}},"responses":{"200":{"description":"Canonical response","content":{"application/json":{"schema":{"type":"object","required":["data","request_id"],"properties":{"data":{"type":"object","additionalProperties":true,"description":"Canonical QuoAPI response data for this capability."},"request_id":{"type":"string"}}}}}},"4XX":{"description":"Canonical client error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"5XX":{"description":"Canonical service error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}}}}},"components":{"securitySchemes":{"BearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"QuoAPI API key"}},"schemas":{"ErrorResponse":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","message","request_id","details"],"properties":{"code":{"type":"string"},"message":{"type":"string"},"request_id":{"type":"string"},"details":{"type":"object","additionalProperties":true}}}}}}}}