> ## Documentation Index > Fetch the complete documentation index at: https://docs.app.strix.ai/llms.txt > Use this file to discover all available pages before exploring further. # Pause, resume, or stop a scan at its cost limit > Self-hosted only; the route answers 404 elsewhere. Pause and resume apply to running pentests launched with the `pause` cost policy. `resume` with `max_budget_usd` raises the limit before waking the agents, and the new limit must be greater than the actual spend. `stop` works for any active pentest: the run ends like a cancelled scan, findings and logs are kept, and no report is written. ## OpenAPI ````yaml /openapi.json post /scans/{scanId}/budget openapi: 3.1.0 info: title: Strix API version: 1.0.0 description: >- Public REST API for the Strix autonomous penetration testing platform. Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks. servers: - url: /api/v1 description: Strix v1 API security: - BearerAuth: [] tags: - name: Scans description: Launch, monitor, and manage security scans. - name: Vulnerabilities description: View and triage discovered vulnerabilities. - name: Assets description: Domains and repositories registered for scanning. - name: Schedules description: Recurring scan schedules (Pro plan). - name: Search description: Search across issues, pentests, PR reviews, chats, assets and schedules. - name: Tokens description: Manage API tokens for authentication. - name: Webhooks description: Configure webhook subscriptions for real-time event notifications. - name: Organization description: Workspace configuration for the authenticated organization. - name: Members description: Manage organization members and roles. - name: Invitations description: List and revoke organization invitations. - name: PR Reviews description: Automated security review of pull requests. - name: Connectors description: Network connectors for scanning internal/private targets. - name: Knowledge description: >- Organization knowledge base: documents, policies, and repo profiles that steer the agent. - name: Uploads description: Upload source/code/documentation archives for whitebox scans. - name: Integrations description: Third-party integrations (GitLab, Bitbucket, ticketing). - name: Chat description: Conversational agent sessions. - name: Analytics description: Aggregate dashboard analytics. - name: Test Users description: >- Per-domain test accounts (with optional MFA) the agent authenticates as during scans. - name: License description: Self-hosted license state, entitlements, and aggregate usage. - name: Supply Chain description: >- SBOM inventory, supply-chain findings, scans, and policy for connected repositories. - name: CLI description: >- Device authorization endpoints that let the Strix CLI and coding agents sign in and receive an API token. - name: Billing description: Credit balance, agent-payable top-ups, and automatic top-up settings. - name: Workspaces description: List, create, and switch workspaces. - name: Asset Discovery description: >- Passive reconnaissance runs that map the organization's external attack surface, and the discovered-asset inventory they fill. - name: Containers description: >- Container registries, tracked images, image scans, findings, and SBOM components. - name: Run Logs description: Persisted engine logs and the diagnostics bundle of a self-hosted install. paths: /scans/{scanId}/budget: post: tags: - Scans summary: Pause, resume, or stop a scan at its cost limit description: >- Self-hosted only; the route answers 404 elsewhere. Pause and resume apply to running pentests launched with the `pause` cost policy. `resume` with `max_budget_usd` raises the limit before waking the agents, and the new limit must be greater than the actual spend. `stop` works for any active pentest: the run ends like a cancelled scan, findings and logs are kept, and no report is written. operationId: applyScanBudgetAction parameters: - $ref: '#/components/parameters/ScanId' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ScanBudgetActionRequest' responses: '200': description: Action applied. content: application/json: schema: $ref: '#/components/schemas/ScanBudgetState' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '404': $ref: '#/components/responses/NotFound' '409': description: >- The scan is not in a state that accepts this action: not a pentest, not active, `stop` policy, already stopping, or the new limit is not above the actual spend. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': $ref: '#/components/responses/InternalError' '502': description: The run did not answer. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '503': description: The run has not started yet. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' security: - BearerAuth: - scans:write components: parameters: ScanId: description: UUID of the scan. Use the `id` field of a scan from `listScans`. name: scanId in: path required: true schema: type: string format: uuid schemas: ScanBudgetActionRequest: type: object required: - action properties: action: type: string enum: - pause - resume - stop description: >- `pause` parks every agent before its next model call. `resume` wakes them in place; pass `max_budget_usd` to raise the limit first. `stop` ends the run: findings and logs are kept, no report is written. max_budget_usd: type: number exclusiveMinimum: 0 maximum: 1000000 description: >- New cost limit (USD), `resume` only. Must be greater than what the scan has already spent. ScanBudgetState: type: object description: Cost-limit state of the run as reported by the engine. properties: success: type: boolean policy: type: string enum: - stop - pause max_budget_usd: type: - number - 'null' spent_usd: type: number description: >- Actual LLM spend so far. Calls in flight when the limit was reached finish and are counted, so this can exceed `max_budget_usd`. over_limit_usd: type: number paused: type: boolean pause_reason: type: - string - 'null' enum: - budget_limit - operator - null paused_at: type: - string - 'null' format: date-time agents_active: type: integer agents_parked: type: integer stop_requested: type: boolean ErrorResponse: type: object properties: detail: type: string description: Human-readable explanation of the error. code: type: string description: >- Stable machine-readable error code. `insufficient_scope` means the token does not hold the scope that this endpoint requires. required_scope: $ref: '#/components/schemas/ApiV1Scope' description: >- Scope that the caller must add to the token. Returned with the `insufficient_scope` code. docs: type: string format: uri description: Documentation page that explains how to resolve the error. hint: type: string description: >- One instruction that resolves the error. For `insufficient_scope`, a CLI session gets the `strix cloud session scopes set full` or `strix cloud login --scope-profile full` command, and an API token gets the settings page where the user creates a token with the scope. When the owner's role cannot hold the scope, the hint asks for a role change instead. required: - detail ApiV1Scope: type: string enum: - scans:read - scans:write - vulnerabilities:read - vulnerabilities:write - dependencies:read - schedules:read - schedules:write - assets:read - assets:write - organizations:read - organizations:write - members:read - members:write - invitations:read - invitations:write - webhooks:read - webhooks:write - tokens:write - audit:read - pr_reviews:read - pr_reviews:write - connectors:read - connectors:write - knowledge:read - knowledge:write - uploads:write - integrations:read - integrations:write - chat:read - chat:write - scans:message - analytics:read - llm:read - llm:write - test_users:read - test_users:write - discovery:read - discovery:write - license:read - supply_chain:read - supply_chain:write - billing:read - billing:write - containers:read - containers:write - logs:read responses: BadRequest: description: Bad request. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' Unauthorized: description: Missing or invalid API token. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' NotFound: description: Resource not found. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' InternalError: description: Internal server error. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' securitySchemes: BearerAuth: type: http scheme: bearer description: >- API token obtained from the Tokens endpoint or CLI device login. Include as `Authorization: Bearer `. Requests made with a managed CLI session also include `X-Strix-Workspace: ` to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.