---
title: "Run a schedule immediately without changing its cadence."
method: POST
path: "/v1/scheduled-scans/{scheduleId}/run"
tags: ["Scheduled scans"]
---

# Run a schedule immediately without changing its cadence.

`POST /v1/scheduled-scans/{scheduleId}/run`

## Request

- Base URL: `https://api.on-page.ai`
- URL: `https://api.on-page.ai/v1/scheduled-scans/{scheduleId}/run`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/on-page/apis/on-page-ai-api/docs/v1/scheduled-scans/:scheduleId/run/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `scheduleId` string, required

## Response `202`

Durable occurrence created; inspect its status and receipt.

- ScheduledScanRunEnvelopeResponse
  - `run` object, required
    - `id` string, required
    - `schedule_id` string, required
    - `trigger` 'scheduled' | 'manual', required
    - `occurrence_at` string, required
    - `status` 'dispatching' | 'queued' | 'running' | 'completed' | 'failed' | 'skipped', required
    - `job_id` string, nullable, required
    - `credits` number, required
    - `error` object, nullable, required
      - `code` string, required
      - `message` string, required
    - `receipt` object, nullable, required
    - `started_at` string, nullable, required
    - `completed_at` string, nullable, required
    - `created_at` string, required

## Other responses

- `401`: Unauthorized
- `403`: Scope forbidden
- `404`: Schedule not found
- `409`: The schedule already has an active occurrence.
- `429`: Too many requests. Body is a `oneOf` of rate-limit / org-active-limit / org-queued-limit / scan-queue-saturated variants — branch on `error.code`. `Retry-After` is present when the limiter emits it; `X-RateLimit-*` is present on rate-limit-middleware 429s; `X-Concurrency-*` is present on concurrency-limit 429s (ORG_ACTIVE_LIMIT_REACHED / ORG_QUEUED_LIMIT_REACHED).
- `500`: Internal error
- `503`: Scheduled scans are disabled in this environment.

---

[API](https://skmtc.dev/on-page/apis/on-page-ai-api.md) - [All operations](https://skmtc.dev/on-page/apis/on-page-ai-api/llms.txt) - [OpenAPI document](https://skmtc.dev/on-page/apis/on-page-ai-api/revisions/a081e8701c19?raw)