ZEzeropath
Scans

Get Scan Schedule

Get the automated scan schedule for a repository. Returns the cron expression, timezone, and next scheduled run time.

post/api/v2/scans/getSchedule

Request

  • Base URL
    https://zeropath.com
  • Auth
    API key in header X-ZeroPath-API-Token-Id and API key in header X-ZeroPath-API-Token-Secret

Request body

organizationIdstring

Organization ID that owns the repository. If omitted, resolved from the authenticated user.

repositoryIdstring required

ID of the repository to get the scan schedule for.

Response

Scan schedule retrieved successfully (null if no schedule exists)

idstring required

Unique identifier of the scan schedule

executionCriteriaCrontabstring required

Cron expression defining when scans run (e.g. "0 0 * * 1" for every Monday)

scanBranchstring nullable

Branch this schedule targets. Null means the repository default branch.

repoIdstring required

ID of the repository this schedule belongs to

createdAtstring date-time required

When the schedule was created

updatedAtstring date-time required

When the schedule was last updated

codeScansstring[]

IDs of code scans triggered by this schedule

stagedCodeScansstring[]

IDs of staged code scans triggered by this schedule

Changes

No recorded changes to this operation across all 1 revision of this API.