Skip to main content
PATCH
Error

Authorizations

Authorization
string
header
required

API token obtained from the Tokens endpoint or CLI device login. Include as Authorization: Bearer <token>. Requests made with a managed CLI session also include X-Strix-Workspace: <organization_id> to pin a process to the workspace it started in; recovery endpoints report the current workspace after a concurrent switch.

Path Parameters

scheduleId
string
required

ID of the schedule. Use the id field of a schedule from listSchedules.

Body

application/json
action
enum<string>

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

Available options:
pause,
resume
cron_expression
string

New cron expression, for example 0 9 * * 1.

timezone
string

New IANA timezone for the cron expression, for example America/New_York.

name
string

New display name of the schedule.

domain_ids
string[]

Full replacement list of domain UUIDs to test on each run.

domain_paths
object

Map of domain ID to specific paths to scan on each run.

repository_ids
string[]

Full replacement list of repository UUIDs to test on each run.

repository_branches
object

Map of repository ID to the branch name to test on each run.

concerns
string

Free-text security concerns to prioritize on each run.

focus
string

Free-text areas of the target to test first on each run.

context
string

Free-text background about the target for each run.

connector_id
string

ID of the network connector each run uses to reach a private network.

internal_targets
string[]

Full replacement list of private-network hosts or URLs to test through the connector.

org_knowledge_enabled
boolean

When true, each run uses the organization knowledge base.

max_budget_usd
number | null

Self-hosted only: per-run LLM cost limit (USD) applied to each fired scan. Send null to clear.

Required range: x <= 1000000
scan_tier
enum<string> | null

Scan tier for each fired pentest. The tier changes the credit price of each run. Send null to reset to ultra. Not applicable on self-hosted deployments, for organizations with raw model selection, and for organizations on the Enterprise plan.

Available options:
lite,
standard,
ultra,
null
credentials
object[]

Replaces ALL stored manual credentials for the schedule. Omit to keep the stored credentials unchanged (the template endpoint returns their metadata only).

test_user_ids
string<uuid>[]

Saved test users to authenticate with on each run.

headers
object[]

Full replacement set of custom headers. Stored header values are never returned by the template endpoint. Send keep_stored_value: true (with no value) to reuse the stored value of the existing schedule header with the same name.

upload_ids
string<uuid>[]

Replaces the schedule's uploads. Stored uploads the caller cannot access (hidden from the template for target-scoped actors) are preserved automatically.

scope
object

Per-run scope control applied to each fire. Send an empty object to clear the stored scope.

notify_on_completion
boolean

Email the schedule owner when each run completes.

notification_emails
string<email>[]

Extra addresses to CC on each run's completion email. Validated only when notify_on_completion is true.

Response

Schedule updated.

success
boolean
required
isPaused
boolean