Add a domain

POST

domains

Error

A valid request URL is required to generate request examples

{
  "domain": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "<string>",
    "domain": "<string>",
    "verified": true,
    "created_at": "2023-11-07T05:31:56Z",
    "verification_method": "allowlist",
    "tags": [
      "<string>"
    ],
    "business_unit": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "last_scan_status": "<string>",
    "test_user_count": 123,
    "login_check_status": "<string>",
    "open_issue_count": 123,
    "open_issues": {
      "total": 123,
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123
    }
  },
  "status": "added",
  "reachable": true,
  "verified": true,
  "detail": "<string>",
  "verification": {
    "dns": {
      "record_name": "<string>",
      "record_value": "<string>"
    },
    "file": {
      "url": "<string>",
      "file_content": "<string>"
    },
    "meta_tag": {
      "tag": "<string>"
    },
    "hash": "<string>"
  },
  "verification_method": "allowlist",
  "next_steps": [
    "<string>"
  ]
}

{
  "domain": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "<string>",
    "domain": "<string>",
    "verified": true,
    "created_at": "2023-11-07T05:31:56Z",
    "verification_method": "allowlist",
    "tags": [
      "<string>"
    ],
    "business_unit": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "last_scan_status": "<string>",
    "test_user_count": 123,
    "login_check_status": "<string>",
    "open_issue_count": 123,
    "open_issues": {
      "total": 123,
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123
    }
  },
  "status": "added",
  "reachable": true,
  "verified": true,
  "detail": "<string>",
  "verification": {
    "dns": {
      "record_name": "<string>",
      "record_value": "<string>"
    },
    "file": {
      "url": "<string>",
      "file_content": "<string>"
    },
    "meta_tag": {
      "tag": "<string>"
    },
    "hash": "<string>"
  },
  "verification_method": "allowlist",
  "next_steps": [
    "<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.

Body

application/json

domain

string

required

Hostname to add, for example app.example.com. Do not include a scheme or path.

asset_type

enum<string>

required

Kind of asset the domain is. Use web_app for browser applications, api for HTTP APIs, and attack_surface for external discovery.

Available options:

web_app,

api,

attack_surface

context

string | null

Free-text background about the domain that the agent uses on every scan. Send null to clear it.

Response

Domain already exists.

The stored domain plus its ownership state. Read verified before you start a scan. Strix rejects a scan against a domain that is not verified, unless the organization is on the Enterprise plan or has a configured verification bypass.

domain

object

required

Show child attributes

status

enum<string>

required

added when this call created the domain. exists when the organization already had it.

Available options:

added,

exists

reachable

boolean

required

True when an HTTPS HEAD request to the domain got a response within 5 seconds. Informational only.

verified

boolean

required

True only when Strix confirmed ownership of the domain.

detail

string

required

Human-readable ownership state. When the domain is not verified, this names the DNS TXT record to add and the retry command.

verification

object

required

Show child attributes

verification_method

enum<string>

The method that verified the domain during this call. trusted_access means the caller has trusted access and no ownership proof was required. Present only when this call verified the domain.

Available options:

allowlist,

existing,

dns,

file,

meta_tag,

email,

trusted_access

next_steps

string[]

One instruction per verification method, the retry command, and a reachability note when the HTTPS probe failed. Present only when verified is false.

Error

A valid request URL is required to generate request examples

{
  "domain": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "<string>",
    "domain": "<string>",
    "verified": true,
    "created_at": "2023-11-07T05:31:56Z",
    "verification_method": "allowlist",
    "tags": [
      "<string>"
    ],
    "business_unit": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "last_scan_status": "<string>",
    "test_user_count": 123,
    "login_check_status": "<string>",
    "open_issue_count": 123,
    "open_issues": {
      "total": 123,
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123
    }
  },
  "status": "added",
  "reachable": true,
  "verified": true,
  "detail": "<string>",
  "verification": {
    "dns": {
      "record_name": "<string>",
      "record_value": "<string>"
    },
    "file": {
      "url": "<string>",
      "file_content": "<string>"
    },
    "meta_tag": {
      "tag": "<string>"
    },
    "hash": "<string>"
  },
  "verification_method": "allowlist",
  "next_steps": [
    "<string>"
  ]
}

{
  "domain": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organization_id": "<string>",
    "domain": "<string>",
    "verified": true,
    "created_at": "2023-11-07T05:31:56Z",
    "verification_method": "allowlist",
    "tags": [
      "<string>"
    ],
    "business_unit": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "last_scan_status": "<string>",
    "test_user_count": 123,
    "login_check_status": "<string>",
    "open_issue_count": 123,
    "open_issues": {
      "total": 123,
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123
    }
  },
  "status": "added",
  "reachable": true,
  "verified": true,
  "detail": "<string>",
  "verification": {
    "dns": {
      "record_name": "<string>",
      "record_value": "<string>"
    },
    "file": {
      "url": "<string>",
      "file_content": "<string>"
    },
    "meta_tag": {
      "tag": "<string>"
    },
    "hash": "<string>"
  },
  "verification_method": "allowlist",
  "next_steps": [
    "<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

Add a domain

Authorizations

Body

Response