> ## Documentation Index
> Fetch the complete documentation index at: https://veridical-dev.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Scan Schedule



## OpenAPI

````yaml /openapi.json put /api/v1/scan-schedules/{schedule_id}
openapi: 3.1.0
info:
  title: Veridical API
  version: 1.0.0
servers:
  - url: https://api.veridical.dev
security: []
paths:
  /api/v1/scan-schedules/{schedule_id}:
    put:
      tags:
        - control
      summary: Update Scan Schedule
      operationId: update_scan_schedule_api_v1_scan_schedules__schedule_id__put
      parameters:
        - in: path
          name: schedule_id
          required: true
          schema:
            title: Schedule Id
            type: string
        - in: header
          name: Idempotency-Key
          required: false
          schema:
            anyOf:
              - maxLength: 200
                minLength: 8
                type: string
              - type: 'null'
            title: Idempotency-Key
        - in: header
          name: X-Correlation-ID
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Correlation-Id
        - in: header
          name: authorization
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Authorization
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScanScheduleConfigure'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: true
                title: >-
                  Response Update Scan Schedule Api V1 Scan Schedules  Schedule
                  Id  Put
                type: object
          description: Successful Response
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          description: Validation Error
      security:
        - BearerAuth: []
components:
  schemas:
    ScanScheduleConfigure:
      properties:
        cadence:
          default: weekly
          pattern: ^(daily|weekly|monthly)$
          title: Cadence
          type: string
        client_request_id:
          anyOf:
            - maxLength: 200
              minLength: 8
              type: string
            - type: 'null'
          title: Client Request Id
        config:
          additionalProperties: true
          title: Config
          type: object
        day_of_month:
          anyOf:
            - maximum: 28
              minimum: 1
              type: integer
            - type: 'null'
          title: Day Of Month
        hour:
          default: 2
          maximum: 23
          minimum: 0
          title: Hour
          type: integer
        minute:
          default: 0
          maximum: 59
          minimum: 0
          title: Minute
          type: integer
        repository_id:
          title: Repository Id
          type: string
        scan_type:
          default: security
          pattern: ^(security|onboarding|full)$
          title: Scan Type
          type: string
        source_ref:
          anyOf:
            - maxLength: 256
              type: string
            - type: 'null'
          title: Source Ref
        state:
          default: active
          pattern: ^(active|paused)$
          title: State
          type: string
        timezone_name:
          default: UTC
          maxLength: 100
          minLength: 1
          title: Timezone Name
          type: string
        weekday:
          anyOf:
            - maximum: 6
              minimum: 0
              type: integer
            - type: 'null'
          default: 0
          title: Weekday
        workspace_id:
          title: Workspace Id
          type: string
      required:
        - workspace_id
        - repository_id
      title: ScanScheduleConfigure
      type: object
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          title: Detail
          type: array
      title: HTTPValidationError
      type: object
    ValidationError:
      properties:
        ctx:
          title: Context
          type: object
        input:
          title: Input
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          title: Location
          type: array
        msg:
          title: Message
          type: string
        type:
          title: Error Type
          type: string
      required:
        - loc
        - msg
        - type
      title: ValidationError
      type: object
  securitySchemes:
    BearerAuth:
      bearerFormat: JWT
      scheme: bearer
      type: http

````