v1

latestOpenAPI 3.0.02026-07-249055687.1 KB
org-snapshots

Start historical data snapshot job (Beta)

This API endpoint is used to start a historical snapshot job. While snapshots are typically taken multiple times a day for paid plans and once a day for free plans, this endpoint can be used to start an "on demand" snapshot job to ensure the latest data is collected and stored for historical purposes.

An historical snapshot will contain details and raw data for the following resources:

  • Repositories
  • Alerts
  • Dependencies
  • Artifacts
  • Users
  • Settings

Historical snapshot data is bucketed to the nearest day which is described in more detail at: Historical Data Endpoints

This endpoint consumes 10 units of your quota.

This endpoint requires the following org token scopes:

  • historical:snapshots-start
post/orgs/{org_slug}/historical/snapshots

Path parameters

org_slugstring required

The slug of the organization

Response

The details of the snapshot job request.

requestIdstring required
requestedBystring required
requestedAtstring required