{"openapi":"3.1.0","info":{"title":"Keyquay API","version":"1.0.0","description":"Stable error codes: license_not_found, license_expired, license_suspended, license_revoked, license_refunded, activation_limit_reached, fingerprint_invalid, not_activated, seat_unavailable, lease_expired, no_update, update_not_entitled, release_yanked, signature_invalid, event_replayed, rate_limited, limit_reached, feature_not_in_plan, tenant_suspended, unsafe_url. Errors use { error: { code, message, details } }."},"servers":[{"url":"/api/v1"}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","bearerFormat":"n3k_…"}}},"paths":{"/licenses/validate":{"post":{"summary":"Validate a licence (and refresh its offline token)","tags":["Client"],"security":[],"x-scope":"public","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"product":{"type":"string","minLength":2,"maxLength":60},"key":{"type":"string","minLength":8,"maxLength":80},"fingerprint":{"type":"object","properties":{"domain":{"type":"string","maxLength":300},"machine":{"type":"string","maxLength":200},"user":{"type":"string","maxLength":200}},"additionalProperties":false},"token":{"type":"string","maxLength":4000},"version":{"type":"string","maxLength":40}},"required":["product","key"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"valid":{"type":"boolean"},"code":{"type":"string"},"expires_at":{"type":["string","null"]},"entitlements":{"type":"array","items":{"type":"string"}},"token":{"type":"string"}},"required":["valid","code","expires_at","entitlements"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses/activate":{"post":{"summary":"Activate a machine, domain or user (takes a seat; idempotent per fingerprint)","tags":["Client"],"security":[],"x-scope":"public","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"product":{"type":"string","minLength":2,"maxLength":60},"key":{"type":"string","minLength":8,"maxLength":80},"fingerprint":{"type":"object","properties":{"domain":{"type":"string","maxLength":300},"machine":{"type":"string","maxLength":200},"user":{"type":"string","maxLength":200}},"additionalProperties":false},"version":{"type":"string","maxLength":40}},"required":["product","key","fingerprint"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"activated":{"type":"boolean"},"existing":{"type":"boolean"},"token":{"type":"string"}},"required":["activated","existing"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses/deactivate":{"post":{"summary":"Release a seat","tags":["Client"],"security":[],"x-scope":"public","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"product":{"type":"string","minLength":2,"maxLength":60},"key":{"type":"string","minLength":8,"maxLength":80},"fingerprint":{"type":"object","properties":{"domain":{"type":"string","maxLength":300},"machine":{"type":"string","maxLength":200},"user":{"type":"string","maxLength":200}},"additionalProperties":false},"version":{"type":"string","maxLength":40}},"required":["product","key","fingerprint"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"deactivated":{"type":"boolean"}},"required":["deactivated"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses/heartbeat":{"post":{"summary":"Heartbeat: touches an activation or renews a floating lease","tags":["Client"],"security":[],"x-scope":"public","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"product":{"type":"string","minLength":2,"maxLength":60},"key":{"type":"string","minLength":8,"maxLength":80},"fingerprint":{"type":"object","properties":{"domain":{"type":"string","maxLength":300},"machine":{"type":"string","maxLength":200},"user":{"type":"string","maxLength":200}},"additionalProperties":false},"token":{"type":"string","maxLength":4000},"version":{"type":"string","maxLength":40}},"required":["product","key"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses/checkout":{"post":{"summary":"Check out a floating-seat lease","tags":["Client"],"security":[],"x-scope":"public","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"product":{"type":"string","minLength":2,"maxLength":60},"key":{"type":"string","minLength":8,"maxLength":80},"fingerprint":{"type":"object","properties":{"domain":{"type":"string","maxLength":300},"machine":{"type":"string","maxLength":200},"user":{"type":"string","maxLength":200}},"additionalProperties":false},"version":{"type":"string","maxLength":40}},"required":["product","key","fingerprint"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"leased":{"type":"boolean"},"expires_at":{"type":"string"}},"required":["leased","expires_at"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses/release":{"post":{"summary":"Return a floating-seat lease","tags":["Client"],"security":[],"x-scope":"public","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"product":{"type":"string","minLength":2,"maxLength":60},"key":{"type":"string","minLength":8,"maxLength":80},"fingerprint":{"type":"object","properties":{"domain":{"type":"string","maxLength":300},"machine":{"type":"string","maxLength":200},"user":{"type":"string","maxLength":200}},"additionalProperties":false},"version":{"type":"string","maxLength":40}},"required":["product","key","fingerprint"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"released":{"type":"boolean"}},"required":["released"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/updates":{"get":{"summary":"Newest eligible release with a signed 10-minute download URL","tags":["Client"],"security":[],"x-scope":"public","parameters":[{"name":"product","in":"query","required":true,"schema":{"type":"string","minLength":2,"maxLength":60}},{"name":"key","in":"query","required":true,"schema":{"type":"string","minLength":8,"maxLength":80}},{"name":"channel","in":"query","required":false,"schema":{"type":"string","enum":["stable","beta","nightly"]}},{"name":"current","in":"query","required":false,"schema":{"type":"string","maxLength":60}},{"name":"version","in":"query","required":false,"schema":{"type":"string","maxLength":40}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"update":{"type":"boolean"}},"required":["update"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/products/{id}/keys":{"get":{"summary":"Public signing keys (JWK set) for a product slug","tags":["Client"],"security":[],"x-scope":"public","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"keys":{"type":"array","items":{"type":"object","properties":{"kty":{"type":"string"},"crv":{"type":"string"},"x":{"type":"string"},"kid":{"type":"string"}},"required":["kty","crv","x","kid"],"additionalProperties":{}}}},"required":["keys"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/download/{token}":{"get":{"summary":"Signed release download (range requests supported)","tags":["Client"],"security":[],"x-scope":"public","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/hooks/store/{id}":{"post":{"summary":"Inbound store webhook (X-Keyquay-Signature: t=..,v1=..)","tags":["Inbound"],"security":[],"x-scope":"public","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"data":{"type":"object","properties":{"order_id":{"type":"string"}},"required":["order_id"],"additionalProperties":{}}},"required":["id","type","data"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean"},"outcome":{"type":"string"}},"required":["ok","outcome"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/me":{"get":{"summary":"The workspace this key belongs to","tags":["Workspace"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"plan":{"type":"string"},"members":{"type":"number"}},"required":["id","name","plan","members"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/usage":{"get":{"summary":"Metered usage in the current billing period","tags":["Workspace"],"security":[{"bearer":[]}],"x-scope":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"plan":{"type":"string"},"rows":{"type":"array","items":{"type":"object","properties":{"metric":{"type":"string"},"used":{"type":"number"},"limit":{"type":"number"}},"required":["metric","used","limit"],"additionalProperties":false}}},"required":["plan","rows"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/products":{"get":{"summary":"List products","tags":["Products"],"security":[{"bearer":[]}],"x-scope":"products:read","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"total":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"key_prefix":{"type":"string"},"platform":{"type":"string"},"active_kid":{"type":"string"},"status":{"type":"string"}},"required":["id","name","slug","key_prefix","platform","active_kid","status"],"additionalProperties":{}}}},"required":["total","data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Create a product (generates its Ed25519 signing key)","tags":["Products"],"security":[{"bearer":[]}],"x-scope":"products:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":120},"key_prefix":{"type":"string","pattern":"^[A-Za-z0-9]{2,5}$"},"platform":{"type":"string","enum":["wordpress","php","desktop","cli","mobile","other"]},"slug":{"type":"string","maxLength":48},"homepage":{"type":"string","maxLength":300},"store_url":{"type":"string","maxLength":300}},"required":["name","key_prefix"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"key_prefix":{"type":"string"},"platform":{"type":"string"},"active_kid":{"type":"string"},"status":{"type":"string"}},"required":["id","name","slug","key_prefix","platform","active_kid","status"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/products/{id}":{"get":{"summary":"Get a product (public keys only)","tags":["Products"],"security":[{"bearer":[]}],"x-scope":"products:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"key_prefix":{"type":"string"},"platform":{"type":"string"},"active_kid":{"type":"string"},"status":{"type":"string"}},"required":["id","name","slug","key_prefix","platform","active_kid","status"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/products/{id}/rotate-key":{"post":{"summary":"Rotate the signing key (old public key stays published until its tokens expire)","tags":["Products"],"security":[{"bearer":[]}],"x-scope":"products:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"kid":{"type":"string"}},"required":["kid"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/products/{id}/sdk":{"get":{"summary":"Generated SDK snippets for the product","tags":["Products"],"security":[{"bearer":[]}],"x-scope":"products:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}},{"name":"lang","in":"query","required":false,"schema":{"type":"string"}},{"name":"base_url","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"product":{"type":"string"},"snippets":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string"}}},"required":["product","snippets"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/policies":{"get":{"summary":"List policies","tags":["Policies"],"security":[{"bearer":[]}],"x-scope":"products:read","parameters":[{"name":"product_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"total":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string"}},"required":["id","name","kind"],"additionalProperties":{}}}},"required":["total","data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Create a policy","tags":["Policies"],"security":[{"bearer":[]}],"x-scope":"products:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"product_id":{"type":"string","pattern":"^[0-9a-f]{24}$"},"name":{"type":"string","minLength":1,"maxLength":120},"kind":{"type":"string","enum":["perpetual","subscription","trial","floating"]},"duration_days":{"type":"integer","minimum":0,"maximum":36500},"max_activations":{"type":"integer","minimum":1,"maximum":100000},"activation_scope":{"type":"string","enum":["machine","domain","user"]},"fingerprint_rules":{"type":"object","properties":{"strip_www":{"type":"boolean"},"allow_subdomains":{"type":"boolean"},"dev_allowance":{"type":"integer","minimum":0,"maximum":100}},"additionalProperties":false},"offline_token_days":{"type":"integer","minimum":0,"maximum":365},"grace_days":{"type":"integer","minimum":0,"maximum":365},"require_heartbeat_hours":{"type":"integer","minimum":1,"maximum":720},"entitlements":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":60}},"updates_until_rule":{"type":"string","enum":["forever","expiry","days_after_purchase"]},"updates_days":{"type":"integer","minimum":0,"maximum":36500}},"required":["product_id","name","kind"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/policies/{id}":{"delete":{"summary":"Delete a policy (archived instead when licences use it)","tags":["Policies"],"security":[{"bearer":[]}],"x-scope":"products:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"archived":{"type":"boolean"},"deleted":{"type":"boolean"},"licenses":{"type":"number"}},"required":["archived","deleted","licenses"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses":{"get":{"summary":"List/search licences (status, product, email, last5, order id)","tags":["Licences"],"security":[{"bearer":[]}],"x-scope":"licenses:read","parameters":[{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"product_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}},{"name":"last5","in":"query","required":false,"schema":{"type":"string"}},{"name":"order_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"total":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"policy_id":{"type":"string"},"key_last5":{"type":"string"},"status":{"type":"string"},"source":{"type":"string"}},"required":["id","product_id","policy_id","key_last5","status","source"],"additionalProperties":{}}}},"required":["total","data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Issue a licence (the key is returned once)","tags":["Licences"],"security":[{"bearer":[]}],"x-scope":"licenses:write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"product_id":{"type":"string","pattern":"^[0-9a-f]{24}$"},"policy_id":{"type":"string","pattern":"^[0-9a-f]{24}$"},"customer":{"type":"object","properties":{"email":{"type":"string","format":"email","pattern":"^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"name":{"type":"string","maxLength":200}},"additionalProperties":false},"source":{"type":"string","enum":["manual","api","store_webhook","trial_signup"]},"external_order_id":{"type":"string","maxLength":200},"expires_at":{"type":"string"},"entitlements":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":60}},"notes":{"type":"string","maxLength":4000},"max_activations_override":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"send_email":{"type":"boolean"}},"required":["product_id","policy_id"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"license":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"policy_id":{"type":"string"},"key_last5":{"type":"string"},"status":{"type":"string"},"source":{"type":"string"}},"required":["id","product_id","policy_id","key_last5","status","source"],"additionalProperties":{}},"key":{"type":"string"}},"required":["license","key"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses/{id}":{"get":{"summary":"Get a licence","tags":["Licences"],"security":[{"bearer":[]}],"x-scope":"licenses:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"policy_id":{"type":"string"},"key_last5":{"type":"string"},"status":{"type":"string"},"source":{"type":"string"}},"required":["id","product_id","policy_id","key_last5","status","source"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"patch":{"summary":"Suspend, unsuspend, revoke, extend or edit notes/overrides","tags":["Licences"],"security":[{"bearer":[]}],"x-scope":"licenses:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"action":{"type":"string","enum":["suspend","unsuspend","revoke","extend","update"]},"reason":{"type":"string","maxLength":300},"days":{"type":"integer","minimum":1,"maximum":3650},"notes":{"type":"string","maxLength":4000},"max_activations_override":{"anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"entitlements":{"maxItems":50,"type":"array","items":{"type":"string","maxLength":60}}},"required":["action"],"additionalProperties":false}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"policy_id":{"type":"string"},"key_last5":{"type":"string"},"status":{"type":"string"},"source":{"type":"string"}},"required":["id","product_id","policy_id","key_last5","status","source"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses/{id}/reset-activations":{"post":{"summary":"Deactivate every activation (audited)","tags":["Licences"],"security":[{"bearer":[]}],"x-scope":"licenses:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"reset":{"type":"number"}},"required":["reset"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses/{id}/resend-key":{"post":{"summary":"Rotate the key and return the new one (old key stops working)","tags":["Licences"],"security":[{"bearer":[]}],"x-scope":"licenses:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"key":{"type":"string"},"last5":{"type":"string"}},"required":["key","last5"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/licenses/{id}/activations":{"get":{"summary":"List a licence's activations (masked labels)","tags":["Licences"],"security":[{"bearer":[]}],"x-scope":"licenses:read","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"kind":{"type":"string"},"label":{"type":"string"},"status":{"type":"string"}},"required":["id","kind","label","status"],"additionalProperties":{}}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/releases":{"get":{"summary":"List releases","tags":["Releases"],"security":[{"bearer":[]}],"x-scope":"releases:read","parameters":[{"name":"product_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"channel","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string"}},{"name":"page","in":"query","required":false,"schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"total":{"type":"number"},"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"string"},"channel":{"type":"string"},"status":{"type":"string"}},"required":["id","product_id","version","channel","status"],"additionalProperties":{}}}},"required":["total","data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Upload a release (multipart/form-data: product_id, version, channel, notes_md, min_entitlement, file=.zip)","tags":["Releases"],"security":[{"bearer":[]}],"x-scope":"releases:write","responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"string"},"channel":{"type":"string"},"status":{"type":"string"}},"required":["id","product_id","version","channel","status"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/releases/{id}/publish":{"post":{"summary":"Publish a draft release","tags":["Releases"],"security":[{"bearer":[]}],"x-scope":"releases:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"string"},"channel":{"type":"string"},"status":{"type":"string"}},"required":["id","product_id","version","channel","status"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/releases/{id}/yank":{"post":{"summary":"Withdraw a published release (downloads stop at once)","tags":["Releases"],"security":[{"bearer":[]}],"x-scope":"releases:write","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"product_id":{"type":"string"},"version":{"type":"string"},"channel":{"type":"string"},"status":{"type":"string"}},"required":["id","product_id","version","channel","status"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/reports/usage":{"get":{"summary":"Daily usage, results, versions in the field and expiring licences","tags":["Reports"],"security":[{"bearer":[]}],"x-scope":"reports:read","parameters":[{"name":"product_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"days","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{},"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/webhooks":{"get":{"summary":"List outbound webhook endpoints","tags":["Webhooks"],"security":[{"bearer":[]}],"x-scope":"webhooks","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"url":{"type":"string"},"events":{"type":"array","items":{"type":"string"}}},"required":["id","url","events"],"additionalProperties":{}}}},"required":["data"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}},"post":{"summary":"Add an outbound webhook endpoint (secret returned once)","tags":["Webhooks"],"security":[{"bearer":[]}],"x-scope":"webhooks","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"url":{"type":"string","maxLength":500,"format":"uri"},"events":{"maxItems":20,"type":"array","items":{"type":"string"}},"description":{"type":"string","maxLength":200}},"required":["url"],"additionalProperties":false}}}},"responses":{"201":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"secret":{"type":"string"}},"required":["id","secret"],"additionalProperties":{}}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}},"/webhooks/{id}":{"delete":{"summary":"Remove a webhook endpoint","tags":["Webhooks"],"security":[{"bearer":[]}],"x-scope":"webhooks","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"deleted":{"type":"boolean"}},"required":["deleted"],"additionalProperties":false}}}},"401":{"description":"Missing or invalid API key"},"402":{"description":"Plan quota exceeded"},"403":{"description":"Key lacks the required scope"},"422":{"description":"Validation failed"},"429":{"description":"Rate limited"}}}}}}