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

# Job config (secrets stripped)

> When server.permissions.showConfig is false, only name and schedule are returned.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/jobs/{name}/config
openapi: 3.1.0
info:
  description: >-
    snapr is a self-hosted backup service. This document describes its JSON HTTP
    API.
  title: snapr API
  version: dev
servers: []
security: []
paths:
  /api/v1/jobs/{name}/config:
    get:
      tags:
        - Jobs
      summary: Job config (secrets stripped)
      description: >-
        When server.permissions.showConfig is false, only name and schedule are
        returned.
      operationId: getJobConfig
      parameters:
        - description: Job name as declared in snapr.yaml
          in: path
          name: name
          required: true
          schema:
            description: Job name as declared in snapr.yaml
            examples:
              - postgres-nightly
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JobConfigOutputBody'
          description: OK
        default:
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorModel'
          description: Error
      security:
        - session: []
components:
  schemas:
    JobConfigOutputBody:
      additionalProperties: false
      properties:
        config:
          $ref: '#/components/schemas/JobDetail'
        job:
          type: string
      required:
        - job
        - config
      type: object
    ErrorModel:
      additionalProperties: false
      properties:
        detail:
          description: >-
            A human-readable explanation specific to this occurrence of the
            problem.
          examples:
            - Property foo is required but is missing.
          type: string
        errors:
          description: Optional list of individual error details
          items:
            $ref: '#/components/schemas/ErrorDetail'
          type:
            - array
            - 'null'
        instance:
          description: >-
            A URI reference that identifies the specific occurrence of the
            problem.
          examples:
            - https://example.com/error-log/abc123
          format: uri
          type: string
        status:
          description: HTTP status code
          examples:
            - 400
          format: int64
          type: integer
        title:
          description: >-
            A short, human-readable summary of the problem type. This value
            should not change between occurrences of the error.
          examples:
            - Bad Request
          type: string
        type:
          default: about:blank
          description: A URI reference to human-readable documentation for the error.
          examples:
            - https://example.com/errors/example
          format: uri
          type: string
      type: object
    JobDetail:
      additionalProperties: false
      properties:
        compression:
          type: string
        defaultStorage:
          type: string
        encryption:
          $ref: '#/components/schemas/EncryptionDetail'
        hasAfterScript:
          type: boolean
        hasBeforeScript:
          type: boolean
        name:
          type: string
        notifiers:
          items:
            $ref: '#/components/schemas/NotifierDetail'
          type:
            - array
            - 'null'
        retention:
          $ref: '#/components/schemas/RetentionDetail'
        schedule:
          type: string
        sources:
          items:
            $ref: '#/components/schemas/SourceDetail'
          type:
            - array
            - 'null'
        split:
          $ref: '#/components/schemas/SplitDetail'
        storages:
          items:
            $ref: '#/components/schemas/StorageDetail'
          type:
            - array
            - 'null'
      required:
        - name
        - schedule
      type: object
    ErrorDetail:
      additionalProperties: false
      properties:
        location:
          description: >-
            Where the error occurred, e.g. 'body.items[3].tags' or
            'path.thing-id'
          type: string
        message:
          description: Error message text
          type: string
        value:
          description: The value at the given location
      type: object
    EncryptionDetail:
      additionalProperties: false
      properties:
        cipher:
          type: string
        type:
          type: string
      type: object
    NotifierDetail:
      additionalProperties: false
      properties:
        chatId:
          type: string
        from:
          type: string
        name:
          type: string
        onFailure:
          type: boolean
        onSuccess:
          type: boolean
        smtpHost:
          type: string
        to:
          items:
            type: string
          type:
            - array
            - 'null'
        type:
          type: string
        urlHost:
          type: string
      required:
        - type
        - onSuccess
        - onFailure
      type: object
    RetentionDetail:
      additionalProperties: false
      properties:
        last:
          format: int64
          type: integer
      required:
        - last
      type: object
    SourceDetail:
      additionalProperties: false
      properties:
        allDatabases:
          type: boolean
        database:
          type: string
        endpoint:
          type: string
        excludeTables:
          items:
            type: string
          type:
            - array
            - 'null'
        excludes:
          items:
            type: string
          type:
            - array
            - 'null'
        extraParams:
          additionalProperties:
            type: string
          type: object
        hasUri:
          type: boolean
        host:
          type: string
        oplog:
          type: boolean
        path:
          type: string
        port:
          format: int64
          type: integer
        syncPath:
          type: string
        tables:
          items:
            type: string
          type:
            - array
            - 'null'
        type:
          type: string
        username:
          type: string
        zoneName:
          type: string
      required:
        - type
      type: object
    SplitDetail:
      additionalProperties: false
      properties:
        chunkSize:
          type: string
      required:
        - chunkSize
      type: object
    StorageDetail:
      additionalProperties: false
      properties:
        bucket:
          type: string
        endpoint:
          type: string
        hasKnownHosts:
          type: boolean
        hasPrivateKey:
          type: boolean
        hasUrl:
          type: boolean
        host:
          type: string
        name:
          type: string
        path:
          type: string
        port:
          format: int64
          type: integer
        pullZoneHostname:
          type: string
        region:
          type: string
        storageClass:
          type: string
        strictHostKey:
          type: boolean
        type:
          type: string
        urlHost:
          type: string
        username:
          type: string
        zoneName:
          type: string
      required:
        - name
        - type
      type: object
  securitySchemes:
    session:
      description: Session JWT issued by POST /auth/login. Public endpoints ignore it.
      in: cookie
      name: snapr_session
      type: apiKey

````