{"info":{"title":"tempmailboxes public API","description":"Public inbox retention follows its creator’s plan. Private inboxes belong to their account owner. Each message keeps its original receipt deadline. Machine access requires an account-owned API key and the API feature.","version":"0.2.0"},"openapi":"3.1.2","paths":{"/auth/session":{"get":{"operationId":"getAuthSession"}},"/auth/email/start":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["email"],"properties":{"email":{"maxLength":254,"type":"string"},"next":{"maxLength":512,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["email"],"properties":{"email":{"maxLength":254,"type":"string"},"next":{"maxLength":512,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["email"],"properties":{"email":{"maxLength":254,"type":"string"},"next":{"maxLength":512,"type":"string"}}}}}},"operationId":"postAuthEmailStart"}},"/auth/email/verify":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["token"],"properties":{"token":{"maxLength":100,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["token"],"properties":{"token":{"maxLength":100,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["token"],"properties":{"token":{"maxLength":100,"type":"string"}}}}}},"operationId":"postAuthEmailVerify"}},"/auth/google/start":{"get":{"operationId":"getAuthGoogleStart"}},"/auth/google/callback":{"get":{"operationId":"getAuthGoogleCallback"}},"/auth/logout":{"post":{"operationId":"postAuthLogout"}},"/auth/inboxes/remove":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}}}},"operationId":"postAuthInboxesRemove"}},"/auth/inboxes":{"get":{"operationId":"getAuthInboxes"},"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["inboxes","selected","read"],"properties":{"inboxes":{"maxItems":10000,"type":"array","items":{"type":"object","required":["id","address","domain_id"],"properties":{"id":{"format":"uuid","type":"string"},"address":{"maxLength":320,"type":"string"},"domain_id":{"maxLength":253,"type":"string"},"visibility":{"type":"string","enum":["public","private"]}}}},"selected":{"maxLength":50,"type":["string","null"]},"read":{"maxItems":10000,"type":"array","items":{"maxLength":100,"type":"string"}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["inboxes","selected","read"],"properties":{"inboxes":{"maxItems":10000,"type":"array","items":{"type":"object","required":["id","address","domain_id"],"properties":{"id":{"format":"uuid","type":"string"},"address":{"maxLength":320,"type":"string"},"domain_id":{"maxLength":253,"type":"string"},"visibility":{"type":"string","enum":["public","private"]}}}},"selected":{"maxLength":50,"type":["string","null"]},"read":{"maxItems":10000,"type":"array","items":{"maxLength":100,"type":"string"}}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["inboxes","selected","read"],"properties":{"inboxes":{"maxItems":10000,"type":"array","items":{"type":"object","required":["id","address","domain_id"],"properties":{"id":{"format":"uuid","type":"string"},"address":{"maxLength":320,"type":"string"},"domain_id":{"maxLength":253,"type":"string"},"visibility":{"type":"string","enum":["public","private"]}}}},"selected":{"maxLength":50,"type":["string","null"]},"read":{"maxItems":10000,"type":"array","items":{"maxLength":100,"type":"string"}}}}}}},"operationId":"postAuthInboxes"}},"/auth/account":{"get":{"operationId":"getAuthAccount"}},"/auth/receiving":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["inboxIds","domains"],"properties":{"inboxIds":{"maxItems":10000,"type":"array","items":{"format":"uuid","type":"string"}},"domains":{"maxItems":100,"type":"array","items":{"maxLength":253,"type":"string"}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["inboxIds","domains"],"properties":{"inboxIds":{"maxItems":10000,"type":"array","items":{"format":"uuid","type":"string"}},"domains":{"maxItems":100,"type":"array","items":{"maxLength":253,"type":"string"}}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["inboxIds","domains"],"properties":{"inboxIds":{"maxItems":10000,"type":"array","items":{"format":"uuid","type":"string"}},"domains":{"maxItems":100,"type":"array","items":{"maxLength":253,"type":"string"}}}}}}},"operationId":"postAuthReceiving"}},"/auth/domains":{"get":{"operationId":"getAuthDomains"},"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["domain"],"properties":{"domain":{"maxLength":253,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["domain"],"properties":{"domain":{"maxLength":253,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["domain"],"properties":{"domain":{"maxLength":253,"type":"string"}}}}}},"operationId":"postAuthDomains"}},"/auth/domains/verify":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["domain"],"properties":{"domain":{"maxLength":253,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["domain"],"properties":{"domain":{"maxLength":253,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["domain"],"properties":{"domain":{"maxLength":253,"type":"string"}}}}}},"operationId":"postAuthDomainsVerify"}},"/auth/domains/remove":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["domain"],"properties":{"domain":{"maxLength":253,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["domain"],"properties":{"domain":{"maxLength":253,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["domain"],"properties":{"domain":{"maxLength":253,"type":"string"}}}}}},"operationId":"postAuthDomainsRemove"}},"/auth/webhooks":{"get":{"operationId":"getAuthWebhooks"},"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"maxLength":2048,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"maxLength":2048,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["url"],"properties":{"url":{"maxLength":2048,"type":"string"}}}}}},"operationId":"postAuthWebhooks"}},"/auth/webhooks/remove":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}}}},"operationId":"postAuthWebhooksRemove"}},"/auth/keys":{"get":{"operationId":"getAuthKeys"},"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["label"],"properties":{"label":{"minLength":1,"maxLength":100,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["label"],"properties":{"label":{"minLength":1,"maxLength":100,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["label"],"properties":{"label":{"minLength":1,"maxLength":100,"type":"string"}}}}}},"operationId":"postAuthKeys"}},"/auth/keys/revoke":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["id"],"properties":{"id":{"format":"uuid","type":"string"}}}}}},"operationId":"postAuthKeysRevoke"}},"/auth/billing":{"get":{"operationId":"getAuthBilling"}},"/auth/billing/checkout":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["planId"],"properties":{"planId":{"type":"string","enum":["anonymous","registered","pro","max"]}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["planId"],"properties":{"planId":{"type":"string","enum":["anonymous","registered","pro","max"]}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["planId"],"properties":{"planId":{"type":"string","enum":["anonymous","registered","pro","max"]}}}}}},"operationId":"postAuthBillingCheckout"}},"/auth/billing/portal":{"post":{"operationId":"postAuthBillingPortal"}},"/auth/billing/refresh":{"post":{"operationId":"postAuthBillingRefresh"}},"/webhooks/polar":{"post":{"operationId":"postWebhooksPolar"}},"/plans":{"get":{"operationId":"getPlans"}},"/health":{"get":{"operationId":"getHealth"}},"/ready":{"get":{"operationId":"getReady"}},"/v1/account":{"get":{"operationId":"getV1Account"}},"/v1/domains":{"get":{"operationId":"getV1Domains"}},"/v1/inboxes":{"post":{"summary":"Open an inbox","description":"Free and anonymous users must send an empty object for a randomly assigned public inbox. Pro and Developer may choose username and domain_id or reopen an address. Automatic paid selection prefers owned custom domains, then premium, then free. Free domains always create public inboxes.","requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","properties":{"domain_id":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"},"username":{"minLength":1,"maxLength":64,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","properties":{"domain_id":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"},"username":{"minLength":1,"maxLength":64,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","properties":{"domain_id":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"},"username":{"minLength":1,"maxLength":64,"type":"string"}}}}}},"operationId":"postV1Inboxes"}},"/v1/inboxes/resolve":{"get":{"parameters":[{"name":"address","in":"query","required":true,"schema":{"maxLength":254,"type":"string"}}],"operationId":"getV1InboxesResolve"}},"/v1/inboxes/{id}":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1InboxesById"},"delete":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"deleteV1InboxesById"}},"/v1/inboxes/{id}/messages/{messageId}":{"delete":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"deleteV1InboxesByIdMessagesByMessageId"},"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1InboxesByIdMessagesByMessageId"}},"/v1/inboxes/{id}/messages/{messageId}/star":{"patch":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["starred"],"properties":{"starred":{"type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["starred"],"properties":{"starred":{"type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["starred"],"properties":{"starred":{"type":"boolean"}}}}}},"operationId":"patchV1InboxesByIdMessagesByMessageIdStar"}},"/v1/inboxes/{id}/messages":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"minimum":1,"maximum":50,"anyOf":[{"format":"numeric","default":0,"type":"string"},{"minimum":1,"maximum":50,"type":"number"}]}},{"name":"cursor","in":"query","required":false,"schema":{"maxLength":4096,"type":"string"}}],"operationId":"getV1InboxesByIdMessages"}},"/v1/inboxes/{id}/messages/{messageId}/source":{"get":{"summary":"Download original email (.eml)","description":"Streams the original received RFC 822/MIME bytes, including headers, bodies and attachments. Uses the same inbox authorization and messages:read API-key scope as message reads. Limited to 30 downloads per minute per client, shared with attachment downloads. Normal expiration and deletion apply; returns 404 when the original is no longer retained.","responses":{"200":{"description":"Original email source as an attachment.","content":{"message/rfc822":{"schema":{"type":"string","format":"binary"}}}}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1InboxesByIdMessagesByMessageIdSource"}},"/v1/inboxes/{id}/messages/{messageId}/attachments/{attachmentId}":{"get":{"summary":"Download an attachment","description":"Returns the original file bytes, rather than a JSON envelope. Get attachment IDs and relative download_url values from the message detail endpoint. Public access requires no key; supplied API keys need messages:read. Limited to 30 downloads per minute per client.","responses":{"200":{"description":"Attachment bytes. The original UTF-8 filename is provided in Content-Disposition.","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}},"headers":{"Content-Disposition":{"description":"attachment; filename*=UTF-8 followed by the encoded original filename","schema":{"type":"string"}}}},"404":{"description":"Inbox, message, attachment, or file is unavailable or expired."},"429":{"description":"Download rate limit exceeded."},"503":{"description":"A required service is unavailable."}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"attachmentId","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1InboxesByIdMessagesByMessageIdAttachmentsByAttachmentId"}},"/v1/inboxes/{id}/otp/events":{"get":{"summary":"Stream new OTP candidates for an owned private inbox for up to 60 seconds","description":"Developer API key with messages:read scope required. Emits ready, otp.found, stream.error and complete SSE events. Only messages received after request start are eligible. Confidence is heuristic, not a probability or validation. One API request is charged per stream.","parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1InboxesByIdOtpEvents"}},"/v1/inboxes/{id}/changes":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"after","in":"query","required":false,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1InboxesByIdChanges"}},"/v1/inboxes/events":{"get":{"parameters":[{"name":"ids","in":"query","required":true,"schema":{"minLength":1,"maxLength":369999,"type":"string"}},{"name":"background","in":"query","required":false,"schema":{"const":"1","type":"string"}}],"operationId":"getV1InboxesEvents"}},"/v1/inboxes/{id}/events":{"get":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"getV1InboxesByIdEvents"}},"/v1/abuse-reports":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["category","details"],"properties":{"inbox_id":{"format":"uuid","type":"string"},"message_id":{"format":"uuid","type":"string"},"category":{"minLength":1,"maxLength":80,"type":"string"},"details":{"minLength":1,"maxLength":2000,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["category","details"],"properties":{"inbox_id":{"format":"uuid","type":"string"},"message_id":{"format":"uuid","type":"string"},"category":{"minLength":1,"maxLength":80,"type":"string"},"details":{"minLength":1,"maxLength":2000,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["category","details"],"properties":{"inbox_id":{"format":"uuid","type":"string"},"message_id":{"format":"uuid","type":"string"},"category":{"minLength":1,"maxLength":80,"type":"string"},"details":{"minLength":1,"maxLength":2000,"type":"string"}}}}}},"operationId":"postV1Abuse-reports"}},"/admin/administrators":{"get":{"operationId":"getAdminAdministrators"},"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["user_id","enabled"],"properties":{"user_id":{"minLength":1,"maxLength":254,"type":"string"},"enabled":{"type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["user_id","enabled"],"properties":{"user_id":{"minLength":1,"maxLength":254,"type":"string"},"enabled":{"type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["user_id","enabled"],"properties":{"user_id":{"minLength":1,"maxLength":254,"type":"string"},"enabled":{"type":"boolean"}}}}}},"operationId":"postAdminAdministrators"}},"/admin/jobs":{"get":{"operationId":"getAdminJobs"}},"/admin/deadletters":{"get":{"operationId":"getAdminDeadletters"}},"/admin/stats":{"get":{"operationId":"getAdminStats"}},"/admin/domains":{"get":{"operationId":"getAdminDomains"},"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["name","reason"],"properties":{"name":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"},"registration_expires_at":{"format":"date-time","type":"string"},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["name","reason"],"properties":{"name":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"},"registration_expires_at":{"format":"date-time","type":"string"},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["name","reason"],"properties":{"name":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"},"registration_expires_at":{"format":"date-time","type":"string"},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}}}},"operationId":"postAdminDomains"}},"/admin/domains/{name}/class":{"post":{"parameters":[{"name":"name","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["free","premium"]}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["free","premium"]}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["kind"],"properties":{"kind":{"type":"string","enum":["free","premium"]}}}}}},"operationId":"postAdminDomainsByNameClass"}},"/admin/domain-cycling/inventory-preview":{"get":{"operationId":"getAdminDomain-cyclingInventory-preview"}},"/admin/domain-cycling/inventory-setup":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["domains"],"properties":{"domains":{"minItems":1,"maxItems":500,"type":"array","items":{"additionalProperties":false,"type":"object","required":["name","kind"],"properties":{"name":{"maxLength":253,"type":"string"},"kind":{"type":"string","enum":["free","premium"]}}}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["domains"],"properties":{"domains":{"minItems":1,"maxItems":500,"type":"array","items":{"additionalProperties":false,"type":"object","required":["name","kind"],"properties":{"name":{"maxLength":253,"type":"string"},"kind":{"type":"string","enum":["free","premium"]}}}}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["domains"],"properties":{"domains":{"minItems":1,"maxItems":500,"type":"array","items":{"additionalProperties":false,"type":"object","required":["name","kind"],"properties":{"name":{"maxLength":253,"type":"string"},"kind":{"type":"string","enum":["free","premium"]}}}}}}}}},"operationId":"postAdminDomain-cyclingInventory-setup"}},"/admin/domain-cycling":{"get":{"operationId":"getAdminDomain-cycling"}},"/admin/domain-cycling/config":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["enabled","domains_per_week","generated_tld","max_price_usd"],"properties":{"enabled":{"type":"boolean"},"domains_per_week":{"minimum":0,"maximum":20,"type":"number"},"generated_tld":{"type":"string","enum":["com","net","org"]},"max_price_usd":{"minimum":1,"maximum":1000,"type":"number"},"categories":{"additionalProperties":false,"type":"object","required":["free","premium"],"properties":{"free":{"additionalProperties":false,"type":"object","required":["enabled","domains_per_period","period_months","max_inventory","generated_tld","max_price_usd"],"properties":{"enabled":{"type":"boolean"},"domains_per_period":{"minimum":1,"maximum":40,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":40,"type":"integer"}]},"period_months":{"minimum":1,"maximum":24,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":24,"type":"integer"}]},"generated_suffixes":{"maxLength":10000,"type":"string"},"max_inventory":{"minimum":0,"maximum":10000,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":0,"maximum":10000,"type":"integer"}]},"generated_tld":{"type":"string","enum":["com","net","org"]},"max_price_usd":{"minimum":1,"maximum":1000,"type":"number"}}},"premium":{"additionalProperties":false,"type":"object","required":["enabled","domains_per_period","period_months","max_inventory","generated_tld","max_price_usd"],"properties":{"enabled":{"type":"boolean"},"domains_per_period":{"minimum":1,"maximum":40,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":40,"type":"integer"}]},"period_months":{"minimum":1,"maximum":24,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":24,"type":"integer"}]},"generated_suffixes":{"maxLength":10000,"type":"string"},"max_inventory":{"minimum":0,"maximum":10000,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":0,"maximum":10000,"type":"integer"}]},"generated_tld":{"type":"string","enum":["com","net","org"]},"max_price_usd":{"minimum":1,"maximum":1000,"type":"number"}}}}}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["enabled","domains_per_week","generated_tld","max_price_usd"],"properties":{"enabled":{"type":"boolean"},"domains_per_week":{"minimum":0,"maximum":20,"type":"number"},"generated_tld":{"type":"string","enum":["com","net","org"]},"max_price_usd":{"minimum":1,"maximum":1000,"type":"number"},"categories":{"additionalProperties":false,"type":"object","required":["free","premium"],"properties":{"free":{"additionalProperties":false,"type":"object","required":["enabled","domains_per_period","period_months","max_inventory","generated_tld","max_price_usd"],"properties":{"enabled":{"type":"boolean"},"domains_per_period":{"minimum":1,"maximum":40,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":40,"type":"integer"}]},"period_months":{"minimum":1,"maximum":24,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":24,"type":"integer"}]},"generated_suffixes":{"maxLength":10000,"type":"string"},"max_inventory":{"minimum":0,"maximum":10000,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":0,"maximum":10000,"type":"integer"}]},"generated_tld":{"type":"string","enum":["com","net","org"]},"max_price_usd":{"minimum":1,"maximum":1000,"type":"number"}}},"premium":{"additionalProperties":false,"type":"object","required":["enabled","domains_per_period","period_months","max_inventory","generated_tld","max_price_usd"],"properties":{"enabled":{"type":"boolean"},"domains_per_period":{"minimum":1,"maximum":40,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":40,"type":"integer"}]},"period_months":{"minimum":1,"maximum":24,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":24,"type":"integer"}]},"generated_suffixes":{"maxLength":10000,"type":"string"},"max_inventory":{"minimum":0,"maximum":10000,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":0,"maximum":10000,"type":"integer"}]},"generated_tld":{"type":"string","enum":["com","net","org"]},"max_price_usd":{"minimum":1,"maximum":1000,"type":"number"}}}}}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["enabled","domains_per_week","generated_tld","max_price_usd"],"properties":{"enabled":{"type":"boolean"},"domains_per_week":{"minimum":0,"maximum":20,"type":"number"},"generated_tld":{"type":"string","enum":["com","net","org"]},"max_price_usd":{"minimum":1,"maximum":1000,"type":"number"},"categories":{"additionalProperties":false,"type":"object","required":["free","premium"],"properties":{"free":{"additionalProperties":false,"type":"object","required":["enabled","domains_per_period","period_months","max_inventory","generated_tld","max_price_usd"],"properties":{"enabled":{"type":"boolean"},"domains_per_period":{"minimum":1,"maximum":40,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":40,"type":"integer"}]},"period_months":{"minimum":1,"maximum":24,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":24,"type":"integer"}]},"generated_suffixes":{"maxLength":10000,"type":"string"},"max_inventory":{"minimum":0,"maximum":10000,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":0,"maximum":10000,"type":"integer"}]},"generated_tld":{"type":"string","enum":["com","net","org"]},"max_price_usd":{"minimum":1,"maximum":1000,"type":"number"}}},"premium":{"additionalProperties":false,"type":"object","required":["enabled","domains_per_period","period_months","max_inventory","generated_tld","max_price_usd"],"properties":{"enabled":{"type":"boolean"},"domains_per_period":{"minimum":1,"maximum":40,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":40,"type":"integer"}]},"period_months":{"minimum":1,"maximum":24,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":1,"maximum":24,"type":"integer"}]},"generated_suffixes":{"maxLength":10000,"type":"string"},"max_inventory":{"minimum":0,"maximum":10000,"anyOf":[{"format":"integer","default":0,"type":"string"},{"minimum":0,"maximum":10000,"type":"integer"}]},"generated_tld":{"type":"string","enum":["com","net","org"]},"max_price_usd":{"minimum":1,"maximum":1000,"type":"number"}}}}}}}}}},"operationId":"postAdminDomain-cyclingConfig"}},"/admin/domain-cycling/candidates":{"post":{"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["domains"],"properties":{"domains":{"minItems":1,"maxItems":100,"type":"array","items":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"}},"kind":{"type":"string","enum":["free","premium"]}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["domains"],"properties":{"domains":{"minItems":1,"maxItems":100,"type":"array","items":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"}},"kind":{"type":"string","enum":["free","premium"]}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["domains"],"properties":{"domains":{"minItems":1,"maxItems":100,"type":"array","items":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"}},"kind":{"type":"string","enum":["free","premium"]}}}}}},"operationId":"postAdminDomain-cyclingCandidates"}},"/admin/domain-cycling/candidates/{id}":{"delete":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"operationId":"deleteAdminDomain-cyclingCandidatesById"}},"/admin/domain-cycling/purchases/{id}/resolve":{"post":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["confirmed_not_purchased"],"properties":{"confirmed_not_purchased":{"const":true,"type":"boolean"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["confirmed_not_purchased"],"properties":{"confirmed_not_purchased":{"const":true,"type":"boolean"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["confirmed_not_purchased"],"properties":{"confirmed_not_purchased":{"const":true,"type":"boolean"}}}}}},"operationId":"postAdminDomain-cyclingPurchasesByIdResolve"}},"/admin/domains/{name}/status":{"post":{"parameters":[{"name":"name","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["status","reason"],"properties":{"status":{"type":"string","enum":["active","draining","for_sale","suspended","retired","expired"]},"delivery_verified":{"type":"boolean"},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["status","reason"],"properties":{"status":{"type":"string","enum":["active","draining","for_sale","suspended","retired","expired"]},"delivery_verified":{"type":"boolean"},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["status","reason"],"properties":{"status":{"type":"string","enum":["active","draining","for_sale","suspended","retired","expired"]},"delivery_verified":{"type":"boolean"},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}}}},"operationId":"postAdminDomainsByNameStatus"}},"/admin/reports":{"get":{"operationId":"getAdminReports"}},"/admin/inboxes/{id}/messages/{messageId}/delete":{"post":{"parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"uuid","type":"string"}},{"name":"messageId","in":"path","required":true,"schema":{"format":"uuid","type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["reason"],"properties":{"reason":{"minLength":1,"maxLength":500,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["reason"],"properties":{"reason":{"minLength":1,"maxLength":500,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["reason"],"properties":{"reason":{"minLength":1,"maxLength":500,"type":"string"}}}}}},"operationId":"postAdminInboxesByIdMessagesByMessageIdDelete"}},"/admin/audit":{"get":{"parameters":[{"name":"date","in":"query","required":false,"schema":{"pattern":"^\\d{4}-\\d{2}-\\d{2}$","type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"minimum":1,"maximum":100,"anyOf":[{"format":"numeric","default":0,"type":"string"},{"minimum":1,"maximum":100,"type":"number"}]}},{"name":"cursor","in":"query","required":false,"schema":{"pattern":"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-1[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$","type":"string"}}],"operationId":"getAdminAudit"}},"/admin/namesilo/import":{"post":{"operationId":"postAdminNamesiloImport"}},"/admin/domains/{name}/dns":{"get":{"parameters":[{"name":"name","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"}}],"operationId":"getAdminDomainsByNameDns"}},"/admin/domains/{name}/mx":{"post":{"parameters":[{"name":"name","in":"path","required":true,"schema":{"pattern":"^[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$","maxLength":253,"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"type":"object","required":["approved","reason"],"properties":{"approved":{"type":"boolean"},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}},"application/x-www-form-urlencoded":{"schema":{"additionalProperties":false,"type":"object","required":["approved","reason"],"properties":{"approved":{"type":"boolean"},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}},"multipart/form-data":{"schema":{"additionalProperties":false,"type":"object","required":["approved","reason"],"properties":{"approved":{"type":"boolean"},"reason":{"minLength":1,"maxLength":500,"type":"string"}}}}}},"operationId":"postAdminDomainsByNameMx"}}},"components":{"schemas":{}}}