Start asset discovery

POST

asset-discovery

Error

A valid request URL is required to generate request examples

{
  "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"
  },
  "reused": true
}

{
  "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"
  },
  "reused": true
}

{
  "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.

Body

application/json

seeds

string[]

Verified domains to start from. When omitted, the run starts from every verified domain, or from the first 25 in alphabetical order when more than 25 are verified. If you supply the list, each entry must be a valid, verified domain. Strix rejects an empty or malformed list with status 422.

Required array length: 1 - 25 elements

org_names

string[]

Legal or brand names of the organization. The agent uses them to pivot through certificate subjects and WHOIS data.

Maximum array length: 10

Maximum string length: 120

instructions

string

Extra instructions for the agent, for example known hosting providers or brands to include.

Maximum string length: 2000

Response

A run was already in progress. The response returns that run.

run

object

required

Show child attributes

reused

boolean

required

True when a run was already in progress and the response returns that run.

Error

A valid request URL is required to generate request examples

{
  "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"
  },
  "reused": true
}

{
  "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"
  },
  "reused": true
}

{
  "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

Start asset discovery

Authorizations

Body

Response