Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Rapid7 Policy Override API

Policy Override Resource Controller

Rapid7 Policy Override 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 Override. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 8 operations across 5 paths, and defines 15 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.

8 operations 5 paths 15 schemas 1 DELETE4 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v1
Base URL
https://us.api.insight.rapid7.com/vm/v4
Resource Areas
1

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 4 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Policy Override 8

Policy Override Resource Controller

GET
/api/3/assets/{id}/policy_overrides
Asset Policy Overrides
getAssetPolicyOverrides 1 param → 200401404500503
GET
/api/3/policy_overrides
Policy Overrides
getPolicyOverrides 3 params → 200401404500503
POST
/api/3/policy_overrides
Policy Overrides
createPolicyOverride 1 param → 200400401500503
GET
/api/3/policy_overrides/{id}
Policy Override
getPolicyOverride 1 param → 200401404500503
DELETE
/api/3/policy_overrides/{id}
Policy Override
deletePolicyOverride 1 param → 200401404500503
GET
/api/3/policy_overrides/{id}/expires
Policy Override Expiration
getPolicyOverrideExpiration 1 param → 200401404500503
PUT
/api/3/policy_overrides/{id}/expires
Policy Override Expiration
setPolicyOverrideExpiration 2 params → 200400401404500503
POST
/api/3/policy_overrides/{id}/{status}
Policy Override Status
setPolicyOverrideStatus 3 params → 200400401500503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are PolicyOverride (7 properties), PolicyOverrideScope (6 properties), PolicyOverrideSubmitter (5 properties), PolicyOverrideReviewer (5 properties). Each schema is shown below with its type and property counts.

Link
object
2 properties
BadRequestError
object
3 properties 1 required
UnauthorizedError
object
3 properties 1 required
CreatedReference«PolicyOverrideID,Link»
object
2 properties
PolicyOverrideReviewer
object
5 properties
PolicyOverrideScope
object
6 properties 3 required
Links
object
1 property
ServiceUnavailableError
object
3 properties 1 required
PolicyOverrideSubmitter
object
5 properties 1 required
PageOf«PolicyOverride»
object
3 properties
PageInfo
object
4 properties
NotFoundError
object
3 properties 1 required
Resources«PolicyOverride»
object
2 properties
PolicyOverride
object
7 properties 3 required
InternalServerError
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-policy-override-api-openapi.yml Raw ↑

Other APIs Rapid7 publishes across the network.

Rapid7 InsightVM Cloud API
Rapid7 Insight Platform API
Rapid7 InsightIDR API
Rapid7 Accounts API
Rapid7 Administration API
Rapid7 Apps API
Rapid7 Asset API
Rapid7 Asset Discovery API
Rapid7 Asset Group API
Rapid7 Assets API
Rapid7 Attachments API
Rapid7 Attack Templates API