This section documents the V3 API endpoints that provide access to comprehensive audit and journey data from ObservePoint. Use these endpoints to retrieve detailed reports, export data, manage alerts, configure scans and privacy settings, and analyze web performance metrics from your ObservePoint scans.
v3 API//
- Calculate future occurrences based on the new schedules and the old frequencies
Get all schedule presets
Generate a description of a schedule's recurrence
Update calendar items' schedules using this endpoint.
Calculate future occurren...
V3 API
Download OpenAPI description
Overview
Languages
Servers
ObservePoint Production API
https://api.observepoint.com/
- ObservePoint Production APIhttps://api.observepoint.com/v3/schedules/rule-description
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://api.observepoint.com/v3/schedules/rule-description \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"recurrenceRule": "string"
}'Response
application/json
{ "description": "string" }
- ObservePoint Production APIhttps://api.observepoint.com/v3/schedules/calendar
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://api.observepoint.com/v3/schedules/calendar?localStartDateTime=string&localEndDateTime=string' \
-H 'Authorization: YOUR_API_KEY_HERE'Response
application/json
[ { "itemName": "string", "itemId": 0, "itemType": "AUDIT", "runs": [ … ], "futureOccurrences": [ … ], "folderId": 123, "subFolderId": 0, "userId": 123, "labels": [ … ], "isMonitoredByScriptServices": true, "schedule": { … } } ]
Bodyapplication/jsonrequired
Date of first desired start (if in range of recurrence rule).
Timezone identifier compliant with tz database (ex. America/New_York). https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
An RFC-5545 (https://www.rfc-editor.org/rfc/rfc5545#appendix-A) compliant recurrence rule string.
- ObservePoint Production APIhttps://api.observepoint.com/v3/schedules/calendar
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X PUT \
https://api.observepoint.com/v3/schedules/calendar \
-H 'Authorization: YOUR_API_KEY_HERE' \
-H 'Content-Type: application/json' \
-d '{
"updateItems": [
{
"itemType": "AUDIT",
"itemId": 0,
"schedule": {
"dtStart": "string",
"tzId": "string",
"recurrenceRule": "string",
"isPaused": true,
"exceptions": [
"string"
]
}
}
]
}'