Update a domain - Strix

PATCH

/

domains

/

{domainId}

Error

A valid request URL is required to generate request examples

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

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

domainId

string<uuid>

required

UUID of the domain. Use the id field of a domain from listDomains.

Body

application/json

At least one of context, tags, or business_unit must be provided. Tags and business_unit require the Enterprise plan.

context

string | null

New free-text background about the domain for the agent. Send null to clear it.

tags

string[]

Replaces the domain's tags. Requires the Enterprise plan.

business_unit

string | null

Sets or clears the business_unit. Requires the Enterprise plan.

Response

Domain updated.

id

string<uuid>

required

organization_id

string

required

domain

string

required

verified

boolean

required

created_at

string<date-time>

required

verification_method

enum<string> | null

How the domain was verified. trusted_access means a member with trusted access added it without ownership proof; those domains return to unverified if that member's trusted access is revoked.

Available options:

allowlist,

existing,

dns,

file,

meta_tag,

email,

trusted_access,

null

tags

string[]

Enterprise asset labels used for RBAC scoping.

business_unit

string | null

Enterprise asset label used for RBAC scoping.

last_scan_at

string<date-time> | null

last_scan_status

string | null

Status of the newest scan that targets this domain (pending, running, completed, failed, cancelled).

test_user_count

integer

The number of test users that apply to this domain. This includes users that are shared with the domain and users that apply to every domain in the organization.

Status of the newest login check across the domain's test users (pending, running, succeeded, failed). Null when no check has run.

open_issue_count

integer

The number of active findings (open, in_progress, snoozed) that are attributed to this asset. Dependency findings are not counted.

open_issues

object

The same active findings as open_issue_count, grouped by severity.

Show child attributes

Error

A valid request URL is required to generate request examples

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

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