Rapid7 Policy API

Resources and operations for managing policies.

Documentation Provider Profile APIs.io OpenAPI GitHub

Rapid7 Policy API is one of 50 APIs that Rapid7 publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Policy. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 26 operations across 26 paths, and defines 30 schemas. It is described by OpenAPI 3.1.0, at version v1.

Requests are made against a single base URL, https://[region].api.insight.rapid7.com/ias/v1.

26 operations 26 paths 30 schemas 26 GET

Metadata

The identity and technical contract details declared by the specification.

Specification

OpenAPI 3.1.0

API Version

Base URL

https://us.api.insight.rapid7.com/vm/v4

Resource Areas

Paths & Operations 26

Across 26 paths, the API surfaces 26 operations — 26 GET. Each is listed below with its method, path, parameters, and response codes.

Policy 26

Resources and operations for managing policies.

GET

/api/3/assets/{assetId}/policies

Policies For Asset

getPoliciesForAsset 5 params → 200401404500503

GET

/api/3/assets/{assetId}/policies/{policyId}/children

Policy Rules or Groups Directly Under Policy For Asset

getAssetPolicyChildren 2 params → 200401404500503

GET

/api/3/assets/{assetId}/policies/{policyId}/groups/{groupId}/children

Policy Rules or Groups Directly Under Policy Group For Asset

getAssetPolicyGroupChildren 3 params → 200401404500503

GET

/api/3/assets/{assetId}/policies/{policyId}/groups/{groupId}/rules

Policy Rules Under Policy Group For Asset

getPolicyGroupRulesWithAssetAssessment 6 params → 200401404500503

GET

/api/3/assets/{assetId}/policies/{policyId}/rules

Policy Rules For Asset

getAssetPolicyRulesSummary 5 params → 200401404500503

GET

/api/3/policies

Policies

getPolicies 5 params → 200401404500503

GET

/api/3/policies/{id}/children

Policy Rules or Groups Directly Under Policy

getPolicyChildren 1 param → 200401404500503

GET

/api/3/policies/{policyId}

Policy

getPolicy 1 param → 200401404500503

GET

/api/3/policies/{policyId}/assets

Policy Asset Results

getPolicyAssetResults 5 params → 200401404500503

GET

/api/3/policies/{policyId}/assets/{assetId}

Policy Asset Result

getPolicyAssetResult 2 params → 200401404500503

GET

/api/3/policies/{policyId}/groups

Policy Groups

getPolicyGroups 4 params → 200401404500503

GET

/api/3/policies/{policyId}/groups/{groupId}

Policy Group

getPolicyGroup 2 params → 200401404500503

GET

/api/3/policies/{policyId}/groups/{groupId}/assets

Assets Compliance For Policy Rules Under Policy Group

getPolicyGroupAssetResults 6 params → 200401404500503

GET

/api/3/policies/{policyId}/groups/{groupId}/assets/{assetId}

Asset Compliance For Policy Rules Under Policy Group

getPolicyGroupAssetResult 3 params → 200401404500503

GET

/api/3/policies/{policyId}/groups/{groupId}/children

Policy Rules or Groups Directly Under Policy Group

getPolicyGroupChildren 2 params → 200401404500503

GET

/api/3/policies/{policyId}/groups/{groupId}/rules

Policy Rules Under Policy Group

getDescendantPolicyRules 5 params → 200401404500503

GET

/api/3/policies/{policyId}/rules

Policy Rules

getPolicyRules 4 params → 200401404500503

GET

/api/3/policies/{policyId}/rules/disabled

Disabled Policy Rules

getDisabledPolicyRules 4 params → 200401404500503

GET

/api/3/policies/{policyId}/rules/{ruleId}

Policy Rule

getPolicyRule 2 params → 200401404500503

GET

/api/3/policies/{policyId}/rules/{ruleId}/assets

Assets Compliance For Policy Rule

getPolicyRuleAssetResults 6 params → 200401404500503

GET

/api/3/policies/{policyId}/rules/{ruleId}/assets/{assetId}

Asset Compliance For Policy Rule

getPolicyRuleAssetResult 3 params → 200401404500503

GET

/api/3/policies/{policyId}/rules/{ruleId}/assets/{assetId}/proof

Policy Rule Proof For Asset

getPolicyRuleAssetResultProof 3 params → 200401404500503

GET

/api/3/policies/{policyId}/rules/{ruleId}/controls

Policy Rule Controls

getPolicyRuleControls 5 params → 200401404500503

GET

/api/3/policies/{policyId}/rules/{ruleId}/rationale

Policy Rule Rationale

getPolicyRuleRationale 2 params → 200401404500503

GET

/api/3/policies/{policyId}/rules/{ruleId}/remediation

Policy Rule Remediation

getPolicyRuleRemediation 2 params → 200401404500503

GET

/api/3/policy/summary

Policy Compliance Summaries

getPolicySummary → 200401404500503

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are AssetPolicy (21 properties), OperatingSystemCpe (13 properties), AssetPolicyItem (13 properties), PolicyItem (13 properties). Each schema is shown below with its type and property counts.

Configuration

object

2 properties 1 required

PageOf«PolicyControl»

object

3 properties

OperatingSystem

object

11 properties

NotFoundError

object

3 properties 1 required

InternalServerError

object

3 properties 1 required

PolicySummaryResource

object

6 properties

PolicyRule

object

12 properties

PageOf«PolicyItem»

object

3 properties

PageOf«Policy»

object

3 properties

AssetPolicy

object

21 properties

PageOf«AssetPolicyItem»

object

3 properties

UnauthorizedError

object

3 properties 1 required

PolicyRuleAssessmentResource

object

6 properties

PolicyAsset

object

6 properties

PolicyGroup

object

11 properties

ServiceUnavailableError

object

3 properties 1 required

PageOf«PolicyRule»

object

3 properties

PageOf«AssetPolicy»

object

3 properties

PageOf«PolicyAsset»

object

3 properties

PageOf«PolicyGroup»

object

3 properties

AssetPolicyItem

object

13 properties

Policy

object

4 properties

PolicyItem

object

13 properties

PageInfo

object

4 properties

AssetPolicyAssessment

object

5 properties

PolicyMetadataResource

object

4 properties

OperatingSystemCpe

object

13 properties 1 required

PolicyControl

object

6 properties

Link

object

2 properties

PolicyBenchmark

object

4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

Other APIs Rapid7 publishes across the network.

Rapid7 InsightVM Cloud API

AE Profile APIs.io

Rapid7 Insight Platform API

AE Profile APIs.io

Rapid7 InsightIDR API

AE Profile APIs.io

Rapid7 Accounts API

AE Profile APIs.io

Rapid7 Administration API

AE Profile APIs.io

Rapid7 Apps API

AE Profile APIs.io

Rapid7 Asset API

AE Profile APIs.io

Rapid7 Asset Discovery API

AE Profile APIs.io

Rapid7 Asset Group API

AE Profile APIs.io

Rapid7 Assets API

AE Profile APIs.io

Rapid7 Attachments API

AE Profile APIs.io

Rapid7 Attack Templates API

AE Profile APIs.io

#Policy

← Back to R APIs

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Rapid7 Policy API

Metadata

Paths & Operations 26

Schemas 30

Specification

Source

API Details

Provider

Explore more

Discovery

Learnings

Guidance

Toolbox

Alignment

API Evangelist LLC

Rapid7 Policy API

Metadata

Paths & Operations 26

Schemas 30

Specification

Source

More from Rapid7 12

API Details

Provider

Explore more