Skip to content

Get scope

GET
/v1/scopes/{scopeId}

Returns a single remediation scope by ID.

scopeId
required
string format: uuid

The scope ID.

The requested scope.

Scope

A remediation scope that defines what gets remediated, on which endpoints, and under what conditions.

object
id
required
ID

Unique identifier for the scope.

string format: uuid
name
required
Name

Human-readable name of the scope.

string
description
required
Description

Detailed description of the scope’s purpose.

string
nullable
status
required
Status

Current status of the scope.

string
Allowed values: active paused archived
subject_filter
required
Subject Filter

Filter criteria for what remediation subjects are in scope.

object
subject_types
Subject Types

Types of subjects to include.

Array<string>
Allowed values: software service configuration
vendors
Vendors

Vendor names to include.

Array<string>
products
Products

Product names to include.

Array<string>
cpe_patterns
CPE Patterns

CPE pattern strings for matching subjects.

Array<string>
endpoint_filter
required
Endpoint Filter

Filter criteria for which endpoints are in scope.

object
os_families
OS Families

Operating system families to include.

Array<string>
Allowed values: macos windows linux
endpoint_ids
Endpoint IDs

Specific endpoint IDs to include.

Array<string>
has_agent
Has Agent

Filter by whether the endpoint has an enrolled agent.

boolean
tags
Tags

Endpoint tags to include.

Array<string>
finding_filter
required
Finding Filter

Filter criteria for which findings trigger remediation.

object
finding_types
Finding Types

Types of findings to include.

Array<string>
Allowed values: vulnerability deprecation compliance licensing standardization
min_severity
Minimum Severity

Minimum severity level for findings to be in scope.

string
Allowed values: critical high medium low info
min_cvss_score
Minimum CVSS Score

Minimum CVSS score for findings to be in scope (0-10).

number
<= 10
kev_only
KEV Only

Only include findings in the CISA Known Exploited Vulnerabilities catalog.

boolean
created_at
required
Created At

When the scope was created.

string format: date-time
updated_at
required
Updated At

When the scope was last updated.

string format: date-time

Invalid scope ID format.

object
error
required

Human-readable error message.

string

Missing or invalid API key.

object
error
required

Human-readable error message.

string

Scope not found.

object
error
required

Human-readable error message.

string

Internal server error.

object
error
required

Human-readable error message.

string