--- openapi: 3.1.0 info: title: API v1 (Legacy) version: '2026-04-15' description: Our legacy REST API, which is in maintenance mode. Originally designed in the 2010s, requests are form encoded and responses are JSON with a simple, flat structure. Not recommended for new integrations. Receives only critical bug fixes and security patches. servers: - url: https://nz.onetimesecret.com description: Aotearoa New Zealand - url: https://ca.onetimesecret.com description: Canada - url: https://eu.onetimesecret.com description: Europe - url: https://uk.onetimesecret.com description: United Kingdom - url: https://us.onetimesecret.com description: United States - url: http://localhost:3000 description: Development paths: "/api/v1/status": get: operationId: v1_status summary: Status responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: string locale: type: string required: - status - locale '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic,anonymous security: - basicAuth: [] - {} "/api/v1/authcheck": get: operationId: v1_authcheck summary: Authcheck responses: '200': description: Successful response content: application/json: schema: type: object properties: status: type: string locale: type: string required: - status - locale '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic security: - basicAuth: [] "/api/v1/share": post: operationId: v1_share summary: Share responses: '200': description: Successful response content: application/json: schema: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '429': description: Too Many Requests - Rate limit exceeded content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic,anonymous security: - basicAuth: [] - {} requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object "/api/v1/generate": post: operationId: v1_generate summary: Generate responses: '200': description: Successful response content: application/json: schema: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '429': description: Too Many Requests - Rate limit exceeded content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic,anonymous security: - basicAuth: [] - {} requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object "/api/v1/create": post: operationId: v1_create summary: Create responses: '200': description: Successful response content: application/json: schema: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '429': description: Too Many Requests - Rate limit exceeded content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic,anonymous security: - basicAuth: [] - {} requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object "/api/v1/secret/{key}": post: operationId: v1_showSecret summary: Show Secret responses: '200': description: Successful response content: application/json: schema: type: object properties: value: type: string secret_key: type: string share_domain: type: string required: - value - secret_key - share_domain '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '429': description: Too Many Requests - Rate limit exceeded content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object "/api/v1/receipt/recent": get: operationId: v1_showReceiptRecent summary: Show Receipt Recent responses: '200': description: Successful response content: application/json: schema: type: array items: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic security: - basicAuth: [] "/api/v1/receipt/{key}/burn": post: operationId: v1_receipt_burnSecret summary: Burn Secret responses: '200': description: Successful response content: application/json: schema: type: object properties: state: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl secret_shortkey: type: string required: - state - secret_shortkey '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: continue: type: string "/api/v1/receipt/{key}": get: operationId: v1_showReceipt summary: Show Receipt responses: '200': description: Successful response content: application/json: schema: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter post: operationId: v1_showReceipt_post summary: Show Receipt responses: '200': description: Successful response content: application/json: schema: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object "/api/v1/private/recent": get: operationId: v1_private_showReceiptRecent summary: Show Receipt Recent responses: '200': description: Successful response content: application/json: schema: type: array items: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 deprecated: true x-otto-route-openapi_auth: basic security: - basicAuth: [] "/api/v1/private/{key}/burn": post: operationId: v1_private_burnSecret summary: Burn Secret responses: '200': description: Successful response content: application/json: schema: type: object properties: state: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl secret_shortkey: type: string required: - state - secret_shortkey '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 deprecated: true x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: continue: type: string "/api/v1/private/{key}": get: operationId: v1_private_showReceipt summary: Show Receipt responses: '200': description: Successful response content: application/json: schema: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 deprecated: true x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter post: operationId: v1_private_showReceipt_post summary: Show Receipt responses: '200': description: Successful response content: application/json: schema: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 deprecated: true x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object "/api/v1/metadata/recent": get: operationId: v1_metadata_showReceiptRecent summary: Show Receipt Recent responses: '200': description: Successful response content: application/json: schema: type: array items: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 deprecated: true x-otto-route-openapi_auth: basic security: - basicAuth: [] "/api/v1/metadata/{key}/burn": post: operationId: v1_metadata_burnSecret summary: Burn Secret responses: '200': description: Successful response content: application/json: schema: type: object properties: state: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl secret_shortkey: type: string required: - state - secret_shortkey '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 deprecated: true x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object properties: continue: type: string "/api/v1/metadata/{key}": get: operationId: v1_metadata_showReceipt summary: Show Receipt responses: '200': description: Successful response content: application/json: schema: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 deprecated: true x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter post: operationId: v1_metadata_showReceipt_post summary: Show Receipt responses: '200': description: Successful response content: application/json: schema: type: object properties: custid: type: string metadata_key: type: string secret_key: type: string state: type: string enum: - new - received - viewed - burned - expired - orphaned created: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' updated: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' received: type: integer minimum: -9007199254740991 maximum: 9007199254740991 ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' secret_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' metadata_url: anyOf: - type: string - type: 'null' share_domain: type: string recipient: type: array items: type: string passphrase_required: type: boolean value: type: string identifier: type: string description: v0.24 name for metadata_key. Prefer this field for new integrations. secret_identifier: type: string has_passphrase: type: boolean recipients: type: array items: type: string description: v0.24 name for recipient. receipt_ttl: anyOf: - type: integer minimum: -9007199254740991 maximum: 9007199254740991 - type: 'null' description: v0.24 name for metadata_ttl. Seconds remaining before expiry. receipt_url: description: v0.24 name for metadata_url. URL to view the receipt. anyOf: - type: string - type: 'null' secret_value: type: string required: - custid - metadata_key - state - created - updated - ttl - metadata_ttl - share_domain - recipient - identifier - recipients - receipt_ttl '400': description: Bad Request - Invalid request parameters or body content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '401': description: Unauthorized - Authentication required content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '403': description: Forbidden - Insufficient permissions content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '404': description: Not Found - Resource does not exist content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '422': description: Unprocessable Entity - Validation failed content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message '500': description: Internal Server Error - Something went wrong content: application/json: schema: type: object properties: error: type: string description: Error type identifier (e.g., "FormError") message: type: string description: Human-readable error message field: type: string description: Field that caused the error, if applicable error_id: type: string description: Unique error tracking identifier required: - message tags: - v1 deprecated: true x-otto-route-openapi_auth: basic,anonymous x-sensitive: true security: - basicAuth: [] - {} parameters: - name: key in: path required: true schema: type: string description: The key parameter requestBody: required: true content: application/x-www-form-urlencoded: schema: type: object components: securitySchemes: sessionAuth: type: apiKey in: cookie name: rack.session description: Session-based authentication via browser cookies. Some endpoints additionally require a specific role (see x-ots-required-role extension on individual operations). basicAuth: type: http scheme: basic description: HTTP Basic authentication with username (email) and API token. Some endpoints additionally require a specific role (see x-ots-required-role extension on individual operations). schemas: {} tags: - name: v1 description: V1 operations