> ## 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. # Preview the ticket for a vulnerability > Returns the destination, issue type, assignee, pentest group, and rendered title and description that `POST /vulnerabilities/{vulnerabilityId}/push` would create for the vulnerability. Nothing is created in the provider. ## OpenAPI ````yaml /openapi.json get /vulnerabilities/{vulnerabilityId}/preview 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: /vulnerabilities/{vulnerabilityId}/preview: get: tags: - Vulnerabilities summary: Preview the ticket for a vulnerability description: >- Returns the destination, issue type, assignee, pentest group, and rendered title and description that `POST /vulnerabilities/{vulnerabilityId}/push` would create for the vulnerability. Nothing is created in the provider. operationId: previewVulnerabilityTicket parameters: - $ref: '#/components/parameters/VulnerabilityId' - name: provider in: query required: true description: Ticketing integration provider. schema: type: string enum: - linear - jira - name: collection_id in: query required: false description: >- Preview with this explicit destination instead of the resolved route. schema: type: string responses: '200': description: The ticket the push would create. content: application/json: schema: $ref: '#/components/schemas/TicketPreview' '400': $ref: '#/components/responses/BadRequest' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '500': $ref: '#/components/responses/InternalError' '502': $ref: '#/components/responses/BadGateway' security: - BearerAuth: - integrations:read components: parameters: VulnerabilityId: description: >- ID of the vulnerability. Use the `id` field of a finding from `listVulnerabilities`. name: vulnerabilityId in: path required: true schema: type: string schemas: TicketPreview: type: object description: The ticket a push would create. Nothing is created. required: - mode - existing_ticket - destination - ticket_type - assignee - pentest_group - ticket properties: mode: type: string enum: - create - update description: >- `create` when the push opens a new ticket. `update` when the finding already has a ticket: the push patches only its description and status, so `destination`, `ticket_type`, `assignee`, `pentest_group` and `ticket.title` are `null`. existing_ticket: type: - object - 'null' description: The linked ticket when `mode` is `update`. required: - ticket_url - remote_ticket_id properties: ticket_url: type: - string - 'null' format: uri remote_ticket_id: type: - string - 'null' destination: type: - object - 'null' description: >- Where a `create` push files the ticket. `null` when `mode` is `update`: the linked ticket stays where it is. required: - collection_id - collection_name - via - route_label properties: collection_id: type: string description: Linear team or project ID, or Jira project ID. collection_name: type: - string - 'null' via: type: string enum: - explicit - repository - source - default description: >- How the destination was chosen. Mirrors the routing order: explicit destination on the request, repository route, source route, account default. route_label: type: - string - 'null' description: Settings label of the route that matched, when one did. ticket_type: type: - string - 'null' description: Jira issue type. `null` for Linear. assignee: type: - object - 'null' required: - id - name properties: id: type: string name: type: - string - 'null' pentest_group: type: - object - 'null' description: >- The Linear project or Jira Epic for the finding's pentest when `group_by_pentest` is on. `pending` means the push will create it. required: - remote_id - remote_name - remote_url - status properties: remote_id: type: - string - 'null' remote_name: type: - string - 'null' remote_url: type: - string - 'null' format: uri status: type: string enum: - existing - pending ticket: type: object required: - title - description - labels - priority - due_date - jira_priority properties: title: type: - string - 'null' description: >- `null` when `mode` is `update`: the push leaves the linked ticket's title alone. description: type: string labels: type: array items: type: string priority: type: - string - 'null' due_date: type: - string - 'null' format: date description: >- Due date a `create` push would set, from a snooze date or `due_date_days`. `null` for updates, which never change the due date. jira_priority: type: - string - 'null' description: >- The Jira priority name the severity maps to under `jira_priority_map`. `null` for Linear and updates. 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' Forbidden: description: >- Insufficient permissions or missing scope. A missing scope returns the `insufficient_scope` code, the `required_scope` field, and a `hint` with the command or page that grants the scope, so a client can request the correct scope and retry. 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' BadGateway: description: Bad gateway. 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.