> ## 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.

# Update a schedule

> Update a schedule's configuration, cron expression, or pause/resume it. Send `action: "pause"` or `action: "resume"` to toggle, or provide fields to update.



## OpenAPI

````yaml /openapi.json patch /schedules/{scheduleId}
openapi: 3.1.0
info:
  title: Strix API
  version: 1.0.0
  description: >-
    Public REST API for the Strix autonomous penetration testing platform.
    Manage scans, vulnerabilities, assets, schedules, API tokens, and webhooks.
servers:
  - url: /api/v1
    description: Strix v1 API
security:
  - BearerAuth: []
tags:
  - name: Scans
    description: Launch, monitor, and manage security scans.
  - name: Vulnerabilities
    description: View and triage discovered vulnerabilities.
  - name: Assets
    description: Domains and repositories registered for scanning.
  - name: Schedules
    description: Recurring scan schedules (Pro plan).
  - name: Tokens
    description: Manage API tokens for authentication.
  - name: Webhooks
    description: Configure webhook subscriptions for real-time event notifications.
  - name: Organization
    description: Workspace configuration for the authenticated organization.
  - name: Members
    description: Manage organization members and roles.
  - name: Invitations
    description: List and revoke organization invitations.
  - name: PR Reviews
    description: Automated security review of pull requests.
  - name: Connectors
    description: Network connectors for scanning internal/private targets.
  - name: Knowledge
    description: >-
      Organization knowledge base: documents, policies, and repo profiles that
      steer the agent.
  - name: Uploads
    description: Upload source/code/documentation archives for whitebox scans.
  - name: Integrations
    description: Third-party integrations (GitLab, Bitbucket, ticketing).
  - name: Chat
    description: Conversational agent sessions.
  - name: Analytics
    description: Aggregate dashboard analytics.
  - name: Test Users
    description: >-
      Per-domain test accounts (with optional MFA) the agent authenticates as
      during scans.
paths:
  /schedules/{scheduleId}:
    patch:
      tags:
        - Schedules
      summary: Update a schedule
      description: >-
        Update a schedule's configuration, cron expression, or pause/resume it.
        Send `action: "pause"` or `action: "resume"` to toggle, or provide
        fields to update.
      operationId: updateSchedule
      parameters:
        - $ref: '#/components/parameters/ScheduleId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScheduleRequest'
      responses:
        '200':
          description: Schedule updated.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  isPaused:
                    type: boolean
                required:
                  - success
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/TierLimitError'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - BearerAuth:
            - schedules:write
components:
  parameters:
    ScheduleId:
      name: scheduleId
      in: path
      required: true
      schema:
        type: string
  schemas:
    UpdateScheduleRequest:
      type: object
      properties:
        action:
          type: string
          enum:
            - pause
            - resume
          description: Pause or resume the schedule. Mutually exclusive with other fields.
        cron_expression:
          type: string
        timezone:
          type: string
        name:
          type: string
        domain_ids:
          type: array
          items:
            type: string
        domain_paths:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
        repository_ids:
          type: array
          items:
            type: string
        repository_branches:
          type: object
          additionalProperties:
            type: string
        concerns:
          type: string
        focus:
          type: string
        context:
          type: string
        connector_id:
          type: string
        internal_targets:
          type: array
          items:
            type: string
        org_knowledge_enabled:
          type: boolean
    ErrorResponse:
      type: object
      properties:
        detail:
          type: string
      required:
        - detail
    TierLimitErrorResponse:
      type: object
      properties:
        detail:
          type: string
        requiredTier:
          type: string
        code:
          type: string
      required:
        - detail
  responses:
    BadRequest:
      description: Bad request.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: Missing or invalid API token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    TierLimitError:
      description: Plan or credit limit reached.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/TierLimitErrorResponse'
    NotFound:
      description: Resource not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: >-
        API token obtained from the Tokens endpoint. Include as `Authorization:
        Bearer <token>`.

````