Policy Override

Policy Overrides

Changed on Aug 6, 2026

Submit a policy override. The policy override can be submitted or it can be submitted and approved in a single request.

post/api/3/policy_overrides

Request

Base URL
https://<host>:<port>
Auth
none declared
TypeScript
https://skmtc.dev/rapid7/apis/rapid7-vm-api/docs/api/3/policy_overrides/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

expiresstring date-time

The date the policy override is set to expire. Date is represented in ISO 8601 format.

idobject

The identifier of the policy override.

state'under-review' | 'approved' | 'rejected' | 'deleted' | 'expired' required

The state of the policy override. Can be one of the following values:

Value	Description	Affects Compliance Results
"deleted"	The policy override has been deleted.
"expired"	The policy override had an expiration date and it has expired.
"approved"	The policy override was submitted and approved.	✓
"rejected"	The policy override was rejected by the reviewer.
"under-review"	The policy override was submitted but not yet approved or rejected by the reviewer.

Example request

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ],
  "review": {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  },
  "scope": {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  },
  "submit": {
    "links": [
      {
        "href": "https://hostname:3780/api/3/...",
        "rel": "self"
      }
    ]
  }
}

Response

idobject

The identifier of the policy override.

Example response

{
  "links": [
    {
      "href": "https://hostname:3780/api/3/...",
      "rel": "self"
    }
  ]
}

Changes

Aug 6, 20263a8197c22d71 Revision changes
- breaking
  added required request body
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status
- info
  added the media type application/json;charset=UTF-8 for the response with the status

Operation history