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

# Update onboarding setup

> Requires scopes: eval:read



## OpenAPI

````yaml /api-reference/openapi.json patch /api/onboarding/setup
openapi: 3.1.0
info:
  title: EvalGate API
  version: 3.7.6
  description: EvalGate API. See docs/api-contract.md for stability commitments.
servers:
  - url: https://evalgate.com
    description: Production
  - url: http://localhost:3000
    description: Local
security: []
paths:
  /api/onboarding/setup:
    patch:
      tags:
        - onboarding
      summary: Update onboarding setup
      description: 'Requires scopes: eval:read'
      operationId: patch_onboarding_setup
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiOnboardingSetupRequest'
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PatchApiOnboardingSetupResponse200ApplicationJson
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth:
            - eval:read
components:
  schemas:
    PatchApiOnboardingSetupRequest:
      type: object
      properties:
        skipped:
          oneOf:
            - type: boolean
              enum:
                - false
            - type: boolean
              enum:
                - true
        providerKeyProvider:
          oneOf:
            - type: 'null'
            - type: string
        completedSteps:
          type: array
          items:
            type: string
        selectedScopes:
          type: array
          items:
            type: string
        wizard:
          type: object
          properties:
            evaluationId:
              oneOf:
                - type: 'null'
                - type: number
            completed:
              oneOf:
                - type: boolean
                  enum:
                    - false
                - type: boolean
                  enum:
                    - true
            testCaseIds:
              type: array
              items:
                type: number
            evaluationName:
              oneOf:
                - type: 'null'
                - type: string
            selectedPath:
              oneOf:
                - type: 'null'
                - type: string
                  enum:
                    - repository
                - type: string
                  enum:
                    - standalone
                - type: string
                  enum:
                    - deployed-api
                - type: string
                  enum:
                    - existing-traces
                - type: string
                  enum:
                    - cloud-governance
            baselineStatus:
              oneOf:
                - type: 'null'
                - type: string
                  enum:
                    - pending
                - type: string
                  enum:
                    - imported
                - type: string
                  enum:
                    - ready
            currentStep:
              type: number
          additionalProperties: false
      additionalProperties: false
    PatchApiOnboardingSetupResponse200ApplicationJson:
      type: object
      properties:
        onboardingState:
          type: object
          properties:
            completedSteps:
              type: array
              items:
                type: string
            skipped:
              type: boolean
            selectedScopes:
              type: array
              items:
                type: string
            providerKeyProvider:
              oneOf:
                - type: 'null'
                - type: string
            customizedAt:
              oneOf:
                - type: 'null'
                - type: string
            wizard:
              type: object
              properties:
                selectedPath:
                  oneOf:
                    - type: 'null'
                    - type: string
                      enum:
                        - repository
                    - type: string
                      enum:
                        - standalone
                    - type: string
                      enum:
                        - deployed-api
                    - type: string
                      enum:
                        - existing-traces
                    - type: string
                      enum:
                        - cloud-governance
                evaluationId:
                  oneOf:
                    - type: 'null'
                    - type: number
                evaluationName:
                  oneOf:
                    - type: 'null'
                    - type: string
                testCaseIds:
                  type: array
                  items:
                    type: number
                baselineStatus:
                  oneOf:
                    - type: 'null'
                    - type: string
                      enum:
                        - pending
                    - type: string
                      enum:
                        - imported
                    - type: string
                      enum:
                        - ready
                currentStep:
                  type: number
                completed:
                  type: boolean
              additionalProperties: false
              required:
                - selectedPath
                - evaluationId
                - evaluationName
                - testCaseIds
                - baselineStatus
                - currentStep
                - completed
          additionalProperties: false
          required:
            - completedSteps
            - skipped
            - selectedScopes
            - providerKeyProvider
            - customizedAt
      additionalProperties: false
      required:
        - onboardingState
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - VALIDATION_ERROR
                - RATE_LIMITED
                - CONFLICT
                - INTERNAL_ERROR
                - SERVICE_UNAVAILABLE
                - QUOTA_EXCEEDED
                - NO_ORG_MEMBERSHIP
                - CROSS_ORG_REFERENCE
                - INCOMPLETE
                - MALFORMED
            message:
              type: string
            details: {}
            requestId:
              type: string
              format: uuid
          required:
            - code
            - message
      required:
        - error
  responses:
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key or Session Token

````