Asset Discovery

List asset discovery runs

Returns the most recent asset discovery runs for the authenticated organization, the run that is in progress, and the verified domains a new run can start from. Asset Discovery is available on the Enterprise plan. For other plans, every /asset-discovery route returns 403 with the feature_not_available code and the required tier enterprise. When Strix cannot verify the plan, every /asset-discovery route returns 503 with the entitlement_unverified code. Retry the request after the Retry-After interval.

GET

asset-discovery

Error

A valid request URL is required to generate request examples

{
  "runs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "<string>",
      "seeds": [
        "<string>"
      ],
      "org_names": [
        "<string>"
      ],
      "status": "pending",
      "asset_count": 123,
      "new_asset_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "instructions": "<string>",
      "summary": "<string>",
      "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "failure_code": "launch_failed",
      "detail": "<string>",
      "created_by": "<string>",
      "queued_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z"
    }
  ],
  "live_run": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "<string>",
    "seeds": [
      "<string>"
    ],
    "org_names": [
      "<string>"
    ],
    "status": "pending",
    "asset_count": 123,
    "new_asset_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "instructions": "<string>",
    "summary": "<string>",
    "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "failure_code": "launch_failed",
    "detail": "<string>",
    "created_by": "<string>",
    "queued_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z"
  },
  "seed_domains": [
    "<string>"
  ],
  "schedule": {
    "cron": "<string>",
    "timezone": "<string>",
    "notify_events": [
      "new_assets"
    ],
    "notify_slack": true,
    "slack_channel_id": "<string>",
    "notify_emails": [
      "jsmith@example.com"
    ],
    "next_run_at": "2023-11-07T05:31:56Z",
    "last_fired_at": "2023-11-07T05:31:56Z",
    "last_run_status": "ok",
    "last_run_code": "<string>",
    "last_run_error": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "can_schedule": true
}

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

{
  "detail": "<string>",
  "requiredTier": "<string>",
  "code": "<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.

Query Parameters

limit

integer

default:20

Maximum number of runs to return. The default is 20 and the maximum is 100.

Required range: 1 <= x <= 100

Response

Recent runs and the seed domains.

runs

object[]

required

Show child attributes

live_run

object | null

required

The run that is pending or running. Null when no run is in progress.

Show child attributes

seed_domains

string[]

required

The verified domains a new run can start from.

schedule

object

required

The organization's recurring discovery settings and notification settings. Each scheduled run starts from every verified domain and costs the same credits as a run started by hand. The notification settings also apply to runs started by hand.

Show child attributes

can_schedule

boolean

required

True when the plan includes recurring discovery runs.

Error

A valid request URL is required to generate request examples

{
  "runs": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "organization_id": "<string>",
      "seeds": [
        "<string>"
      ],
      "org_names": [
        "<string>"
      ],
      "status": "pending",
      "asset_count": 123,
      "new_asset_count": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "instructions": "<string>",
      "summary": "<string>",
      "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "failure_code": "launch_failed",
      "detail": "<string>",
      "created_by": "<string>",
      "queued_at": "2023-11-07T05:31:56Z",
      "started_at": "2023-11-07T05:31:56Z",
      "finished_at": "2023-11-07T05:31:56Z"
    }
  ],
  "live_run": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "<string>",
    "seeds": [
      "<string>"
    ],
    "org_names": [
      "<string>"
    ],
    "status": "pending",
    "asset_count": 123,
    "new_asset_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "instructions": "<string>",
    "summary": "<string>",
    "schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "failure_code": "launch_failed",
    "detail": "<string>",
    "created_by": "<string>",
    "queued_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "finished_at": "2023-11-07T05:31:56Z"
  },
  "seed_domains": [
    "<string>"
  ],
  "schedule": {
    "cron": "<string>",
    "timezone": "<string>",
    "notify_events": [
      "new_assets"
    ],
    "notify_slack": true,
    "slack_channel_id": "<string>",
    "notify_emails": [
      "jsmith@example.com"
    ],
    "next_run_at": "2023-11-07T05:31:56Z",
    "last_fired_at": "2023-11-07T05:31:56Z",
    "last_run_status": "ok",
    "last_run_code": "<string>",
    "last_run_error": "<string>",
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "can_schedule": true
}

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

{
  "detail": "<string>",
  "requiredTier": "<string>",
  "code": "<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>"
}

Scans

Audit

Vulnerabilities

Assets

Schedules

Tokens

Webhooks

Organization

Members

Invitations

Analytics

LLM

Connectors

Chat

PR Reviews

Knowledge

Integrations

Uploads

Test Users

License

Supply Chain

CLI

Billing

Workspaces

Asset Discovery

Run Logs

List asset discovery runs

Authorizations

Query Parameters

Response