> ## Documentation Index
> Fetch the complete documentation index at: https://docs.app.strix.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Schedules

> Create and manage recurring pentest schedules

export const ScarfPixel = () => <img referrerPolicy="no-referrer-when-downgrade" src="https://static.scarf.sh/a.png?x-pxid=831669b6-b4bd-42cb-8832-2122c03e1d5f" alt="" width="1" height="1" style={{
  position: "absolute",
  width: 0,
  height: 0,
  opacity: 0,
  pointerEvents: "none"
}} />;

<ScarfPixel />

## List schedules

```bash theme={null}
curl -X GET "https://app.strix.ai/api/v1/schedules" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

**Required scope:** `schedules:read`

## Create a schedule

Requires `cron_expression`, `timezone`, and at least one target (`domain_ids` or `repository_ids`).

```bash theme={null}
curl -X POST "https://app.strix.ai/api/v1/schedules" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly production pentest",
    "cron_expression": "0 9 * * 1",
    "timezone": "America/New_York",
    "domain_ids": ["<DOMAIN_ID>"],
    "also_run_now": false
  }'
```

**Required scope:** `schedules:write`

## Get schedule detail

```bash theme={null}
curl -X GET "https://app.strix.ai/api/v1/schedules/<SCHEDULE_ID>" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

**Required scope:** `schedules:read`

## Pause a schedule

```bash theme={null}
curl -X PATCH "https://app.strix.ai/api/v1/schedules/<SCHEDULE_ID>" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{"action": "pause"}'
```

To resume, use `{"action": "resume"}`.

You can also update the schedule configuration (name, cron\_expression, timezone, targets) in the same PATCH request.

**Required scope:** `schedules:write`

## Delete a schedule

```bash theme={null}
curl -X DELETE "https://app.strix.ai/api/v1/schedules/<SCHEDULE_ID>" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

**Required scope:** `schedules:write`

## Trigger a schedule immediately

Run a scheduled pentest configuration right now without waiting for the next cron interval:

```bash theme={null}
curl -X POST "https://app.strix.ai/api/v1/schedules/<SCHEDULE_ID>/trigger" \
  -H "Authorization: Bearer <YOUR_API_TOKEN>"
```

**Required scope:** `schedules:write`