BTCPay Server ServerEmail API

openapi: 3.2.0
info:
  title: BTCPay Greenfield Server Email API
  version: v1
  description: '# Introduction


    The BTCPay Server Greenfield API is a REST API.'
  contact:
    name: BTCPay Server
    url: https://btcpayserver.org
  license:
    name: MIT
    url: https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE
servers:
- url: https://{btcpay-host}
  description: Your BTCPay Server instance
  variables:
    btcpay-host:
      default: mainnet.demo.btcpayserver.org
      description: The hostname of your BTCPay Server instance
security:
- API_Key: []
  Basic: []
tags:
- name: ServerEmail
  description: Server Email Settings operations
paths:
  /api/v1/server/email:
    get:
      tags:
      - ServerEmail
      summary: Get server email settings
      description: Retrieve the email settings configured for the server. The password field will be masked if present.
      operationId: ServerEmail_GetSettings
      responses:
        '200':
          description: Server email settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServerEmailSettings'
        '403':
          description: Forbidden - Insufficient permissions
      security:
      - API_Key:
        - btcpay.server.canmodifyserversettings
        Basic: []
    put:
      tags:
      - ServerEmail
      summary: Update server email settings
      description: Update server's email settings.
      operationId: ServerEmail_UpdateSettings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateServerEmailSettings'
      responses:
        '200':
          description: Server email settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetServerEmailSettings'
        '400':
          description: Invalid request or email format
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Forbidden - Insufficient permissions
      security:
      - API_Key:
        - btcpay.server.canmodifyserversettings
        Basic: []
components:
  schemas:
    GetEmailSettings:
      allOf:
      - $ref: '#/components/schemas/EmailSettingsBase'
      - type: object
        properties:
          passwordSet:
            type: boolean
            description: '`true` if the password has been set.'
    UpdateEmailSettings:
      allOf:
      - $ref: '#/components/schemas/EmailSettingsBase'
      - type: object
        properties:
          password:
            type:
            - string
            - 'null'
            description: SMTP password. Keep null or empty to not update it.
            example: MyS3cr3t
    EmailSettingsBase:
      type: object
      properties:
        from:
          type: string
          description: The sender email address
          example: sender@gmail.com
        server:
          type: string
          description: SMTP server host
          example: smtp.gmail.com
        port:
          type: integer
          description: SMTP server port
          example: 587
        login:
          type: string
          description: SMTP username
          example: John.Smith
        disableCertificateCheck:
          type: boolean
          description: Disable TLS certificate security checks
          example: false
    ProblemDetails:
      type: object
      description: Description of an error happening during processing of the request
      properties:
        code:
          type: string
          description: An error code describing the error
        message:
          type: string
          description: User friendly error message about the error
    UpdateServerEmailSettings:
      allOf:
      - $ref: '#/components/schemas/UpdateEmailSettings'
      - type: object
        properties:
          enableStoresToUseServerEmailSettings:
            type: boolean
            description: Indicates if stores can use server email settings
    GetServerEmailSettings:
      allOf:
      - $ref: '#/components/schemas/GetEmailSettings'
      - type: object
        properties:
          enableStoresToUseServerEmailSettings:
            type: boolean
            description: Indicates if stores can use server email settings
  securitySchemes:
    API_Key:
      type: apiKey
      in: header
      name: Authorization
      description: 'BTCPay Server API key. Format: ''token {apiKey}'''
    Basic:
      type: http
      scheme: basic
      description: HTTP Basic Authentication with email and password
externalDocs:
  description: Check out our examples on how to use the API
  url: https://docs.btcpayserver.org/Development/GreenFieldExample/