Preview the ticket for a vulnerability

GET

vulnerabilities

{vulnerabilityId}

preview

Error

A valid request URL is required to generate request examples

{
  "mode": "create",
  "existing_ticket": {
    "ticket_url": "<string>",
    "remote_ticket_id": "<string>"
  },
  "destination": {
    "collection_id": "<string>",
    "collection_name": "<string>",
    "via": "explicit",
    "route_label": "<string>"
  },
  "ticket_type": "<string>",
  "assignee": {
    "id": "<string>",
    "name": "<string>"
  },
  "pentest_group": {
    "remote_id": "<string>",
    "remote_name": "<string>",
    "remote_url": "<string>",
    "status": "existing"
  },
  "ticket": {
    "title": "<string>",
    "description": "<string>",
    "labels": [
      "<string>"
    ],
    "priority": "<string>",
    "due_date": "2023-12-25",
    "jira_priority": "<string>"
  }
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Path Parameters

vulnerabilityId

string

required

ID of the vulnerability. Use the id field of a finding from listVulnerabilities.

Query Parameters

provider

enum<string>

required

Ticketing integration provider.

Available options:

linear,

jira

collection_id

string

Preview with this explicit destination instead of the resolved route.

Response

The ticket the push would create.

The ticket a push would create. Nothing is created.

mode

enum<string>

required

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.

Available options:

create,

update

existing_ticket

object | null

required

The linked ticket when mode is update.

Show child attributes

destination

object | null

required

Where a create push files the ticket. null when mode is update: the linked ticket stays where it is.

Show child attributes

ticket_type

string | null

required

Jira issue type. null for Linear.

assignee

object | null

required

Show child attributes

pentest_group

object | null

required

The Linear project or Jira Epic for the finding's pentest when group_by_pentest is on. pending means the push will create it.

Show child attributes

ticket

object

required

Show child attributes

Error

A valid request URL is required to generate request examples

{
  "mode": "create",
  "existing_ticket": {
    "ticket_url": "<string>",
    "remote_ticket_id": "<string>"
  },
  "destination": {
    "collection_id": "<string>",
    "collection_name": "<string>",
    "via": "explicit",
    "route_label": "<string>"
  },
  "ticket_type": "<string>",
  "assignee": {
    "id": "<string>",
    "name": "<string>"
  },
  "pentest_group": {
    "remote_id": "<string>",
    "remote_name": "<string>",
    "remote_url": "<string>",
    "status": "existing"
  },
  "ticket": {
    "title": "<string>",
    "description": "<string>",
    "labels": [
      "<string>"
    ],
    "priority": "<string>",
    "due_date": "2023-12-25",
    "jira_priority": "<string>"
  }
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

{
  "detail": "<string>",
  "code": "<string>",
  "required_scope": "scans:read",
  "docs": "<string>",
  "hint": "<string>"
}

Analytics

Asset Discovery

Audit

Billing

Chat

CLI

Connectors

Containers

Assets

Test Users

Integrations

Knowledge

License

LLM

Run Logs

Organization

Invitations

Members

PR Reviews

Vulnerabilities

Supply Chain

Scans

Schedules

Search

Tokens

Uploads

Webhooks

Workspaces

Repositories

Preview the ticket for a vulnerability

Authorizations

Path Parameters

Query Parameters

Response