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 Blackouts API

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 scope property; scope value of APP requires that an appropriate app.id value is also provided. There are two options available to specify how often a blackout will occur, either a frequency or a recurrence rule (rrule). Only frequency supports the use of ONCE only blackouts. If providing a rrule, the following fields are permitted:FREQ where FREQ is one of: HOURLY, DAILY, WEEKLY, MONTHLY INTERVALBYDAY where value is: a single day, SA,SU to represent weekend, or all weekdays. BYMONTHDAY where value is a range between: 1 - 31. BYSETPOS where value is one of: -1, 1, 2, 3, 4COUNTIf providing a rrule, the RFC 2445 section-4.8.5.4 IETF specification can be used as a guide for how to create rrules. Example: rrule = "FREQ=MONTHLY;INTERVAL=1;BYDAY=FR;BYSETPOS=-1" represents 'Run every month on the last Friday'.If providing a frequency, the frequency of a blackout is defined by both the type and interval; specifying a type of ONCE does not require an interval. The permitted types are as follows:ONCEHOURLYDAILYWEEKLYMONTHLYEither a frequency or a rrule must be provided for create/update operations.If a frequency.type other than ONCE is provided, the date and time of the blackout recurrences will be calculated based on the frequency or rrule defined, until the threshold of last_start (if one is provided, otherwise until a date considerably far into the future). The value of first_start and first_end 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 last_end.

Rapid7 Blackouts API is one of 50 APIs that Rapid7 publishes on the 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.

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

5 operations 2 paths 10 schemas 1 DELETE2 GET1 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 5

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

Blackouts 5

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 sco…

GET
/blackouts
Get Blackouts
get-blackouts 4 params → 415200400401403404500
POST
/blackouts
Create Blackout
create-blackout body → 415201400401403404500409
GET
/blackouts/{blackout-id}
Get Blackout
get-blackout 1 param → 415200400401403404500
PUT
/blackouts/{blackout-id}
Update Blackout
update-blackout 1 param body → 415200400401403404500409
DELETE
/blackouts/{blackout-id}
Delete Blackout
delete-blackout 1 param → 415204400401403404500409

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are EntityModelBlackout (12 properties), Blackout (11 properties), PageMetadata (6 properties), Link (4 properties). Each schema is shown below with its type and property counts.

ValidationErrors
object
4 properties
Link
object
4 properties
PageMetadata
object
6 properties
Frequency
object
The frequency at which the Blackout applies. Should not be included if a rrule has been provided.
2 properties
ReferenceResource
object
The last editor of the comment
1 property 1 required
ValidationError
object
3 properties
Blackout
object
11 properties 4 required
EntityModelBlackout
object
12 properties 4 required
Error
object
3 properties
PageBlackout
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

rapid7-blackouts-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