{"data":{"base_url":"https:\/\/api.zeriq.io\/api","portal_url":"https:\/\/app.zeriq.io\/developers\/api-tokens","audience":"public_developer_portal","workspace":null,"authentication":{"scheme":"Bearer","header":"Authorization: Bearer <api_token>","token_storage":"Tokens are shown once. Store them in a customer vault or the Zeriq environment key registry."},"request_headers":[{"header":"Authorization","value":"Bearer <api_token>","required":true,"description":"Authenticates the service token."},{"header":"Accept","value":"application\/json","required":true,"description":"Requests JSON API responses."},{"header":"Idempotency-Key","value":"<uuid>","required":false,"description":"Recommended for write endpoints that create money movement or setup records."},{"header":"X-Zeriq-Environment","value":"production | staging | development | sandbox","required":false,"description":"Routes a token request to the intended runtime boundary."},{"header":"X-Zeriq-Sandbox-Key","value":"<sandbox_key>","required":false,"description":"Required when a token targets a provisioned sandbox workspace."},{"header":"X-Zeriq-Client-Cert-SHA256","value":"<sha256_fingerprint>","required":false,"description":"Required when a token enforces mTLS through a trusted edge proxy."}],"scope_catalog":[{"module":"enterprise","label":"Enterprise","scopes":[{"scope":"enterprise:admin","module":"enterprise","action":"admin","label":"Enterprise Admin","description":"High-trust service token with broad workspace API access. Creation requires explicit approval."}]},{"module":"workspace","label":"Workspace","scopes":[{"scope":"workspace:read","module":"workspace","action":"read","label":"Workspace Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"workspace:write","module":"workspace","action":"write","label":"Workspace Write","description":"Create or update records for this workspace API module."}]},{"module":"ledger","label":"Ledger","scopes":[{"scope":"ledger:read","module":"ledger","action":"read","label":"Ledger Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"ledger:write","module":"ledger","action":"write","label":"Ledger Write","description":"Create or update records for this workspace API module."}]},{"module":"events","label":"Events","scopes":[{"scope":"events:read","module":"events","action":"read","label":"Events Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"events:write","module":"events","action":"write","label":"Events Write","description":"Create or update records for this workspace API module."}]},{"module":"operations","label":"Operations","scopes":[{"scope":"operations:read","module":"operations","action":"read","label":"Operations Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"operations:write","module":"operations","action":"write","label":"Operations Write","description":"Create or update records for this workspace API module."}]},{"module":"settlements","label":"Settlements","scopes":[{"scope":"settlements:read","module":"settlements","action":"read","label":"Settlements Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"settlements:write","module":"settlements","action":"write","label":"Settlements Write","description":"Create or update records for this workspace API module."}]},{"module":"payouts","label":"Payouts","scopes":[{"scope":"payouts:read","module":"payouts","action":"read","label":"Payouts Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"payouts:write","module":"payouts","action":"write","label":"Payouts Write","description":"Create or update records for this workspace API module."}]},{"module":"cash_entries","label":"Cash Entries","scopes":[{"scope":"cash_entries:read","module":"cash_entries","action":"read","label":"Cash Entries Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"cash_entries:write","module":"cash_entries","action":"write","label":"Cash Entries Write","description":"Create or update records for this workspace API module."}]},{"module":"reconciliation","label":"Reconciliation","scopes":[{"scope":"reconciliation:read","module":"reconciliation","action":"read","label":"Reconciliation Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"reconciliation:write","module":"reconciliation","action":"write","label":"Reconciliation Write","description":"Create or update records for this workspace API module."}]},{"module":"imports","label":"Imports","scopes":[{"scope":"imports:read","module":"imports","action":"read","label":"Imports Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"imports:write","module":"imports","action":"write","label":"Imports Write","description":"Create or update records for this workspace API module."}]},{"module":"disputes","label":"Disputes","scopes":[{"scope":"disputes:read","module":"disputes","action":"read","label":"Disputes Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"disputes:write","module":"disputes","action":"write","label":"Disputes Write","description":"Create or update records for this workspace API module."}]},{"module":"control_signals","label":"Control Signals","scopes":[{"scope":"control_signals:read","module":"control_signals","action":"read","label":"Control Signals Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"control_signals:write","module":"control_signals","action":"write","label":"Control Signals Write","description":"Create or update records for this workspace API module."}]},{"module":"providers","label":"Providers","scopes":[{"scope":"providers:read","module":"providers","action":"read","label":"Providers Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"providers:write","module":"providers","action":"write","label":"Providers Write","description":"Create or update records for this workspace API module."}]},{"module":"banking","label":"Banking","scopes":[{"scope":"banking:read","module":"banking","action":"read","label":"Banking Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"banking:write","module":"banking","action":"write","label":"Banking Write","description":"Create or update records for this workspace API module."}]},{"module":"beneficiaries","label":"Beneficiaries","scopes":[{"scope":"beneficiaries:read","module":"beneficiaries","action":"read","label":"Beneficiaries Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"beneficiaries:write","module":"beneficiaries","action":"write","label":"Beneficiaries Write","description":"Create or update records for this workspace API module."}]},{"module":"locations","label":"Locations","scopes":[{"scope":"locations:read","module":"locations","action":"read","label":"Locations Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"locations:write","module":"locations","action":"write","label":"Locations Write","description":"Create or update records for this workspace API module."}]},{"module":"terminals","label":"Terminals","scopes":[{"scope":"terminals:read","module":"terminals","action":"read","label":"Terminals Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"terminals:write","module":"terminals","action":"write","label":"Terminals Write","description":"Create or update records for this workspace API module."}]},{"module":"team_members","label":"Team Members","scopes":[{"scope":"team_members:read","module":"team_members","action":"read","label":"Team Members Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"team_members:write","module":"team_members","action":"write","label":"Team Members Write","description":"Create or update records for this workspace API module."}]},{"module":"reports","label":"Reports","scopes":[{"scope":"reports:read","module":"reports","action":"read","label":"Reports Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"reports:write","module":"reports","action":"write","label":"Reports Write","description":"Create or update records for this workspace API module."}]},{"module":"audit","label":"Audit","scopes":[{"scope":"audit:read","module":"audit","action":"read","label":"Audit Read","description":"Read records and operational telemetry for this workspace API module."}]},{"module":"security","label":"Security","scopes":[{"scope":"security:read","module":"security","action":"read","label":"Security Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"security:write","module":"security","action":"write","label":"Security Write","description":"Create or update records for this workspace API module."}]},{"module":"api_tokens","label":"Api Tokens","scopes":[{"scope":"api_tokens:read","module":"api_tokens","action":"read","label":"Api Tokens Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"api_tokens:write","module":"api_tokens","action":"write","label":"Api Tokens Write","description":"Create or update records for this workspace API module."}]},{"module":"environments","label":"Environments","scopes":[{"scope":"environments:read","module":"environments","action":"read","label":"Environments Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"environments:write","module":"environments","action":"write","label":"Environments Write","description":"Create or update records for this workspace API module."}]},{"module":"sandbox","label":"Sandbox","scopes":[{"scope":"sandbox:create","module":"sandbox","action":"create","label":"Sandbox Create","description":"Create sandbox workspaces and isolated developer environments."},{"scope":"sandbox:manage","module":"sandbox","action":"manage","label":"Sandbox Manage","description":"Update, pause, archive, and inspect sandbox environments."}]},{"module":"devices","label":"Devices","scopes":[{"scope":"devices:read","module":"devices","action":"read","label":"Devices Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"devices:write","module":"devices","action":"write","label":"Devices Write","description":"Create or update records for this workspace API module."}]},{"module":"settings","label":"Settings","scopes":[{"scope":"settings:read","module":"settings","action":"read","label":"Settings Read","description":"Read records and operational telemetry for this workspace API module."},{"scope":"settings:write","module":"settings","action":"write","label":"Settings Write","description":"Create or update records for this workspace API module."}]}],"endpoint_groups":[{"module":"workspace","base_path":"\/api\/overview","read_scope":"workspace:read","write_scope":"workspace:write"},{"module":"ledger","base_path":"\/api\/ledger","read_scope":"ledger:read","write_scope":"ledger:write"},{"module":"payouts","base_path":"\/api\/payouts","read_scope":"payouts:read","write_scope":"payouts:write"},{"module":"cash_entries","base_path":"\/api\/admin\/cash-entries","read_scope":"cash_entries:read","write_scope":"cash_entries:write"},{"module":"imports","base_path":"\/api\/admin\/imports","read_scope":"imports:read","write_scope":"imports:write"},{"module":"settlements","base_path":"\/api\/settlement","read_scope":"settlements:read","write_scope":"settlements:write"},{"module":"disputes","base_path":"\/api\/disputes","read_scope":"disputes:read","write_scope":"disputes:write"},{"module":"beneficiaries","base_path":"\/api\/admin\/beneficiaries","read_scope":"beneficiaries:read","write_scope":"beneficiaries:write"},{"module":"team_members","base_path":"\/api\/admin\/team-members","read_scope":"team_members:read","write_scope":"team_members:write"},{"module":"api_tokens","base_path":"\/api\/settings\/api-tokens","read_scope":"api_tokens:read","write_scope":"api_tokens:write"}],"event_types":["api_token.created","api_token.rotated","api_token.revoked","api_token.emergency_revoked","api_token.environment_key.created","api_token.environment_key.rotated","api_token.environment_key.revoked","api_token.event_subscription.created","api_token.event_subscription.updated","api_token.event_subscription.secret_rotated","api_token.event_subscription.test_delivery","api_token.event_subscription.delivery_replayed","api_token.event_subscription.disabled","api_token.network_controls.updated","api_token.rate_limit.created","api_token.rate_limit.updated","api_token.rate_limit.paused","api_token.sandbox_environment.created","api_token.sandbox_environment.updated","api_token.sandbox_environment.probed","api_token.sandbox_environment.reset","api_token.sandbox_environment.cloned","api_token.sandbox_environment.archived","auth.api_token_ability_rejected","auth.api_token_ip_allowlist_blocked","auth.api_token_mtls_required","auth.api_token_mtls_ca_required","auth.api_token_conditional_access_blocked","auth.api_token_quota_exceeded"],"sandbox":{"data_modes":["isolated","masked","live_shadow"],"source_environments":["production","staging","development"],"required_scopes":["sandbox:create","sandbox:manage","environments:read","environments:write"],"routing":{"mode":"dedicated_workspace","header":"X-Zeriq-Sandbox-Key","query_parameter":"sandbox","isolation":"Each API-managed sandbox is backed by a separate workspace record, workspace settings, enterprise settings, and copied active memberships.","reset_behavior":"Reset provisions a new isolated sandbox workspace and pauses the previous sandbox workspace for audit retention."},"lifecycle":[{"action":"create","method":"POST","path":"\/api\/settings\/api-tokens\/sandbox-environments"},{"action":"probe","method":"POST","path":"\/api\/settings\/api-tokens\/sandbox-environments\/{id}\/probe"},{"action":"reset","method":"POST","path":"\/api\/settings\/api-tokens\/sandbox-environments\/{id}\/reset"},{"action":"clone","method":"POST","path":"\/api\/settings\/api-tokens\/sandbox-environments\/{id}\/clone"}]},"quotas":{"default_limit_per_minute":60,"default_limit_per_day":10000,"enforcement":"Quota policies are enforced per matching token, then service\/environment, then workspace default.","rate_limit_response":{"status":429,"body_keys":["message","quota"]}},"webhooks":{"delivery":"Webhook deliveries are queued and signed with HMAC SHA-256.","headers":["X-Zeriq-Delivery","X-Zeriq-Event","X-Zeriq-Timestamp","X-Zeriq-Signature"],"signature_format":"t=<unix_timestamp>,v1=<hmac_sha256(timestamp.body)>","verification_window_seconds":300,"retry_policy":{"initial_timeout_seconds":8,"next_retry_after_minutes":5,"worker_queue":"default"},"test_delivery_path":"\/api\/settings\/api-tokens\/event-subscriptions\/{id}\/test-delivery","delivery_history_path":"\/api\/settings\/api-tokens\/event-subscriptions\/{id}\/deliveries","replay_delivery_path":"\/api\/settings\/api-tokens\/event-subscriptions\/{id}\/deliveries\/{delivery_id}\/replay"},"enterprise_controls":{"ip_allowlists":{"status":"available","description":"Restrict a token to explicit IPv4 or IPv6 CIDR ranges before quota enforcement runs.","accepted_formats":["198.51.100.0\/24","203.0.113.10","2001:db8::\/48"],"failure_event":"auth.api_token_ip_allowlist_blocked"},"mtls":{"status":"available","description":"Require a trusted edge proxy to forward the verified client certificate subject or SHA-256 fingerprint.","fingerprint_header":"X-Zeriq-Client-Cert-SHA256","subject_header":"X-Zeriq-Client-Cert-Subject","issuer_fingerprint_header":"X-Zeriq-Client-Cert-Issuer-SHA256","verification_headers":["X-SSL-Client-Verify","X-Client-Cert-Verify"],"supports_multiple_certificates":true,"supports_trusted_ca_pins":true,"expiry_warning_days":30,"failure_event":"auth.api_token_mtls_required"},"conditional_access":{"status":"available","description":"Restrict tokens by route, method, environment, UTC hour window, weekday, read-only mode, and idempotency requirements.","failure_event":"auth.api_token_conditional_access_blocked"},"governance":{"status":"available","description":"Risk scores, anomaly signals, emergency revoke paths, and admin approval requirements are surfaced per token.","review_threshold":70},"approval":{"management_scope":"api_tokens:write","requires_workspace_admin":true,"requires_security_email_otp":true}},"sdk_kits":[{"language":"TypeScript","package":"@zeriq\/api","install":"npm install @zeriq\/api","entrypoint":"ZeriqClient","example":"import { ZeriqClient } from '@zeriq\/api';\n\nconst zeriq = new ZeriqClient({ apiToken: process.env.ZERIQ_API_TOKEN!, baseUrl: 'https:\/\/api.zeriq.io\/api' });\nconst analytics = await zeriq.getDeveloperAnalytics();"},{"language":"PHP","package":"zeriq\/api-sdk","install":"composer require zeriq\/api-sdk","entrypoint":"ZeriqClient.php","example":"use Zeriq\\Api\\ZeriqClient;\n\n$client = new ZeriqClient(getenv('ZERIQ_API_TOKEN'), 'https:\/\/api.zeriq.io\/api');\n$analytics = $client->getDeveloperAnalytics();"},{"language":"Python","package":"zeriq","install":"pip install zeriq","entrypoint":"ZeriqClient","example":"import os\nfrom zeriq import ZeriqClient\n\nclient = ZeriqClient(api_token=os.environ[\"ZERIQ_API_TOKEN\"], base_url=\"https:\/\/api.zeriq.io\/api\")\nanalytics = client.get_developer_analytics()"},{"language":"Postman","package":"collection","install":"Import the public docs payload and set ZERIQ_API_TOKEN as a collection variable.","entrypoint":"Zeriq Enterprise API.postman_collection.json","example":"Authorization: Bearer {{ZERIQ_API_TOKEN}}"}],"downloads":{"openapi_json":"\/api\/developer\/api-tokens\/openapi.json","postman_collection":"\/api\/developer\/api-tokens\/postman.json","env_example":"\/api\/developer\/api-tokens\/env.example","typescript_sdk":"sdks\/typescript","python_sdk":"sdks\/python","php_sdk":"sdks\/php","sdks":{"typescript":"sdks\/typescript","python":"sdks\/python","php":"sdks\/php"}},"openapi":{"version":"3.1.0","json_path":"\/api\/developer\/api-tokens\/docs?format=openapi","security_scheme":"bearerAuth","servers":[{"url":"https:\/\/api.zeriq.io\/api","description":"Zeriq API"}]},"operations":{"migrations":"php artisan migrate --force","queue_worker":"php artisan queue:work database --queue=default --tries=3 --timeout=120","health_probe":"composer run ops:api-token-worker-health"},"examples":[{"title":"List payouts","method":"GET","path":"\/api\/payouts","required_scope":"payouts:read"},{"title":"Create a sandbox environment","method":"POST","path":"\/api\/settings\/api-tokens\/sandbox-environments","required_scope":"sandbox:create"},{"title":"Send a webhook test delivery","method":"POST","path":"\/api\/settings\/api-tokens\/event-subscriptions\/{id}\/test-delivery","required_scope":"api_tokens:write"}],"error_codes":[{"status":401,"code":"unauthenticated","meaning":"Missing, revoked, or invalid bearer token."},{"status":403,"code":"scope_denied","meaning":"Token does not carry the scope required for the endpoint."},{"status":403,"code":"ip_allowlist_blocked","meaning":"Source IP is outside the token allowlist."},{"status":403,"code":"mtls_required","meaning":"mTLS is enabled and no matching client certificate was presented."},{"status":403,"code":"conditional_access_blocked","meaning":"A route, method, environment, time, or idempotency condition blocked the request."},{"status":423,"code":"workspace_restricted","meaning":"Workspace controls temporarily restrict protected operations."},{"status":429,"code":"quota_exceeded","meaning":"The token matched a quota policy that has reached its limit."}],"api_reference":[{"module":"workspace","base_path":"\/api\/overview","read_scope":"workspace:read","write_scope":"workspace:write","operations":[{"method":"GET","path":"\/api\/overview","scope":"workspace:read","description":"List workspace records for the current workspace."},{"method":"GET","path":"\/api\/overview\/{id}","scope":"workspace:read","description":"Read a single workspace record."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}},{"module":"ledger","base_path":"\/api\/ledger","read_scope":"ledger:read","write_scope":"ledger:write","operations":[{"method":"GET","path":"\/api\/ledger","scope":"ledger:read","description":"List ledger records for the current workspace."},{"method":"GET","path":"\/api\/ledger\/{id}","scope":"ledger:read","description":"Read a single ledger record."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}},{"module":"payouts","base_path":"\/api\/payouts","read_scope":"payouts:read","write_scope":"payouts:write","operations":[{"method":"GET","path":"\/api\/payouts","scope":"payouts:read","description":"List payouts records for the current workspace."},{"method":"GET","path":"\/api\/payouts\/{id}","scope":"payouts:read","description":"Read a single payouts record."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}},{"module":"cash_entries","base_path":"\/api\/admin\/cash-entries","read_scope":"cash_entries:read","write_scope":"cash_entries:write","operations":[{"method":"GET","path":"\/api\/admin\/cash-entries","scope":"cash_entries:read","description":"List cash entries records for the current workspace."},{"method":"GET","path":"\/api\/admin\/cash-entries\/{id}","scope":"cash_entries:read","description":"Read a single cash entries record."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}},{"module":"imports","base_path":"\/api\/admin\/imports","read_scope":"imports:read","write_scope":"imports:write","operations":[{"method":"GET","path":"\/api\/admin\/imports","scope":"imports:read","description":"List imports records for the current workspace."},{"method":"GET","path":"\/api\/admin\/imports\/{id}","scope":"imports:read","description":"Read a single imports record."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}},{"module":"settlements","base_path":"\/api\/settlement","read_scope":"settlements:read","write_scope":"settlements:write","operations":[{"method":"GET","path":"\/api\/settlement","scope":"settlements:read","description":"List settlements records for the current workspace."},{"method":"GET","path":"\/api\/settlement\/{id}","scope":"settlements:read","description":"Read a single settlements record."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}},{"module":"disputes","base_path":"\/api\/disputes","read_scope":"disputes:read","write_scope":"disputes:write","operations":[{"method":"GET","path":"\/api\/disputes","scope":"disputes:read","description":"List disputes records for the current workspace."},{"method":"GET","path":"\/api\/disputes\/{id}","scope":"disputes:read","description":"Read a single disputes record."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}},{"module":"beneficiaries","base_path":"\/api\/admin\/beneficiaries","read_scope":"beneficiaries:read","write_scope":"beneficiaries:write","operations":[{"method":"GET","path":"\/api\/admin\/beneficiaries","scope":"beneficiaries:read","description":"List beneficiaries records for the current workspace."},{"method":"GET","path":"\/api\/admin\/beneficiaries\/{id}","scope":"beneficiaries:read","description":"Read a single beneficiaries record."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}},{"module":"team_members","base_path":"\/api\/admin\/team-members","read_scope":"team_members:read","write_scope":"team_members:write","operations":[{"method":"GET","path":"\/api\/admin\/team-members","scope":"team_members:read","description":"List team members records for the current workspace."},{"method":"GET","path":"\/api\/admin\/team-members\/{id}","scope":"team_members:read","description":"Read a single team members record."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}},{"module":"api_tokens","base_path":"\/api\/settings\/api-tokens","read_scope":"api_tokens:read","write_scope":"api_tokens:write","operations":[{"method":"GET","path":"\/api\/settings\/api-tokens","scope":"api_tokens:read","description":"List api tokens records for the current workspace."},{"method":"GET","path":"\/api\/settings\/api-tokens\/{id}","scope":"api_tokens:read","description":"Read a single api tokens record."},{"method":"GET","path":"\/api\/settings\/api-tokens\/dashboard","scope":"api_tokens:read","description":"Read token lifecycle, quota, webhook, runtime-health, and security posture summaries."},{"method":"GET","path":"\/api\/settings\/api-tokens\/scope-templates","scope":"api_tokens:read","description":"List reusable token scope templates."},{"method":"POST","path":"\/api\/settings\/api-tokens\/scope-templates","scope":"api_tokens:write","description":"Create a reusable token scope template."},{"method":"GET","path":"\/api\/settings\/api-tokens\/rotation-policies","scope":"api_tokens:read","description":"List token rotation policies by environment."},{"method":"POST","path":"\/api\/settings\/api-tokens\/rotation-policies","scope":"api_tokens:write","description":"Create an automated token rotation policy."},{"method":"GET","path":"\/api\/settings\/api-tokens\/rotation-schedule","scope":"api_tokens:read","description":"List upcoming and completed token rotation jobs."},{"method":"POST","path":"\/api\/settings\/api-tokens\/rotation-schedule","scope":"api_tokens:write","description":"Schedule a controlled token rotation job."},{"method":"POST","path":"\/api\/settings\/api-tokens\/rotation-schedule\/{rotationJob}\/complete","scope":"api_tokens:write","description":"Mark a token rotation job complete after replacement validation."},{"method":"POST","path":"\/api\/settings\/api-tokens\/rotation-schedule\/{rotationJob}\/cancel","scope":"api_tokens:write","description":"Cancel a pending token rotation job."},{"method":"GET","path":"\/api\/settings\/api-tokens\/isolation-rules","scope":"api_tokens:read","description":"List service, route, and environment isolation rules."},{"method":"POST","path":"\/api\/settings\/api-tokens\/isolation-rules","scope":"api_tokens:write","description":"Create an API token isolation rule."},{"method":"GET","path":"\/api\/settings\/api-tokens\/environment-keys","scope":"environments:read","description":"List environment key registry entries."},{"method":"POST","path":"\/api\/settings\/api-tokens\/environment-keys","scope":"environments:write","description":"Create an environment key used by API clients."},{"method":"POST","path":"\/api\/settings\/api-tokens\/environment-keys\/{environmentKey}\/rotate","scope":"environments:write","description":"Rotate an environment key without exposing stored secrets."},{"method":"GET","path":"\/api\/settings\/api-tokens\/vault-integrations","scope":"api_tokens:read","description":"List customer vault integrations used to store API token material."},{"method":"POST","path":"\/api\/settings\/api-tokens\/vault-integrations","scope":"api_tokens:write","description":"Create a customer vault integration."},{"method":"POST","path":"\/api\/settings\/api-tokens\/vault-integrations\/{vaultIntegration}\/sync","scope":"api_tokens:write","description":"Push token metadata to the configured customer vault."},{"method":"GET","path":"\/api\/settings\/api-tokens\/sandbox-environments","scope":"environments:read","description":"List API-managed sandbox workspaces and runtime boundaries."},{"method":"POST","path":"\/api\/settings\/api-tokens\/sandbox-environments","scope":"sandbox:create","description":"Provision an isolated or masked sandbox workspace for integration testing."},{"method":"PATCH","path":"\/api\/settings\/api-tokens\/sandbox-environments\/{sandboxEnvironment}","scope":"sandbox:manage","description":"Update sandbox status, capabilities, or metadata."},{"method":"POST","path":"\/api\/settings\/api-tokens\/sandbox-environments\/{sandboxEnvironment}\/probe","scope":"sandbox:manage","description":"Verify sandbox workspace routing, isolation, and runtime health."},{"method":"POST","path":"\/api\/settings\/api-tokens\/sandbox-environments\/{sandboxEnvironment}\/reset","scope":"sandbox:manage","description":"Provision a fresh sandbox workspace while retaining the old sandbox for audit history."},{"method":"POST","path":"\/api\/settings\/api-tokens\/sandbox-environments\/{sandboxEnvironment}\/clone","scope":"sandbox:manage","description":"Clone sandbox configuration into a new runtime boundary."},{"method":"DELETE","path":"\/api\/settings\/api-tokens\/sandbox-environments\/{sandboxEnvironment}","scope":"sandbox:manage","description":"Archive a sandbox environment and stop new API routing into it."},{"method":"GET","path":"\/api\/settings\/api-tokens\/rate-limits","scope":"api_tokens:read","description":"List per-token, service, environment, and workspace quota policies."},{"method":"POST","path":"\/api\/settings\/api-tokens\/rate-limits","scope":"api_tokens:write","description":"Create a rate or volume quota policy for enterprise integrations."},{"method":"PATCH","path":"\/api\/settings\/api-tokens\/rate-limits\/{rateLimit}","scope":"api_tokens:write","description":"Update a quota policy threshold or status."},{"method":"DELETE","path":"\/api\/settings\/api-tokens\/rate-limits\/{rateLimit}","scope":"api_tokens:write","description":"Pause or archive a quota policy."},{"method":"GET","path":"\/api\/settings\/api-tokens\/event-subscriptions","scope":"api_tokens:read","description":"List API event webhook subscriptions."},{"method":"POST","path":"\/api\/settings\/api-tokens\/event-subscriptions","scope":"api_tokens:write","description":"Create a signed webhook endpoint for API-token and runtime events."},{"method":"PATCH","path":"\/api\/settings\/api-tokens\/event-subscriptions\/{eventSubscription}","scope":"api_tokens:write","description":"Update webhook endpoint, status, token binding, or subscribed event types."},{"method":"POST","path":"\/api\/settings\/api-tokens\/event-subscriptions\/{eventSubscription}\/rotate-secret","scope":"api_tokens:write","description":"Rotate the webhook signing secret and reveal the replacement once."},{"method":"POST","path":"\/api\/settings\/api-tokens\/event-subscriptions\/{eventSubscription}\/test-delivery","scope":"api_tokens:write","description":"Queue a signed test webhook delivery to the customer endpoint."},{"method":"GET","path":"\/api\/settings\/api-tokens\/event-subscriptions\/{eventSubscription}\/deliveries","scope":"api_tokens:read","description":"List webhook delivery attempts, statuses, retry windows, and response diagnostics."},{"method":"POST","path":"\/api\/settings\/api-tokens\/event-subscriptions\/{eventSubscription}\/deliveries\/{delivery}\/replay","scope":"api_tokens:write","description":"Replay a failed or historical webhook delivery."},{"method":"DELETE","path":"\/api\/settings\/api-tokens\/event-subscriptions\/{eventSubscription}","scope":"api_tokens:write","description":"Disable a webhook subscription."},{"method":"GET","path":"\/api\/settings\/api-tokens\/network-controls","scope":"api_tokens:read","description":"List per-token IP allowlists, mTLS requirements, and conditional access rules."},{"method":"PATCH","path":"\/api\/settings\/api-tokens\/{tokenId}\/network-controls","scope":"api_tokens:write","description":"Update IP allowlists, mTLS certificates, trusted CA pins, and conditional access rules."},{"method":"GET","path":"\/api\/settings\/api-tokens\/developer-docs","scope":"api_tokens:read","description":"Read the workspace-aware developer docs payload used by the dashboard."},{"method":"GET","path":"\/api\/settings\/api-tokens\/developer-analytics","scope":"api_tokens:read","description":"Read token usage, endpoint volume, latency, error, quota, and runtime health analytics."},{"method":"GET","path":"\/api\/settings\/api-tokens\/service-usage","scope":"api_tokens:read","description":"Read service-level token usage and dependency posture."},{"method":"GET","path":"\/api\/settings\/api-tokens\/emergency-console","scope":"api_tokens:read","description":"Read emergency revoke targets and high-risk token posture."},{"method":"GET","path":"\/api\/settings\/api-tokens\/security-events","scope":"api_tokens:read","description":"List API token security, network, mTLS, quota, and conditional-access events."},{"method":"GET","path":"\/api\/settings\/api-tokens\/security-events\/{eventLog}","scope":"api_tokens:read","description":"Read a single API token security event and evidence payload."},{"method":"GET","path":"\/api\/settings\/api-tokens\/approvals","scope":"api_tokens:read","description":"List pending and historical privileged token approval requests."},{"method":"POST","path":"\/api\/settings\/api-tokens\/approval-requests","scope":"api_tokens:write","description":"Request approval for broad or enterprise API-token scopes."},{"method":"POST","path":"\/api\/settings\/api-tokens\/emergency-revoke","scope":"api_tokens:write","description":"Revoke high-risk tokens by service, environment, scope, or explicit token ids."},{"method":"GET","path":"\/api\/settings\/api-tokens\/{tokenId}\/analytics","scope":"api_tokens:read","description":"Read per-token endpoint usage, latency, error rates, quota pressure, and auth failures."},{"method":"POST","path":"\/api\/settings\/api-tokens\/{tokenId}\/rotate","scope":"api_tokens:write","description":"Rotate a service token and reveal the replacement once."},{"method":"DELETE","path":"\/api\/settings\/api-tokens\/risky","scope":"api_tokens:write","description":"Bulk revoke tokens matching risk filters and protected confirmation."}],"response_shape":{"success":{"data":"object|array","meta":"object|null"},"error":{"message":"string","errors":"object|null"}}}],"generated_at":"2026-05-31T23:31:36.304428Z"}}