openapi: 3.2.0
info:
  title: 'Mealie Admin: Backups API'
  description: '

    Mealie is a web application for managing your recipes, meal plans, and shopping lists. This is the Restful

    API interactive documentation that can be used to explore the API. If you''re justing getting started with

    the API and want to get started quickly, you can use the

    [API Usage | Mealie Docs](https://docs.mealie.io/documentation/getting-started/api-usage/)

    as a reference for how to get started.



    If you have any questions or comments about mealie, please use the discord server to talk to the developers or other

    community members. If you''d like to file an issue, please use the

    [GitHub Issue Tracker | Mealie](https://github.com/mealie-recipes/mealie/issues/new/choose)



    ## Helpful Links

    - [Home Page](https://mealie.io)

    - [Documentation](https://docs.mealie.io)

    - [Discord](https://discord.gg/QuStdQGSGK)

    - [Demo](https://demo.mealie.io)

    '
  version: nightly
tags:
- name: 'Admin: Backups'
paths:
  /api/admin/backups:
    get:
      tags:
      - 'Admin: Backups'
      summary: Get All
      operationId: get_all_api_admin_backups_get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AllBackups'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - 'Admin: Backups'
      summary: Create One
      operationId: create_one_api_admin_backups_post
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/backups/{file_name}:
    get:
      tags:
      - 'Admin: Backups'
      summary: Get One
      description: Returns a token to download a file
      operationId: get_one_api_admin_backups__file_name__get
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: file_name
        in: path
        required: true
        schema:
          type: string
          title: File Name
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FileTokenResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - 'Admin: Backups'
      summary: Delete One
      operationId: delete_one_api_admin_backups__file_name__delete
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: file_name
        in: path
        required: true
        schema:
          type: string
          title: File Name
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/backups/upload:
    post:
      tags:
      - 'Admin: Backups'
      summary: Upload One
      description: Upload a .zip File to later be imported into Mealie
      operationId: upload_one_api_admin_backups_upload_post
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Body_upload_one_api_admin_backups_upload_post'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/admin/backups/{file_name}/restore:
    post:
      tags:
      - 'Admin: Backups'
      summary: Import One
      operationId: import_one_api_admin_backups__file_name__restore_post
      security:
      - OAuth2PasswordBearer: []
      parameters:
      - name: file_name
        in: path
        required: true
        schema:
          type: string
          title: File Name
      - name: accept-language
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Accept-Language
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuccessResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    Body_upload_one_api_admin_backups_upload_post:
      properties:
        archive:
          type: string
          contentMediaType: application/octet-stream
          title: Archive
      type: object
      required:
      - archive
      title: Body_upload_one_api_admin_backups_upload_post
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    FileTokenResponse:
      properties:
        fileToken:
          type: string
          title: Filetoken
      type: object
      required:
      - fileToken
      title: FileTokenResponse
    SuccessResponse:
      properties:
        message:
          type: string
          title: Message
        error:
          type: boolean
          title: Error
          default: false
      type: object
      required:
      - message
      title: SuccessResponse
    AllBackups:
      properties:
        imports:
          items:
            $ref: '#/components/schemas/BackupFile'
          type: array
          title: Imports
        templates:
          items:
            type: string
          type: array
          title: Templates
      type: object
      required:
      - imports
      - templates
      title: AllBackups
    BackupFile:
      properties:
        name:
          type: string
          title: Name
        date:
          type: string
          format: date-time
          title: Date
        size:
          type: string
          title: Size
      type: object
      required:
      - name
      - date
      - size
      title: BackupFile
  securitySchemes:
    OAuth2PasswordBearer:
      type: oauth2
      flows:
        password:
          scopes: {}
          tokenUrl: /api/auth/token