# Rapid7 Blackouts API

**Canonical:** https://apis.io/apis/rapid7/rapid7-blackouts-api/  
**Provider:** Rapid7 — https://apis.io/providers/rapid7/  
**Base URL:** https://us.api.insight.rapid7.com/vm/v4  
**Documentation:** https://help.rapid7.com/insightvm/en-us/api/api.html

Rapid7 Blackouts API is one of 50 APIs that [Rapid7](https://apis.io/providers/rapid7/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Blackouts. The published artifact set on APIs.io includes an OpenAPI specification.

A blackout is a period of time when all scanning activities for the specified scope are blocked. A blackout can be scoped globally or to a specific App, this is implied by the <code>scope</code> property; scope value of <code>APP</code> requires that an appropriate <code>app.id</code> value is also provided. There are two options available to specify how often a blackout will occur, <b>either a frequency or a recurrence rule (rrule).</b> Only frequency supports the use of ONCE only blackouts. If providing a rrule, the following fields are permitted:<ul><li><code>FREQ</code> where FREQ is one of: <code>HOURLY, DAILY, WEEKLY, MONTHLY</code> </li><li><code>INTERVAL</code></li><li><code>BYDAY</code> where value is: a single day, <code>SA,SU</code> to represent weekend, or all weekdays. </li><li><code>BYMONTHDAY</code> where value is a range between: <code>1 - 31.</code> </li><li><code>BYSETPOS</code> where value is one of: <code>-1, 1, 2, 3, 4</code></li><li><code>COUNT</code></li></ul>If providing a rrule, the <a href="https://datatracker.ietf.org/doc/html/rfc2445#section-4.8.5.4">RFC 2445 section-4.8.5.4 IETF specification</a> can be used as a guide for how to create rrules. Example: <ul><li><code>rrule = "FREQ=MONTHLY;INTERVAL=1;BYDAY=FR;BYSETPOS=-1"</code> represents 'Run every month on the last Friday'.</li></ul>If providing a frequency, the frequency of a blackout is defined by both the type and interval; specifying a type of <code>ONCE</code> does not require an interval. The permitted types are as follows:<ul><li><code>ONCE</code></li><li><code>HOURLY</code></li><li><code>DAILY</code></li><li><code>WEEKLY</code></li><li><code>MONTHLY</code></li></ul>Either a frequency <b>or</b> a rrule must be provided for create/update operations.If a <code>frequency.type</code> other than <code>ONCE</code> is provided, the date and time of the blackout recurrences will be calculated based on the <code>frequency</code> or <code>rrule</code> defined, until the threshold of <code>last_start</code> (if one is provided, otherwise until a date considerably far into the future). The value of <code>first_start</code> and <code>first_end</code> define the initial period of the Blackout; duration of this period is adhered to at every recurrence, hence why there is no need to model a <code>last_end</code>.

## Machine-readable artifacts (1)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/rapid7/refs/heads/main/openapi/rapid7-blackouts-api-openapi.yml

## Other Rapid7 APIs (12)

- [Rapid7 InsightVM Cloud API](https://apis.io/apis/rapid7/insightvm-api/)
- [Rapid7 Insight Platform API](https://apis.io/apis/rapid7/insight-platform-api/)
- [Rapid7 InsightIDR API](https://apis.io/apis/rapid7/insightidr-api/)
- [Rapid7 Accounts API](https://apis.io/apis/rapid7/rapid7-accounts-api/)
- [Rapid7 Administration API](https://apis.io/apis/rapid7/rapid7-administration-api/)
- [Rapid7 Apps API](https://apis.io/apis/rapid7/rapid7-apps-api/)
- [Rapid7 Asset API](https://apis.io/apis/rapid7/rapid7-asset-api/)
- [Rapid7 Asset Discovery API](https://apis.io/apis/rapid7/rapid7-asset-discovery-api/)
- [Rapid7 Asset Group API](https://apis.io/apis/rapid7/rapid7-asset-group-api/)
- [Rapid7 Assets API](https://apis.io/apis/rapid7/rapid7-assets-api/)
- [Rapid7 Attachments API](https://apis.io/apis/rapid7/rapid7-attachments-api/)
- [Rapid7 Attack Templates API](https://apis.io/apis/rapid7/rapid7-attack-templates-api/)

## Tags

Blackouts

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/rapid7/rapid7-blackouts-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/rapid7/.