Update a schedule

PATCH

schedules

{scheduleId}

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "isPaused": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "requiredTier": "<string>",
  "code": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Authorizations

Authorization

string

header

required

API token obtained from the Tokens endpoint. Include as Authorization: Bearer <token>.

Path Parameters

scheduleId

string

required

Body

application/json

action

enum<string>

Pause or resume the schedule. Mutually exclusive with other fields.

Available options:

pause,

resume

cron_expression

string

timezone

string

name

string

domain_ids

string[]

domain_paths

object

Show child attributes

repository_ids

string[]

repository_branches

object

Show child attributes

concerns

string

focus

string

context

string

connector_id

string

internal_targets

string[]

org_knowledge_enabled

boolean

Response

Schedule updated.

success

boolean

required

isPaused

boolean

Trigger a schedule immediatelyTrigger an immediate run of a scheduled scan.

Error

A valid request URL is required to generate request examples

{
  "success": true,
  "isPaused": true
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>",
  "requiredTier": "<string>",
  "code": "<string>"
}

{
  "detail": "<string>"
}

{
  "detail": "<string>"
}

Scans

Audit

Vulnerabilities

Assets

Schedules

Tokens

Webhooks

Organization

Members

Invitations

Analytics

Connectors

Chat

PR Reviews

Knowledge

Integrations

Uploads

Test Users

Update a schedule

Authorizations

Path Parameters

Body

Response