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",
    "tags": [
      "<string>"
    ],
    "business_unit": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "open_issue_count": 123,
    "open_issues": {
      "total": 123,
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123
    }
  },
  "status": "added",
  "reachable": true,
  "verification": {
    "dns": {
      "record_name": "<string>",
      "record_value": "<string>"
    },
    "file": {
      "url": "<string>",
      "file_content": "<string>"
    },
    "meta_tag": {
      "tag": "<string>"
    },
    "hash": "<string>"
  }
}

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

domain

object

required

Show child attributes

status

enum<string>

required

Available options:

added,

exists

reachable

boolean

required

verification

object

required

Show child attributes

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",
    "tags": [
      "<string>"
    ],
    "business_unit": "<string>",
    "last_scan_at": "2023-11-07T05:31:56Z",
    "open_issue_count": 123,
    "open_issues": {
      "total": 123,
      "critical": 123,
      "high": 123,
      "medium": 123,
      "low": 123
    }
  },
  "status": "added",
  "reachable": true,
  "verification": {
    "dns": {
      "record_name": "<string>",
      "record_value": "<string>"
    },
    "file": {
      "url": "<string>",
      "file_content": "<string>"
    },
    "meta_tag": {
      "tag": "<string>"
    },
    "hash": "<string>"
  }
}

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

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

Add a domain

Authorizations

Body

Response