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

A Schedule defines the automated execution of a Scan, using a specified Scan Config. Both the App and Scan Config must be created prior to creating a Schedule. There are two options available to specify how often a schedule can occur, either a frequency or a recurrence rule (rrule). Only frequency supports the use of ONCE only schedules. If providing a rrule, the following fields are permitted:FREQ where FREQ is one of: HOURLY, DAILY, WEEKLY, MONTHLY INTERVALBYDAY where BYDAY is: a single day, SA,SU to represent weekend, or all weekdays. BYMONTHDAY where BYMONTHDAY is a range between: 1 - 31. BYSETPOS where BYSETPOS is one of: -1, 1, 2, 3, 4COUNT where COUNT is the number of occurrences you want the blackout to run forIf 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, a schedule's frequency 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 Schedule 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).

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

Tagged areas include Schedules. 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.

Schedules 5

A Schedule defines the automated execution of a Scan, using a specified Scan Config. Both the App and Scan Config must be created prior to creating a Schedule. There are two optio…

GET
/schedules
Get Schedules
get-schedules 4 params → 415200400401403404500
POST
/schedules
Create Schedule
create-schedule body → 415201400401403404500409
GET
/schedules/{schedule-id}
Get Schedule
get-schedule 1 param → 415200400401403404500
PUT
/schedules/{schedule-id}
Update Schedule
update-schedule 1 param body → 415200400401403404500409
DELETE
/schedules/{schedule-id}
Delete Schedule
delete-schedule 1 param → 415204400401403404500409

Schemas 10

The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are EntityModelSchedule (9 properties), Schedule (8 properties), frequency (7 properties), PageMetadata (6 properties). Each schema is shown below with its type and property counts.

EntityModelSchedule
object
9 properties 4 required
ValidationErrors
object
4 properties
PageMetadata
object
6 properties
Link
object
4 properties
PageSchedule
object
3 properties
ValidationError
object
3 properties
RequiredIdResource
object
The Scan Config of the Schedule
1 property 1 required
Schedule
object
8 properties 4 required
Error
object
3 properties
frequency
object
The frequency describes how (and if) the Schedule should repeat. Should not be included if a rrule has been provided.
7 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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