{ "openapi": "3.1.0", "info": { "title": "Laravel API", "version": "1.0.0", "description": "API v1 for accounts, AI generation, billing, Cloud collaboration, imports, interactive services, partner marketplace, file transformations, webhooks and metrics." }, "servers": [ { "url": "https://www.apification.com/api/v1", "description": "API v1" } ], "security": [ { "ApiKeyBearer": [] } ], "tags": [ { "name": "Auth" }, { "name": "Account" }, { "name": "AI" }, { "name": "Billing" }, { "name": "Cloud" }, { "name": "Folders" }, { "name": "Interactive services" }, { "name": "Marketplace" }, { "name": "File Transformer" }, { "name": "Users" }, { "name": "Webhooks" } ], "paths": { "/auth/me": { "get": { "tags": [ "Auth" ], "operationId": "api_v1_auth_me", "summary": "Returns the authenticated user and safe API key metadata.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Authenticated user", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthMe" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } } } }, "/account": { "get": { "tags": [ "Account" ], "operationId": "api_v1_account_show", "summary": "Returns account, reseller, subscription and effective Cloud settings.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Account", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "account:read" }, "patch": { "tags": [ "Account" ], "operationId": "api_v1_account_update", "summary": "Updates the basic account details.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated account", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Account" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountUpdate" } } } }, "x-required-scope": "account:write" } }, "/account/stats": { "get": { "tags": [ "Account" ], "operationId": "api_v1_account_stats", "summary": "Returns service, storage, version and view totals.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Account statistics", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccountStats" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "account:read" } }, "/cloud/settings": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_settings_show", "summary": "Returns the Cloud settings available to the authenticated role.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cloud settings", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudSettings" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" }, "patch": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_settings_update", "summary": "Updates global Cloud settings or the subaccount baseline according to the role.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated Cloud settings", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudSettings" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudSettingsUpdate" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/catalog": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_catalog", "summary": "Returns the allowed service, extension and upload-app catalog.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cloud catalog", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudCatalog" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_index", "summary": "Returns a paginated and filterable list of Cloud services.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "types[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "preview_types[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "extensions[]", "in": "query", "schema": { "type": "array", "items": { "type": "string" } } }, { "name": "selectable_for", "in": "query", "schema": { "type": "string" } }, { "name": "public_only", "in": "query", "schema": { "type": "boolean" } }, { "name": "visibility", "in": "query", "schema": { "type": "string" } }, { "name": "parent_folder_id", "in": "query", "schema": { "type": "integer" } }, { "name": "sort", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cloud services", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CloudService" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" }, "post": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_store", "summary": "Creates an editable Cloud service.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Created Cloud service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudServiceEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudServiceCreate" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/files": { "post": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_files_upload", "summary": "Uploads a file after validating its extension, detected MIME, size and default app.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "File stored as a Cloud service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudServiceEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/CloudFileUpload" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/services/{code}": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_show", "summary": "Returns the details of a Cloud service.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cloud service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudServiceEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" }, "patch": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_update", "summary": "Updates the name, visibility, payload, folder or tags.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated Cloud service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudServiceEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudServiceUpdate" } } } }, "x-required-scope": "cloud:write" }, "delete": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_destroy", "summary": "Moves a Cloud service to the recycle bin.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Deleted Cloud service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResult" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:write" } }, "/cloud/services/{code}/content": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_content", "summary": "Downloads the original file or a result with authentication.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "disposition", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Binary file content.", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services/{code}/thumbnail": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_thumbnail", "summary": "Returns the generated thumbnail with API authentication.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Thumbnail image.", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "image/*": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services/{code}/stats": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_stats", "summary": "Returns views, referrers and recent service activity.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "days", "in": "query", "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cloud service statistics", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudServiceStats" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services/{code}/move": { "post": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_move", "summary": "Moves a Cloud service to another folder.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Moved Cloud service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudServiceEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudMove" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/folders": { "get": { "tags": [ "Folders" ], "operationId": "api_v1_cloud_folders_index", "summary": "Returns the accessible folders.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cloud folders", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/CloudFolder" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" }, "post": { "tags": [ "Folders" ], "operationId": "api_v1_cloud_folders_store", "summary": "Creates a folder.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Created folder", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudFolderEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudFolderCreate" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/folders/{id}": { "patch": { "tags": [ "Folders" ], "operationId": "api_v1_cloud_folders_update", "summary": "Renames, moves or changes the visibility of a folder.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated folder", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudFolderEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudFolderUpdate" } } } }, "x-required-scope": "cloud:write" }, "delete": { "tags": [ "Folders" ], "operationId": "api_v1_cloud_folders_destroy", "summary": "Moves a folder and its contents to the recycle bin.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Deleted folder", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResult" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:write" } }, "/file-transformer/operations": { "get": { "tags": [ "File Transformer" ], "operationId": "api_v1_file-transformer_operations_index", "summary": "Lists all 154 public operations with their formats and parameters.", "parameters": [ { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "available", "in": "query", "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Available operations", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FileTransformerOperation" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "transformations:read" } }, "/file-transformer/operations/{operation}": { "get": { "tags": [ "File Transformer" ], "operationId": "api_v1_file-transformer_operations_show", "summary": "Returns the contract for a specific operation.", "parameters": [ { "name": "operation", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Operation", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTransformerOperationEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "transformations:read" } }, "/file-transformer/estimates": { "post": { "tags": [ "File Transformer" ], "operationId": "api_v1_file-transformer_estimates_store", "summary": "Validates the input and estimates credits before execution.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Estimate", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTransformationEstimate" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTransformationRequest" } } } }, "x-required-scope": "transformations:write" } }, "/file-transformer/jobs": { "get": { "tags": [ "File Transformer" ], "operationId": "api_v1_file-transformer_jobs_index", "summary": "Returns the account’s asynchronous transformation jobs.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "name": "operation_key", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Transformation jobs", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/FileTransformationJob" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "transformations:read" }, "post": { "tags": [ "File Transformer" ], "operationId": "api_v1_file-transformer_jobs_store", "summary": "Creates and queues a transformation.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "202": { "description": "Queued transformation job", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTransformationJobEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTransformationRequest" } } } }, "x-required-scope": "transformations:write" } }, "/file-transformer/jobs/{id}": { "get": { "tags": [ "File Transformer" ], "operationId": "api_v1_file-transformer_jobs_show", "summary": "Returns the status, progress, usage and results of a job.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Transformation job", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTransformationJobEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "transformations:read" } }, "/file-transformer/jobs/{id}/cancel": { "post": { "tags": [ "File Transformer" ], "operationId": "api_v1_file-transformer_jobs_cancel", "summary": "Cancels a job that is still queued.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cancelled transformation job", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTransformationJobEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "transformations:write" } }, "/file-transformer/jobs/{id}/retry": { "post": { "tags": [ "File Transformer" ], "operationId": "api_v1_file-transformer_jobs_retry", "summary": "Creates a new attempt from a failed or cancelled job.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "202": { "description": "Queued retry job", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FileTransformationJobEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "transformations:write" } }, "/users": { "get": { "tags": [ "Users" ], "operationId": "api_v1_users_index", "summary": "Admins list users; resellers list their subaccounts.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "role", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Users", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/User" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "users:read" }, "post": { "tags": [ "Users" ], "operationId": "api_v1_users_store", "summary": "Creates a user or subaccount.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Created user", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserCreate" } } } }, "x-required-scope": "users:write" } }, "/users/{id}": { "get": { "tags": [ "Users" ], "operationId": "api_v1_users_show", "summary": "Returns the details of a manageable user.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "User", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "users:read" }, "patch": { "tags": [ "Users" ], "operationId": "api_v1_users_update", "summary": "Updates a manageable user.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated user", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserUpdate" } } } }, "x-required-scope": "users:write" } }, "/users/{id}/cloud-settings": { "patch": { "tags": [ "Users" ], "operationId": "api_v1_users_cloud-settings_update", "summary": "Customizes Cloud settings for a manageable user.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated user settings", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CloudSettingsUpdate" } } } }, "x-required-scope": "users:write" } }, "/webhooks": { "get": { "tags": [ "Webhooks" ], "operationId": "api_v1_webhooks_index", "summary": "Returns the account’s webhook endpoints.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Webhooks", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookEndpoint" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "webhooks:read" }, "post": { "tags": [ "Webhooks" ], "operationId": "api_v1_webhooks_store", "summary": "Creates a universal webhook endpoint.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Created webhook", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointCreate" } } } }, "x-required-scope": "webhooks:write" } }, "/webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "operationId": "api_v1_webhooks_show", "summary": "Returns the details of a webhook endpoint.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Webhook", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "webhooks:read" }, "patch": { "tags": [ "Webhooks" ], "operationId": "api_v1_webhooks_update", "summary": "Updates the URL, events or status, or rotates the secret.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated webhook", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEndpointUpdate" } } } }, "x-required-scope": "webhooks:write" }, "delete": { "tags": [ "Webhooks" ], "operationId": "api_v1_webhooks_destroy", "summary": "Deletes a webhook endpoint.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Deleted webhook", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteResult" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "webhooks:write" } }, "/webhooks/{id}/test": { "post": { "tags": [ "Webhooks" ], "operationId": "api_v1_webhooks_test", "summary": "Queues a test delivery to the endpoint.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "202": { "description": "Queued test delivery", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "webhooks:write" } }, "/webhooks/{id}/deliveries": { "get": { "tags": [ "Webhooks" ], "operationId": "api_v1_webhooks_deliveries", "summary": "Returns a paginated delivery history for an endpoint.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Webhook deliveries", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/WebhookDelivery" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "webhooks:read" } }, "/webhook-deliveries/{id}/retry": { "post": { "tags": [ "Webhooks" ], "operationId": "api_v1_webhook-deliveries_retry", "summary": "Manually requeues a webhook delivery.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "202": { "description": "Requeued webhook delivery", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookDeliveryEnvelope" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "webhooks:write" } }, "/ai/providers": { "get": { "tags": [ "AI" ], "operationId": "api_v1_ai_providers_index", "summary": "Lists configured AI providers and their public generation parameters.", "parameters": [ { "name": "modality", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "AI providers", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "ai:read" } }, "/ai/estimates": { "post": { "tags": [ "AI" ], "operationId": "api_v1_ai_estimates_store", "summary": "Estimates billing units, credits and projected storage before an AI generation.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "AI estimate", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "ai:read" } }, "/ai/text/generations": { "get": { "tags": [ "AI" ], "operationId": "api_v1_ai_text_generations_index", "summary": "Returns the authenticated account text-generation history.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Text generations", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "ai:read" }, "post": { "tags": [ "AI" ], "operationId": "api_v1_ai_text_generations_store", "summary": "Generates text using the same provider, quota and credit rules as the account backend.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Generated text", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "ai:write" } }, "/ai/media/generations": { "get": { "tags": [ "AI" ], "operationId": "api_v1_ai_media_generations_index", "summary": "Returns generated image, video and audio history.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Media generations", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "ai:read" }, "post": { "tags": [ "AI" ], "operationId": "api_v1_ai_media_generations_store", "summary": "Generates image, video or audio and stores the result in Cloud.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Generated media", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "ai:write" } }, "/plans": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_plans_index", "summary": "Lists active plans, limits, payment providers and the custom-plan calculator.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Plan catalog", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/plans/custom/estimates": { "post": { "tags": [ "Billing" ], "operationId": "api_v1_plans_custom_estimates_store", "summary": "Quotes storage, credits, price, estimated cost and margin for a custom plan.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Custom plan estimate", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "billing:read" } }, "/billing/usage": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_billing_usage_show", "summary": "Returns current storage and credit usage, limits and available balances.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Account usage", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/billing/credit-consumptions": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_billing_credit-consumptions_index", "summary": "Returns itemized credit consumption for the current billing period or selected dates.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "name": "source_type", "in": "query", "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Credit consumptions", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/billing/tariffs": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_billing_tariffs_index", "summary": "Lists effective general, Cloud, transformation and AI credit tariffs.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Tariff catalog", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/billing/subscription": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_billing_subscription_show", "summary": "Returns the active subscription and its effective custom limits.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Subscription", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/billing/subscriptions/plan/{plan}": { "post": { "tags": [ "Billing" ], "operationId": "api_v1_billing_subscriptions_store", "summary": "Activates a free plan or starts checkout for a paid plan.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "plan", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Subscription or checkout", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "billing:write" } }, "/billing/subscriptions/custom": { "post": { "tags": [ "Billing" ], "operationId": "api_v1_billing_subscriptions_custom_store", "summary": "Starts checkout for a custom storage and credit plan.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Custom plan checkout", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "billing:write" } }, "/billing/subscriptions/{subscription}/renew": { "post": { "tags": [ "Billing" ], "operationId": "api_v1_billing_subscriptions_renew", "summary": "Starts a renewal checkout for an active or past-due subscription.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Renewal checkout", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "billing:write" } }, "/billing/subscriptions/{subscription}": { "delete": { "tags": [ "Billing" ], "operationId": "api_v1_billing_subscriptions_destroy", "summary": "Cancels a subscription and assigns the default plan.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "subscription", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cancelled subscription", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:write" } }, "/billing/transactions": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_billing_transactions_index", "summary": "Returns charge, retry and refund transaction history.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Payment transactions", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/billing/transactions/{id}": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_billing_transactions_show", "summary": "Returns payment transaction status and provider details.", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Payment transaction", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/billing/transactions/{id}/cancel": { "post": { "tags": [ "Billing" ], "operationId": "api_v1_billing_transactions_cancel", "summary": "Cancels a pending payment transaction.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cancelled transaction", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:write" } }, "/billing/transactions/{id}/retry": { "post": { "tags": [ "Billing" ], "operationId": "api_v1_billing_transactions_retry", "summary": "Creates a new checkout attempt from a failed or cancelled payment.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Retry checkout", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "billing:write" } }, "/billing/transactions/{id}/reconcile": { "post": { "tags": [ "Billing" ], "operationId": "api_v1_billing_transactions_reconcile", "summary": "Queries the payment provider and reconciles the local transaction.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Reconciled transaction", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:write" } }, "/billing/invoices": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_billing_invoices_index", "summary": "Returns the account invoice history.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Invoices", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/billing/invoices/{invoice}": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_billing_invoices_show", "summary": "Returns a customer-owned invoice.", "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Invoice", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/billing/invoices/{invoice}/pdf": { "get": { "tags": [ "Billing" ], "operationId": "api_v1_billing_invoices_pdf", "summary": "Downloads the customer-owned invoice as a PDF.", "parameters": [ { "name": "invoice", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Invoice PDF", "content": { "application/pdf": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "billing:read" } }, "/cloud/services/{code}/versions": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_versions_index", "summary": "Lists retained versions and storage used by a Cloud service.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Cloud versions", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services/{code}/versions/{version}/download": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_versions_download", "summary": "Downloads the file snapshot for a Cloud version.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Version file", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services/{code}/versions/{version}/restore": { "post": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_versions_restore", "summary": "Restores a Cloud service from a retained version.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "version", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Restored Cloud service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:write" } }, "/cloud/services/{code}/permissions": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_permissions_show", "summary": "Returns service visibility and user/group permission assignments.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Service permissions", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" }, "put": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_services_permissions_update", "summary": "Replaces service visibility and viewer/editor/owner assignments.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated service permissions", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/folders/{folder}/permissions": { "get": { "tags": [ "Folders" ], "operationId": "api_v1_cloud_folders_permissions_show", "summary": "Returns folder visibility and inherited collaboration assignments.", "parameters": [ { "name": "folder", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Folder permissions", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" }, "put": { "tags": [ "Folders" ], "operationId": "api_v1_cloud_folders_permissions_update", "summary": "Replaces folder visibility and viewer/editor/owner assignments.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "folder", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated folder permissions", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/imports/providers": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_imports_providers_index", "summary": "Lists supported external Cloud providers and connection status.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Import providers", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/imports/connections": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_imports_connections_index", "summary": "Lists external Cloud connections without exposing tokens.", "parameters": [ { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "External Cloud connections", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/imports/{provider}/authorization": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_imports_authorization_show", "summary": "Builds the provider OAuth authorization URL for an integrator-owned callback URI.", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "redirect_uri", "in": "query", "schema": { "type": "string" } }, { "name": "state", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "OAuth authorization", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:write" } }, "/cloud/imports/{provider}/connections": { "post": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_imports_connections_store", "summary": "Exchanges an OAuth authorization code and stores the external connection securely.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "External Cloud connection", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/imports/connections/{provider}": { "delete": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_imports_connections_destroy", "summary": "Disconnects an external Cloud provider.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Disconnected provider", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:write" } }, "/cloud/imports/{provider}/browse": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_imports_browse", "summary": "Browses files and folders in a connected external provider.", "parameters": [ { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "path", "in": "query", "schema": { "type": "string" } }, { "name": "cursor", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "External files", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/imports/{provider}/jobs": { "post": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_imports_store", "summary": "Queues up to 50 external files for import.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "provider", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "202": { "description": "Queued import", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/import-jobs": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_import-jobs_index", "summary": "Lists external import jobs.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Import jobs", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/import-jobs/{job}": { "get": { "tags": [ "Cloud" ], "operationId": "api_v1_cloud_import-jobs_show", "summary": "Returns import progress, results and item errors.", "parameters": [ { "name": "job", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Import job", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services/{code}/survey/responses": { "get": { "tags": [ "Interactive services" ], "operationId": "api_v1_cloud_survey_responses_index", "summary": "Returns paginated survey responses and aggregate response metrics.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Survey analytics", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services/{code}/poll/results": { "get": { "tags": [ "Interactive services" ], "operationId": "api_v1_cloud_poll_results_show", "summary": "Returns poll totals, options, percentages and availability.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Poll analytics", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services/{code}/event/attendees": { "get": { "tags": [ "Interactive services" ], "operationId": "api_v1_cloud_event_attendees_index", "summary": "Returns event attendees, capacity and waitlist metrics.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Event analytics", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/cloud/services/{code}/event/attendees/{attendee}": { "patch": { "tags": [ "Interactive services" ], "operationId": "api_v1_cloud_event_attendees_update", "summary": "Updates an attendee status while enforcing event capacity.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "attendee", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated attendee", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "cloud:write" } }, "/cloud/services/{code}/signature/tracking": { "get": { "tags": [ "Interactive services" ], "operationId": "api_v1_cloud_signature_tracking_show", "summary": "Returns signature document, signer and evidence-event tracking.", "parameters": [ { "name": "code", "in": "path", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Signature analytics", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "cloud:read" } }, "/marketplace/services": { "get": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_services_index", "summary": "Lists published partner services and installation status.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "name": "q", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } }, { "name": "installed", "in": "query", "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Marketplace services", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "marketplace:read" } }, "/marketplace/services/{service}": { "get": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_services_show", "summary": "Returns a published partner service.", "parameters": [ { "name": "service", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Partner service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "marketplace:read" } }, "/marketplace/services/{service}/installations": { "post": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_installations_store", "summary": "Installs or reactivates a partner service.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "service", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Marketplace installation", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "marketplace:write" }, "delete": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_installations_destroy", "summary": "Deactivates a partner service installation.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "service", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Uninstalled partner service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "marketplace:write" } }, "/marketplace/installations/{installation}/launch": { "post": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_installations_launch", "summary": "Registers billable partner usage and returns a short-lived signed launch URL.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "installation", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Signed marketplace launch", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "marketplace:write" } }, "/marketplace/partner/services": { "get": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_partner_services_index", "summary": "Lists services owned by the authenticated partner.", "parameters": [ { "$ref": "#/components/parameters/Page" }, { "$ref": "#/components/parameters/PerPage" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Owned partner services", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "object": { "const": "list" }, "data": { "type": "array", "items": { "$ref": "#/components/schemas/GenericObject" } }, "meta": { "$ref": "#/components/schemas/PaginationMeta" } } } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "marketplace:read" }, "post": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_partner_services_store", "summary": "Creates a draft partner service.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "201": { "description": "Created partner service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "marketplace:write" } }, "/marketplace/partner/services/{service}": { "put": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_partner_services_update", "summary": "Updates a draft or rejected partner service.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "service", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Updated partner service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "x-required-scope": "marketplace:write" }, "delete": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_partner_services_destroy", "summary": "Deletes a draft or rejected partner service.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "service", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Deleted partner service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "marketplace:write" } }, "/marketplace/partner/services/{service}/submit": { "post": { "tags": [ "Marketplace" ], "operationId": "api_v1_marketplace_partner_services_submit", "summary": "Submits a partner service for marketplace review.", "parameters": [ { "$ref": "#/components/parameters/IdempotencyKey" }, { "name": "service", "in": "path", "required": true, "schema": { "type": "integer" } }, { "$ref": "#/components/parameters/ResellerSubaccount" } ], "responses": { "200": { "description": "Submitted partner service", "headers": { "X-RateLimit-Limit": { "$ref": "#/components/headers/RateLimitLimit" }, "X-RateLimit-Remaining": { "$ref": "#/components/headers/RateLimitRemaining" }, "Idempotency-Cache": { "$ref": "#/components/headers/IdempotencyCache" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GenericObject" } } } }, "400": { "description": "bad_request", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "bad_request": { "value": { "error": { "code": "bad_request", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "401": { "description": "authentication_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "authentication_failed": { "value": { "error": { "code": "authentication_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "403": { "description": "permission_denied", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "permission_denied": { "value": { "error": { "code": "permission_denied", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "404": { "description": "not_found", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "not_found": { "value": { "error": { "code": "not_found", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "409": { "description": "conflict", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "conflict": { "value": { "error": { "code": "conflict", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "422": { "description": "validation_failed", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "validation_failed": { "value": { "error": { "code": "validation_failed", "message": "Human readable message.", "type": "authentication_error" } } } } } } }, "429": { "description": "rate_limited", "headers": { "Retry-After": { "$ref": "#/components/headers/RetryAfter" } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "rate_limited": { "value": { "error": { "code": "rate_limited", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } }, "500": { "description": "server_error", "headers": [], "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" }, "examples": { "server_error": { "value": { "error": { "code": "server_error", "message": "Human readable message.", "type": "invalid_request_error" } } } } } } } }, "x-required-scope": "marketplace:write" } } }, "webhooks": { "cloud.service.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.service.updated": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.service.deleted": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.service.restored": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.service.published": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.service.unpublished": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.service.shared": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.service.moved": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.service.version.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.service.version.restored": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.transformation.completed": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.transformation.failed": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.folder.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.folder.updated": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.folder.deleted": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.folder.restored": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.folder.shared": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "cloud.folder.moved": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "survey.response.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "poll.vote.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "poll.results.updated": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "landing.form.submitted": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "landing.interaction.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "landing.view.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "slider.view.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "slider.interaction.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "coupon.code.assigned": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "coupon.code.redeemed": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "coupon.code.expired": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "event.attendee.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "event.attendee.updated": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "event.attendee.cancelled": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "event.attendee.checked_in": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "event.capacity.reached": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "signature.document.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "signature.document.sent": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "signature.signer.viewed": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "signature.signer.signed": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "signature.signer.declined": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "signature.document.completed": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "account.storage.warning": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "account.storage.limit_reached": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "account.credits.warning": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "account.credits.limit_reached": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "user.created": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "user.updated": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "user.deleted": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } }, "user.cloud_settings.updated": { "post": { "summary": "Webhook event delivery", "description": "Contract for events emitted by the platform. The receiver must respond with 2xx. The signature is the HMAC-SHA256 of the body calculated with the webhook secret.", "parameters": [ { "name": "X-Apification-Event", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Delivery", "in": "header", "required": true, "schema": { "type": "string" } }, { "name": "X-Apification-Signature", "in": "header", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookEvent" } } } }, "responses": { "200": { "description": "Accepted event" }, "204": { "description": "Accepted event without a response body" } } } } }, "components": { "securitySchemes": { "ApiKeyBearer": { "type": "http", "scheme": "bearer", "bearerFormat": "API key", "description": "Use a key created in Settings > API: Authorization: Bearer sk-apification-..." } }, "parameters": { "Page": { "name": "page", "in": "query", "schema": { "type": "integer", "minimum": 1, "default": 1 }, "description": "Page number for paginated lists." }, "PerPage": { "name": "per_page", "in": "query", "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 25 }, "description": "Items per page." }, "IdempotencyKey": { "name": "Idempotency-Key", "in": "header", "schema": { "type": "string", "minLength": 8, "maxLength": 120 }, "description": "Recommended key for POST, PATCH and DELETE. Retries with the same key and payload return the original response for 24 hours." }, "ResellerSubaccount": { "name": "X-Apification-Subaccount-ID", "in": "header", "required": false, "schema": { "type": "integer", "minimum": 1 }, "description": "For managed reseller API keys, executes the existing endpoint in the selected direct subaccount context. Storage and credits are checked against both the subaccount allowance and the reseller pool." } }, "headers": { "RateLimitLimit": { "schema": { "type": "integer" }, "description": "Request limit for the current window." }, "RateLimitRemaining": { "schema": { "type": "integer" }, "description": "Requests remaining in the current window." }, "RetryAfter": { "schema": { "type": "integer" }, "description": "Seconds before retrying after a 429 response." }, "IdempotencyCache": { "schema": { "type": "string", "enum": [ "HIT", "MISS" ] }, "description": "Indicates whether the response came from the idempotency cache." } }, "schemas": { "GenericObject": { "type": "object", "additionalProperties": true }, "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "type" ], "properties": { "code": { "type": "string", "enum": [ "missing_api_key", "invalid_api_key", "ip_not_allowed", "authentication_failed", "permission_denied", "insufficient_scope", "not_found", "validation_failed", "storage_limit_exceeded", "credits_exhausted", "subaccount_storage_limit_exceeded", "reseller_storage_limit_exceeded", "subaccount_credit_limit_exceeded", "reseller_credits_exhausted", "rate_limited", "idempotency_key_invalid", "idempotency_key_reuse", "conflict", "server_error" ] }, "message": { "type": "string" }, "type": { "type": "string" }, "details": { "type": "object" } } } } }, "PaginationMeta": { "type": "object", "properties": { "current_page": { "type": "integer" }, "per_page": { "type": "integer" }, "total": { "type": "integer" }, "last_page": { "type": "integer" } } }, "User": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email" }, "role": { "type": "string" }, "admin": { "type": "boolean" }, "portal_theme": { "type": [ "string", "null" ] }, "effective_portal_theme": { "type": [ "string", "null" ] }, "cloud_embed_key": { "type": [ "string", "null" ] }, "cloud_embed_url": { "type": [ "string", "null" ], "format": "uri" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } } }, "CloudService": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "integer" }, "code": { "type": "string" }, "type": { "type": "string" }, "type_label": { "type": "string" }, "name": { "type": "string" }, "url": { "type": [ "string", "null" ] }, "visibility": { "type": "string", "enum": [ "private", "shared", "public" ] }, "permission": { "type": [ "string", "null" ], "enum": [ "viewer", "editor", "owner", null ] }, "capabilities": { "$ref": "#/components/schemas/CloudPermissionCapabilities" }, "status": { "type": "string" }, "public": { "type": "boolean" }, "file": { "$ref": "#/components/schemas/CloudFile" }, "parent_folder_id": { "type": [ "integer", "null" ] }, "views": { "type": "integer" }, "payload": { "type": [ "object", "null" ] }, "public_url": { "type": [ "string", "null" ] }, "insert_value": { "type": [ "string", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } } }, "CloudFile": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": [ "string", "null" ] }, "extension": { "type": [ "string", "null" ] }, "mime_type": { "type": [ "string", "null" ] }, "size": { "type": "integer" }, "preview_type": { "type": [ "string", "null" ] }, "content_url": { "type": [ "string", "null" ], "format": "uri" }, "media_url": { "type": [ "string", "null" ], "format": "uri" }, "thumbnail_url": { "type": [ "string", "null" ], "format": "uri" } } }, "CloudFolder": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "integer" }, "owner_id": { "type": "integer" }, "name": { "type": "string" }, "visibility": { "type": "string", "enum": [ "private", "shared", "public" ] }, "permission": { "type": [ "string", "null" ], "enum": [ "viewer", "editor", "owner", null ] }, "capabilities": { "$ref": "#/components/schemas/CloudPermissionCapabilities" }, "status": { "type": "string" }, "public": { "type": "boolean" }, "parent_folder_id": { "type": [ "integer", "null" ] }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } } }, "CloudPermissionCapabilities": { "type": "object", "additionalProperties": true, "properties": { "view": { "type": "boolean" }, "edit": { "type": "boolean" }, "manage": { "type": "boolean" } } }, "AuthMe": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "auth" }, "user": { "$ref": "#/components/schemas/User" }, "api_key": { "type": "object" } } }, "Account": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "account" }, "user": { "$ref": "#/components/schemas/User" }, "reseller": { "type": [ "object", "null" ] }, "subscription": { "type": [ "object", "null" ] }, "cloud_settings": { "$ref": "#/components/schemas/CloudSettingsData" } } }, "AccountStats": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "account_stats" }, "totals": { "type": "object" }, "by_type": { "type": "array", "items": { "type": "object" } } } }, "CloudSettings": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "cloud_settings" }, "settings": { "$ref": "#/components/schemas/CloudSettingsData" } } }, "CloudSettingsData": { "type": "object", "additionalProperties": true, "properties": { "allowed_services": { "type": "array", "items": { "type": "string" } }, "allowed_extensions": { "type": "array", "items": { "type": "string" } }, "default_apps": { "type": "object" } } }, "CloudCatalog": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "cloud_catalog" }, "services": { "type": "array", "items": { "type": "object" } }, "extensions": { "type": "array", "items": { "type": "object" } }, "upload_apps": { "type": "array", "items": { "type": "object" } } } }, "FileTransformerParameter": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "password", "color", "select", "number", "checkbox" ] }, "choices": { "type": "array", "items": { "type": "object" } }, "default": [], "min": { "type": [ "number", "null" ] }, "max": { "type": [ "number", "null" ] }, "step": { "type": [ "number", "null" ] }, "required": { "type": "boolean" }, "help": { "type": [ "string", "null" ] } } }, "FileTransformerOperation": { "type": "object", "additionalProperties": true, "properties": { "key": { "type": "string" }, "category": { "type": "string" }, "category_label": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "available": { "type": "boolean" }, "input_extensions": { "type": [ "array", "null" ], "items": { "type": "string" } }, "output_formats": { "type": "array", "items": { "type": "string" } }, "min_files": { "type": "integer" }, "max_files": { "type": [ "integer", "null" ] }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/FileTransformerParameter" } } } }, "FileTransformerOperationEnvelope": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "file_transformer_operation" }, "operation": { "$ref": "#/components/schemas/FileTransformerOperation" } } }, "FileTransformationRequest": { "type": "object", "additionalProperties": true, "properties": { "operation_key": { "type": "string" }, "source_codes": { "type": "array", "minItems": 1, "maxItems": 100, "items": { "type": "string" } }, "attachment_codes": { "type": "array", "maxItems": 100, "items": { "type": "string" } }, "options": { "type": "object", "additionalProperties": true }, "parent_folder_id": { "type": [ "integer", "null" ] } } }, "FileTransformationEstimate": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "file_transformation_estimate" }, "operation_key": { "type": "string" }, "source_count": { "type": "integer" }, "estimated_credits": { "type": "integer" }, "output_formats": { "type": "array", "items": { "type": "string" } } } }, "FileTransformationResult": { "type": "object", "additionalProperties": true, "properties": { "role": { "type": [ "string", "null" ] }, "metadata": { "type": "object" }, "service": { "oneOf": [ { "$ref": "#/components/schemas/CloudService" }, { "type": "null" } ] } } }, "FileTransformationJob": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string", "format": "uuid" }, "operation_key": { "type": "string" }, "operation_label": { "type": "string" }, "status": { "type": "string", "enum": [ "queued", "processing", "completed", "failed", "cancelled" ] }, "progress": { "type": "integer", "minimum": 0, "maximum": 100 }, "estimated_credits": { "type": "integer" }, "credits_charged": { "type": "integer" }, "options": { "type": "object" }, "error": { "type": [ "string", "null" ] }, "source": { "oneOf": [ { "$ref": "#/components/schemas/CloudService" }, { "type": "null" } ] }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/FileTransformationResult" } }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "started_at": { "type": [ "string", "null" ], "format": "date-time" }, "finished_at": { "type": [ "string", "null" ], "format": "date-time" }, "links": { "type": "object" } } }, "FileTransformationJobEnvelope": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "file_transformation_job" }, "job": { "$ref": "#/components/schemas/FileTransformationJob" } } }, "CloudServiceEnvelope": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "cloud_service" }, "service": { "$ref": "#/components/schemas/CloudService" } } }, "CloudFolderEnvelope": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "cloud_folder" }, "folder": { "$ref": "#/components/schemas/CloudFolder" } } }, "UserEnvelope": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "user" }, "user": { "$ref": "#/components/schemas/User" } } }, "DeleteResult": { "type": "object", "additionalProperties": true, "properties": { "deleted": { "type": "boolean" }, "status": { "type": "string" } } }, "CloudServiceStats": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "cloud_service_stats" }, "service": { "type": "object" }, "totals": { "type": "object" }, "by_day": { "type": "array", "items": { "type": "object" } }, "latest": { "type": "array", "items": { "type": "object" } } } }, "WebhookEndpoint": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "cloud.service.created", "cloud.service.updated", "cloud.service.deleted", "cloud.service.restored", "cloud.service.published", "cloud.service.unpublished", "cloud.service.shared", "cloud.service.moved", "cloud.service.version.created", "cloud.service.version.restored", "cloud.transformation.completed", "cloud.transformation.failed", "cloud.folder.created", "cloud.folder.updated", "cloud.folder.deleted", "cloud.folder.restored", "cloud.folder.shared", "cloud.folder.moved", "survey.response.created", "poll.vote.created", "poll.results.updated", "landing.form.submitted", "landing.interaction.created", "landing.view.created", "slider.view.created", "slider.interaction.created", "coupon.code.assigned", "coupon.code.redeemed", "coupon.code.expired", "event.attendee.created", "event.attendee.updated", "event.attendee.cancelled", "event.attendee.checked_in", "event.capacity.reached", "signature.document.created", "signature.document.sent", "signature.signer.viewed", "signature.signer.signed", "signature.signer.declined", "signature.document.completed", "account.storage.warning", "account.storage.limit_reached", "account.credits.warning", "account.credits.limit_reached", "user.created", "user.updated", "user.deleted", "user.cloud_settings.updated" ] } }, "active": { "type": "boolean" }, "last_delivery_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" }, "updated_at": { "type": [ "string", "null" ], "format": "date-time" } } }, "WebhookDelivery": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "integer" }, "webhook_endpoint_id": { "type": "integer" }, "event_id": { "type": "string" }, "event_type": { "type": "string", "enum": [ "cloud.service.created", "cloud.service.updated", "cloud.service.deleted", "cloud.service.restored", "cloud.service.published", "cloud.service.unpublished", "cloud.service.shared", "cloud.service.moved", "cloud.service.version.created", "cloud.service.version.restored", "cloud.transformation.completed", "cloud.transformation.failed", "cloud.folder.created", "cloud.folder.updated", "cloud.folder.deleted", "cloud.folder.restored", "cloud.folder.shared", "cloud.folder.moved", "survey.response.created", "poll.vote.created", "poll.results.updated", "landing.form.submitted", "landing.interaction.created", "landing.view.created", "slider.view.created", "slider.interaction.created", "coupon.code.assigned", "coupon.code.redeemed", "coupon.code.expired", "event.attendee.created", "event.attendee.updated", "event.attendee.cancelled", "event.attendee.checked_in", "event.capacity.reached", "signature.document.created", "signature.document.sent", "signature.signer.viewed", "signature.signer.signed", "signature.signer.declined", "signature.document.completed", "account.storage.warning", "account.storage.limit_reached", "account.credits.warning", "account.credits.limit_reached", "user.created", "user.updated", "user.deleted", "user.cloud_settings.updated" ] }, "status": { "type": "string", "enum": [ "pending", "sent", "failed" ] }, "http_status": { "type": [ "integer", "null" ] }, "attempts": { "type": "integer" }, "error": { "type": [ "string", "null" ] }, "next_retry_at": { "type": [ "string", "null" ], "format": "date-time" }, "sent_at": { "type": [ "string", "null" ], "format": "date-time" }, "created_at": { "type": [ "string", "null" ], "format": "date-time" } } }, "WebhookEndpointEnvelope": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "webhook_endpoint" }, "webhook": { "$ref": "#/components/schemas/WebhookEndpoint" } } }, "WebhookDeliveryEnvelope": { "type": "object", "additionalProperties": true, "properties": { "object": { "const": "webhook_delivery" }, "delivery": { "$ref": "#/components/schemas/WebhookDelivery" } } }, "AccountUpdate": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email" }, "language": { "type": [ "string", "null" ] }, "portal_theme": { "type": [ "string", "null" ] } } }, "CloudSettingsUpdate": { "type": "object", "additionalProperties": true, "properties": { "allowed_services": { "type": "array", "items": { "type": "string" } }, "allowed_extensions": { "type": "array", "items": { "type": "string" } }, "default_apps": { "type": "object" } } }, "CloudServiceCreate": { "type": "object", "additionalProperties": true, "properties": { "type": { "type": "string" }, "name": { "type": [ "string", "null" ] }, "visibility": { "type": "string" }, "parent_folder_id": { "type": [ "integer", "null" ] }, "payload": { "type": "object" } } }, "CloudServiceUpdate": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "visibility": { "type": "string" }, "payload": { "type": "object" }, "parent_folder_id": { "type": [ "integer", "null" ] }, "tags": { "type": "array", "items": { "type": "string" } } } }, "CloudFileUpload": { "type": "object", "additionalProperties": true, "properties": { "file": { "type": "string", "format": "binary" }, "name": { "type": [ "string", "null" ] }, "visibility": { "type": "string" }, "parent_folder_id": { "type": [ "integer", "null" ] } } }, "CloudMove": { "type": "object", "additionalProperties": true, "properties": { "parent_folder_id": { "type": [ "integer", "null" ] } } }, "CloudFolderCreate": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "parent_folder_id": { "type": [ "integer", "null" ] }, "visibility": { "type": "string" } } }, "CloudFolderUpdate": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "parent_folder_id": { "type": [ "integer", "null" ] }, "visibility": { "type": "string" } } }, "UserCreate": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email" }, "role": { "type": "string" }, "password": { "type": "string" }, "allowed_services": { "type": "array", "items": { "type": "string" } } } }, "UserUpdate": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "username": { "type": [ "string", "null" ] }, "email": { "type": "string", "format": "email" }, "role": { "type": "string" }, "password": { "type": [ "string", "null" ] } } }, "WebhookEndpointCreate": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "cloud.service.created", "cloud.service.updated", "cloud.service.deleted", "cloud.service.restored", "cloud.service.published", "cloud.service.unpublished", "cloud.service.shared", "cloud.service.moved", "cloud.service.version.created", "cloud.service.version.restored", "cloud.transformation.completed", "cloud.transformation.failed", "cloud.folder.created", "cloud.folder.updated", "cloud.folder.deleted", "cloud.folder.restored", "cloud.folder.shared", "cloud.folder.moved", "survey.response.created", "poll.vote.created", "poll.results.updated", "landing.form.submitted", "landing.interaction.created", "landing.view.created", "slider.view.created", "slider.interaction.created", "coupon.code.assigned", "coupon.code.redeemed", "coupon.code.expired", "event.attendee.created", "event.attendee.updated", "event.attendee.cancelled", "event.attendee.checked_in", "event.capacity.reached", "signature.document.created", "signature.document.sent", "signature.signer.viewed", "signature.signer.signed", "signature.signer.declined", "signature.document.completed", "account.storage.warning", "account.storage.limit_reached", "account.credits.warning", "account.credits.limit_reached", "user.created", "user.updated", "user.deleted", "user.cloud_settings.updated" ] } }, "active": { "type": "boolean" } } }, "WebhookEndpointUpdate": { "type": "object", "additionalProperties": true, "properties": { "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "cloud.service.created", "cloud.service.updated", "cloud.service.deleted", "cloud.service.restored", "cloud.service.published", "cloud.service.unpublished", "cloud.service.shared", "cloud.service.moved", "cloud.service.version.created", "cloud.service.version.restored", "cloud.transformation.completed", "cloud.transformation.failed", "cloud.folder.created", "cloud.folder.updated", "cloud.folder.deleted", "cloud.folder.restored", "cloud.folder.shared", "cloud.folder.moved", "survey.response.created", "poll.vote.created", "poll.results.updated", "landing.form.submitted", "landing.interaction.created", "landing.view.created", "slider.view.created", "slider.interaction.created", "coupon.code.assigned", "coupon.code.redeemed", "coupon.code.expired", "event.attendee.created", "event.attendee.updated", "event.attendee.cancelled", "event.attendee.checked_in", "event.capacity.reached", "signature.document.created", "signature.document.sent", "signature.signer.viewed", "signature.signer.signed", "signature.signer.declined", "signature.document.completed", "account.storage.warning", "account.storage.limit_reached", "account.credits.warning", "account.credits.limit_reached", "user.created", "user.updated", "user.deleted", "user.cloud_settings.updated" ] } }, "active": { "type": "boolean" }, "rotate_secret": { "type": "boolean" } } }, "WebhookEvent": { "type": "object", "additionalProperties": true, "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "data": { "type": "object" } } } } } }