openapi: 3.0.1
info:
  title: Veeam Service Provider Console REST API
  description: ''
  version: '3.6'
servers:
  - url: https://server:1280/api/v3
paths:
  /authentication/keys/rsa:
    get:
      tags:
        - Authentication
      summary: Obtain RSA Keys
      description: "Issues an RSA key pair.\n> You can specify the key size if needed.\n"
      operationId: GenerateNewRsaKeyPair
      parameters:
        - name: keySize
          in: query
          description: Number of bits in a key.
          schema:
            type: integer
            format: int32
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: RSA key pair in the .NET XML format.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/RsaKeyPair'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  privateKey: <RSAKeyValue><Modulus>MIICdwIBADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBAMW80mZIUCNPeufya1lZPDXo+Lwjm2IULY9CdfwhfxswM4fZxatDLgSQp9W4gqAFfuYgHxOr/fMVyONgAvwcH2qQqdiC0lVR3h1L8TlqfRL/mRGHP16s0+lE9r0/PzY+4cJT9R2n5ihBbpQqiMH8IQkDXZJFwJupIIDE7u2eJLhhAgMBAAECgYBEiqAv3i8RHlLPJcO6M+lgEoJtzLXmuHHWb8YwAHhrtziVhZI0PFQuNupGde+pgl4rbMT476xWX53D2xsNwr3MeGOSNKikUZtViMI/Ymb4EnUGR9sChAINieN1HJulVPnzgGngDeA6X2VVhdaGKIeVtJLa7JIDHNMnJx2wpttd8QJBAP8pTr8VKps5c00mflbzB150LHEFGuI/vKzH8WQD6XROSuYMGzyPELDxm5Z9xkv81p+XtDCuj2zus7dlMDLWLO0CQQDGYzKvi+Mpxa5Pb55YFcykRp1tkjGAWqlvJAusKdKA3Jj5K14s0OtfCu2/K1BxOpvBBLLIGnJkLJ4Rqg/ypf7FAkEA9HlXga1+DQuWda0UD6r6vH0Ct6b0gyIeXE2V8wXsgAsjqBahYfyROXfEYwRPIi82U+K+OoaF1RFAD89bxtl+YQJBAJ2BpHw7U9+WUw4+UDkfFZpXdiXILAT79gmHVL0bd0VX3xv0kpCCTlznEFr2yKcdIQvd7xNv6+IcimL74i2EHQECQCWzYk/mHKce/uT1Xoc8SQQ55AWC7FzQOsIbzuMmE7CPW/TdbyZW9mGfb3HgQtSrGqXmn5MoUjJ2eRYurrLDDPM=</D></RSAKeyValue>
                  publicKey: <RSAKeyValue><Modulus>MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDFvNJmSFAjT3rn8mtZWTw16Pi8I5tiFC2PQnX8IX8bMDOH2cWrQy4EkKfVuIKgBX7mIB8Tq/3zFcjjYAL8HB9qkKnYgtJVUd4dS/E5an0S/5kRhz9erNPpRPa9Pz82PuHCU/Udp+YoQW6UKojB/CEJA12SRcCbqSCAxO7tniS4YQIDAQAB</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-deny-async-action-registration: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /authentication/keys/rsa-pkcs12:
    get:
      tags:
        - Authentication
      description: Issues a PKCS#12 container with an RSA private key and an X.509 certificate.
      operationId: GenerateNewPkcs12KeyPair
      parameters:
        - name: keySize
          in: query
          description: RSA key size.
          schema:
            type: integer
            format: int32
        - name: subject
          in: query
          description: Certificate subject.
          required: true
          schema:
            type: string
        - name: password
          in: query
          description: Certificate password.
          schema:
            type: string
            format: password
            nullable: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: Pair of PKCS#12 containers with private and public keys in the Base64 format.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/RsaKeyPair'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  privateKey: MIIEogIBAAKCAQBkzpzoQRvsrfsFWRUJxPUHFpwFrFePCIvrKbyOAw0nuiu0HOUgAuDUoktJRGArJDJ7uXIM6dnC8rcERUgpt/Zn0HcPkkOgRA2e5fTz5iYvia1YhI2p0MiLc1wKRmYM/li4rN/rTupdgucsE1eHJj9q1/hZ0kAfjsvCX6zt4Sq/SPeIom8lTAp5cfYuBX7efWI/EeAEs9BX/3JEPVyKplPji8nFPR8HTbxbNw+ntgMc8ymXYBeWrT7wa17eNcq7Ozzn+LzagGw+AP4Ky6DqlZTGWPPoV4f+Y0tznXMJXVTtI6BM33zK7T40ftiIjrPpvuOU3qFb2pTBHgymmlGtY03AgMBAAECggEALhgnuS+kZCn9wSlFrGzqGa6l8xYmB1pCGGrCNDGC/2pqd3ZK8sM+KRx4zmy8iJ2Jk/dtBiicET9InmRLpf/fZQL2niEkWRElJVAn0Yt4XEd+javlZiY/VU6aRLIWaPlDDItaxoPg5xD6KFCZX/I1prCJLBk9UUNnLo/p5qWAvWplfkbY4VpU7p67Cwgs37dBE87jjzqWZEQNc+aB87dz6hJfamBMZ/HKYdY3RwxA+XQCRfhl+qAgR26T/Y7PWEo5NH8kwBtkJ7U+IndNNjjTyW/med4HqNCYLINvSHRQkrs+rfUpY/+b5ObhA9UcdgIyRL1TryBDjpVqMNgn4ZvemQKBgQCtAL0/+EhUwDjKLbHM7JSZAYEhfgwfighB2kIf34YAoqT8t9i4aZX87Pj9GUKJVHiqvdeB32/QccmKkU8/g62DSe8KFDPWqK5r80LpC1JEsYifpcQ9dSmnuRGUGMBkMdDosLAkV8D3j5R03mcMhKXQ91f8NS5YQ5xQMwTBoo0oKwKBgQCVKy7PUEeTQuUGiZYg8UTG5xvRJudhai5UdITjwHijfp2MBjah6q7p0kjbqIM4LUo3AB8JnkKKvdVa9l8qKQhVYoKCX+gYBiGdfS9rAJvYyRhqwd5pvjpA3u+TcRbtJDbkotHCwhkzUEE5pBk3ebO5Yc6u5GK0u26boWx0onW9JQKBgArQrgQOwG7T6XjyLFhUPeHmzyzJ1XYvSd7cByA4+AaYJFpMH/c/WooKQnKIHrm5FyYNYiiTUEkmo+POu7aLw9AeUhw+MRNtTiIffgJVm9oBgzn/wenZpjX/AtNQTM62sompagmLltujFTPNJ4IH1NngbJauuGv6Jg55cgWs5MgrAoGBAIgUw/hWqWU7conbPH1C/VZjAWp1jkG9RxS+03ieXq/wUzOpe2+NFBK1Rsg027iFAJ5aWvZATT4a3ifEeJ6SnkqeuqbLbYV1Gnd8+6QnAwXqtn616/wVkTka5/5e/eZK0lUUAD4nKiw4u7gk7ug/+2hUROQh77YnA0mxIqrohnaNAoGAUdN3OYE0E95SPjrIuZGpJ/2zkruFjWT6Tie6EqZmxMgM+9ZlmfMIY5ED4jcewN7Q59v1zwDRrRMbUzUxzbqE7t7TgydFEESdUg4Q9iU9s90lopQnpcFThCrogigiTXmOhnqB5vkcYbtAZz/H1vRi3jN3YVgeXpw+X2tcEQ5SNck=
                  publicKey: 'MIIBITANBgkqhkiG9w0BAQEFAAOCAQ4AMIIBCQKCAQBkzpzoQRvsrfsFWRUJxPUH,FpwFrFePCIvrKbyOAw0nuiu0HOUgAuDUoktJRGArJDJ7uXIM6dnC8rcERUgpt/Zn0HcPkkOgRA2e+5fTz5iYvia1YhI2p0MiLc1wKRmYM/li4rN/rTupdgucsE1eHJj9q1/hZ0kAfjsvCX6zt4Sq/SPeIom8lTAp5cfYuBX7efWI/EeAEs9BX/3JEPVyKplPji8nFPR8HTbxbNw+ntgMc8ymXYBeWrT7wa17eNcq7Ozzn+LzagGw+AP4Ky6DqlZTGWPPoV4f+Y0tznXMJXVTtI6BM33zK7T40ftiIjrPpvuOU3qFb2pTBHgymmlGtY03AgMBAAE='
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /authentication/keys/rsa-pkcs12/decrypt:
    post:
      tags:
        - Authentication
      description: "Decrypts an encrypted PKCS#12 container.\n> If container does not include private key the server will return an error with the `1210` code.\n"
      operationId: DecryptPkcs12Container
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              required:
                - certificateContent
              properties:
                certificateContent:
                  type: string
                  description: Certificate content.
                password:
                  type: string
                  description: Certificate password.
                  format: password
                  nullable: true
            example:
              certificateContent: MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQC7DUUQbElwvsOUK4BOSfjKvW23LfTg+q/MnUKpcQBcoBsHrPdOG9fEO43bRll76ZXAOQvmni1EjC6tU8dAkACti/TLF9UpYr7OE/a92hP8Mdm8Z43HX7iYRRKA4cEzUgoMI+Q9MEvPJo+ZvPZtwvrCgRJFeQV9nX38T8jWIt6fG1ML0Zdozy9XRSAqtBaeyNM2eeYQbRagR4my+eEyyjmMS25nzw3lp0P2BGAx234g+GxyGbmfNqTvDx62KRhIjG74+dwOlmAbFs54vYem5wXewNX19fRB2DqvnUZKNzfmMjAkwlpWxX+e/pjCZC0UnvXIvg+Ah9erwqLbyqjGCWFXEL+7CRcqTb/puhQVIGYeJrsItkePgSa59nnZuWXvWI8w0rpW5FqwBwqiDjZFtFuyDhjlvSqiJfUwlOhCxdvQDMQDS8LvpV21imE9sAYQbhXP5WtU+wpMvzE0zrg1GJBUVdkOwtR+inufRnFMV0GGZc8yLIxivOzdB8unV9skDOVz2N6Fn9znMaa0b5Vo0+hHakFRT4l27Wv5gPpeoGD2Ww0Nq/DZbPtKutGXDNnIhigXFD0vDTPSM6r6bpwFYK9ljJqMGMrdiKE+NZ7TWiA/41IyO9QDoiEDHRBkYkJGNiUWHiKvpXB4klvbP7MshNItczb4PrPmumS5lm7cdnKCTQIDAQABAoICABdIuZYnxKSSOopRN/GG579lASlSQS9YRVX1JX0uIdtl2reD4m0Irj0xJKFtCmqQUyHQeBjHC9+Ci7TrvtvckRkJWPmHB/PU5OeGOKq9YMt98Rqw0UdGNRZPUtRURdZ7meCU/y5WurkYlbuPeCWFpe1cX8fiHrraRfqIe/mb8ZZgsl/AQVa8o6n7Ytut+zrcyN35Iphc2/orrYpn7I6D+dHq+d1WOuahgaY4OTk7l2HHSsiRRzf4d2OCwFHwn6M4SAAaKjhuo5v7pMwG28H89BAcdQXfDf68SeHedAd9BCpViQSqZNB0WUSTcLSR/8KXXwUUE53uSvyIh/lQKt4sAL+9NibIrFWh20vgU0k4+0Y4l03GA91nzk9L0DFZT+S7/nycO6Ggi0jgS6C1LjFJ6tONDGjWJyYtQtLamer+fDgua1pNO+oMiCHNpuLBq+AP+qFgZH8EnfgbfG6RsdwYdZ3fX1L+Pf07CvvowADTKzqLYzjXCZbXSXuriSia7mfQtFtG4TwtjXZqxRNjMaYmSqM8Oe1UFg0E+77AP2tm/6CGFWFV/QUsWhsQ0U6qw06cM1npUff2QjxnskSl7smN9vy8DtaAAw3rPGzu4C75yjFdhNqEKqiBm04kVW7qHKCbfU5iGIV8cysbGG26iS7dddzaYnPSeBZM6IKA45hZBjEJAoIBAQDnxib7UYQ1Q4B6wnql49wuu2dJKDCICu8kaDyZzZvgZRg6YX+ngaiIM0gSl+CknPYlhl168Bu1Wav6MEMRz10AljaCyJsO56W6FYRPXpso2/tGWR5mGXUgu471XRFMHZXVOx7RKP0tSD3JUgFdvugjCvJdMvnMQ49SGhsonr0TndbHR9sVlsPK9UK9sA24U3iWW8DO7SSEyFqT0aIBMzzg3YEjgGxwBA07yXnA9gCt9bHvtPCR7n49aIRcb660y9+0ekAFAZwNlOPHiHB3FwdikzHesOXPZBAQ/I/0idRYfgGihjbSPA26DEU2/XUitg8ZfC5f8/hLxl9K1R8efKYnAoIBAQDOmm7/zdxgoaLvo6VD1C9lV5v8yunfUqxQrDgYNos0SDO/cHFvR1FQojmCpqoYNs++pk4wB01gspw4aV9mgFjbPYe66aicKq0JEolZKnKTh3xJB9A/TfTBxtuxjWrlb5iAVA6FoNpDZj/rlVvSCD6IH89Fs7nfpKEWIWHhkcu7dIz2leE+GBKzFqv9rZUZrHvEvCgRi0d0ulkzIbf24q2P11Nw1H4EFJFQs+fypSpUxxI3DOEmSXMHz7loHCmV9+Xl0kS1KEb+lVqj5qFVmZipOEDpjur6mM6oTTdqiLlou4s+lGOU3PF1OgiKqH4gIDAqrlsBlatfZ7TwuGQEGHBrAoIBAQDAC2k7brTsaW0oysJTeHV152RSstFbuCuk8BXenwZcrYegwC7E/eNGT6+VcHD8FO7D8wy8E/3xi0a7vIemVzrJhK3QOiZ4+CpTAQcruMk51uTiym8szEVIBQEUf7QYbJ89GoqTZrI5dhV0HdXx9oBkoOpnnRhsT0KPFgCQ7M7gVTWk0/5Nain7nrNZd2o25DsT4xzkmIxc1aJvvxDMi8cSz5b0crHnMwRAGNYgs/WmLuHsK/H2CTZi7ZpW+Vc6iX9oDK/FNis2+bqvF3eQxe0hmbOFwO/6ov/JA2zIg/gGBwqVvz3nf0kkcoxbXzJSu6XRSRsn+IAxUUKeP+9UFJabAoIBAQCLvHwy2+OgH/L6Li7LL6pW2uiQFBYWi+4sKi9OgSWp2OPXKZAveYcQCIjpSxxkgD4GbqkXZvj43BU5OlviEhEHSBiTXRJDfcHHDxiCjGkuS0bOhlBdYLaYkY1qC4IvaEk3EqM30lGNoIy/JCgUaKsSmqEwPZ0MHGcvdqijTl8DjJMC/OB5hQKwyjbNvyfHU5fqunBHXXKZCqjmInowq6REU5kGCVKqI9cdRHEu9nMpH/O79CQcJzV8JQz704B1BFQkGxGJjZJnAlFp5cVdBiPw4DFXRui7UbsEriU7EvqEUcSeMPMhbkaJyRSZ49haliq902uOKNLeFmCVJ8HN21G9AoIBADXSy4Brlnkxp+AY/PJZab+MdyoqrLDZGtTiFnCm/VUldKD4DCfh9u+s3WPa5T3DZs/fTc7PJ9kE8zA1BTdf0sdJRjtsEYRLk8QnFn7YEy7wbvtlhPfgfkGCFEAINPWsvMOCQFdwZAzw4gVi4GFymPo6lWxP+GFXex3Qq8cinot0xPHZvUD16EwTnWjLeEpE1GaLA2PQIbbfUImvO++6ihgwO1x6hKBALCrDyvutq0YZtrWVM9oz8OYEpLJ+eSwx122yCwkMWKHhRrBcLc1CcaZ7Fq7vzM4hLMsMStWNpjzqm953h/jBMYO02xhuZuElnLQ1KyY2ANF8Urr3LPN6uDY=
              password: '321'
        required: true
      responses:
        '200':
          description: Pair of PKCS#12 containers with private and public keys in the Base64 format.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/RsaKeyPair'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  privateKey: MIIJQwIBADANBgkqhkiG9w0BAQEFAASCCS0wggkpAgEAAoICAQCdFV+hVCILF/2/nWe6DcQM50mb9FFxIJbnp0D5c19GgXF/ioW5RQc+AsIQq+2S8XDienssD4XI/ZHWa4+Y2y1r8iGvXAzQ9CvskTwDBtXB+a4O+qzgoTLtbNrdXzPaGHkXhMoPMkUpad/3S/vHB60EM7OdYkQXsM6NxnWbAJ4vi3ZTw9diAW9me3ZmqZZOq4wQy3GhCELNfYf+j4H8A7eKmBnsLfXp5qy3B9ln0vp1Viqg0PB1p4uu+oVzwbwBYYAJMfOIlWPOoa9D4ca/txpYXGkOfbsv71ZDG65Q4yA9o+GaL5zZ0WETF/qwmkHAJ/CysyOa1ihHnmVQd+GG/G9LsRFsBwq3huc/+LtCSlqKwr5iVsjoIpk/VhqC4vmzGl8hHmyZ/PlTwdHuRLDOK4pZKU3tJP9yoQDwxgAJZW0szhe4VQKJvAqvOwTIUapy68Ta5tme40iLwRf5JLPaMxo+7aauJ4+QLZJxs0L3d2ZylXrON1AP7l6yLvDFzC8Bq5zlRDcICDHjvFFzrticmQWOc65m87f6vM5gntehBMOM58lPbfTDmcYvJOV2OmrG/SBnlIrtjJoYtYf5DGS7OiY/TS1pSoooZ6XHf3uGcha+Gj+V+LBuCaSv8OnpjI9PUsVVt4P5zOufnd6dxKsnWdcdv7UDuG4XdvCoA0sLGdpMMwIDAQABAoICABBbMWHzCLhu/xT8pthQpqFRU/DRN8m3wv7MA4/1223T/KVzHwlzjpV+ZAaoYEx0p3RtnHWyCBQtkwnomUMpT0l2JNvFkfAP/KLdXIpUI93WybD1mRqqrkraks+KIjQLaFBymzeJ3Hm7dH6jgsvumK1fVMyGduCgoGFS0Nwa7F22/9MpCTxDOf5JzMJT1jrK0gLNrD9ARPRwpcBz4O0E1g+wVsKo5no8cq98Ob790OZ22ml0WBVoJLtLiqnK+nCKXnKWqO0H4SSa4U0ILVG5Fx0sQiQoI12SZkEGmNgDTlAcyFjtrD9h9eGvFYNeDIqdngp9bK+qrPcIHzSJxwnvLwdgY8f3YE3q27n0U8UVzfSEeYzwmEK6BXGh6Hdlujr/lXO0Bt+xmjnJ2fz7L9blhVh8e1J0NagNV35H++oUvXF7loP2AZ15WQvg9j77Yi8V+4usBI/SZz2ongJTe3qb069Pjs2OuK6OI95AFaLJrV5l7c52LPISyNJ5eexsUWrS0/LYvHKaqBfQmvvUwFbJtC66Vc5Nn+T0Nk/8dTBHSNZVir1E/kJcylgViGaCzPm1pykuI2kKbLFaKZDahG8hKqVpZWvEfV3O1EhqJNWvptLJqfr3Ho+CeN/82hqVg6yy1SmvfFOMeLWHG7DunSUjU0dJosg6NNbQfxo82ae95O+BAoIBAQDpMJtRFi3nrS7pSuRxFziUSVekBY6QI3yS0f2Y6l46Q9qc18oVyMln4pZDPEFZBwpzkoiv7M+1d0MQkJ5iQJQQxtoxGzcPWlTa7CwXOAKnOnE0PoyZ56+q4k1wrc+vwY/vUy/xm83joYDG3ho9QIpYnQnU/EPxOsMNLvPqrn2QxQrILnjC46l33IZU/HgrELzdQJZ8A/TSOCIbInA9nJF6WyrFA5enu7hneabOjwO8ZzxQpQ+CHRuhGter/5fvLUV6niN7EH/FCFlj9QIF+eeMuHtP05dlzYvS5Srp75tO0++NY7tvF5U0FHOlPOiTCGpwvwp4/Y+dg4++0ogyKnzLAoIBAQCscvWBuYQZ6cE6JBV2HDf66NV/P3lMhrr77Txttng4n83NtuLK6BXAu8R0OCX7K3KnyKMzCvk9yXe1DYCYpoLK0jw1GemFuqk7Ghzq30nYsyqwfwQ4TozccxWWscec65+Q2qdrcGjl6UYCKCH60UVzVHLnJsUYpHyzcvfC+Jhag5uVkeNWT6Kul9/bDdQ4uWEZaP0Obf/CjHuibPwW8QzlIwIoDzUie7mrsi+jjKmk7giNjfa7V6HjGPwCQpAGeq4Kk0fW74TDjKbjgbjGR1z8sT87kA9Sy1gfcM7bHHgMRsNTneEACC+id1SnJ+CFqpac6eYnPXjxg4BChiT8OCk5AoIBAQC4pIFHSo2ctdfAaEnMdnuZhx17Rd8lqMO6KcZpL6Le9d2DdaaRa0R3GsaqhGqmCNowuyW6T4QEh2O2GR0gZUwYoKwiWA9X+8nW80zSMcqACdmbaa/BKeBCKiDxiN87psPG2BLNd/YmOTqTvUf/mjwxgF9Jo1pVB5dst/HxsKrCWBN6gLmkb8o/m4FOh/7K8tzpQHwnxKY1UrdGzxUa4/+ZZ9jM2VRbP1v7qyr2we1OYFw06w4Fk/DNt0hw69itTSaHufIUPvM826iUamtougGrvmP9yGhH9uKxYj6Br/VFDLHRPdgrVfwRmeQcQcdSrUZC8jJjrTrrmUHX8jJfrp7TAoIBAQCTOPmbrFO5A7Uw+8lOsjygetJ59iiKSqOrnBdw2sy8GsHKlA3+iDC6ABNx3NWgHrGdyE57ryylsS//Y+2bZNxYZy97bgnNX1RG3r49Ti9vT1Zso6NoprbfJWkS4+e0cfwh4Gn58Ve8oHBiOvz3cl3GXhxSdujhZtwHH2miDDWVYLIc+RWKhCYww/wauS2q16ir1tPj08j7wI90VXLJ6zTFEiQvKvyD2fjjOhYtnFLgOU8X+lDgE6pjhNrw2v62aVnYMXCtcIJ5p8R6ii7DJ/2cxX1kTlKmrm8nOFmA+kcKxAbRhgGm01ZHb3TX19V4h/BZOd6BNZvhJBEFuhwtL40RAoIBAGbkLjVsqP4qNQ7Cec0pZSBxx6hJg0+PmI1Nv7RF8ktXG3embMi19BwEJYwq7oowy2XwNXNksVirleKVU8Lw2ppPB9o2rMGJ2eG2+i5oPz0re7iIuUufaHsaR2oy4PicsH1pT3XYuE8iIK5Gmos/93KuFmCy2xZaU29bShX0jzO0UlP78yRHqQ6JgOPREl0n1mS+fiAZeDowr5bAcNjMh4faxbCj2m+uepQLq4JmC67ThmTsosa2j1TVgkmXsv4Q4ksdDYvkmoBhmYaLdsN0tf9kC3xAt+PB7aAlEuKkHHEcleAYz31HU1u4H8TM76KP/oGcNkBIKowwrdDN9A0nQWM=
                  publicKey: MIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAnRVfoVQiCxf9v51nug3EDOdJm/RRcSCW56dA+XNfRoFxf4qFuUUHPgLCEKvtkvFw4np7LA+FyP2R1muPmNsta/Ihr1wM0PQr7JE8AwbVwfmuDvqs4KEy7Wza3V8z2hh5F4TKDzJFKWnf90v7xwetBDOznWJEF7DOjcZ1mwCeL4t2U8PXYgFvZnt2ZqmWTquMEMtxoQhCzX2H/o+B/AO3ipgZ7C316eastwfZZ9L6dVYqoNDwdaeLrvqFc8G8AWGACTHziJVjzqGvQ+HGv7caWFxpDn27L+9WQxuuUOMgPaPhmi+c2dFhExf6sJpBwCfwsrMjmtYoR55lUHfhhvxvS7ERbAcKt4bnP/i7QkpaisK+YlbI6CKZP1YaguL5sxpfIR5smfz5U8HR7kSwziuKWSlN7ST/cqEA8MYACWVtLM4XuFUCibwKrzsEyFGqcuvE2ubZnuNIi8EX+SSz2jMaPu2mriePkC2ScbNC93dmcpV6zjdQD+5esi7wxcwvAauc5UQ3CAgx47xRc67YnJkFjnOuZvO3+rzOYJ7XoQTDjOfJT230w5nGLyTldjpqxv0gZ5SK7YyaGLWH+QxkuzomP00taUqKKGelx397hnIWvho/lfiwbgmkr/Dp6YyPT1LFVbeD+czrn53encSrJ1nXHb+1A7huF3bwqANLCxnaTDMCAwEAAQ==
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /authentication/keys/totp-secret:
    get:
      tags:
        - Authentication
      summary: Obtain TOTP Secret
      description: Issues a TOTP secret and a URL-encoded secret.
      operationId: GenerateTotpSecret
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: TOTP secret and URL-encoded secret.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TotpSecret'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  secret: DDXOLTJQ2SBJERMSVVTY5UZ4OTBBZ7SA
                  secretUrl: otpauth://totp/VSPC1%5cAdministrator?secret=DDXOLTJQ2SBJERMSVVTY5UZ4OTBBZ7SA&issuer=VSPC%20Company
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /asyncActions/config:
    get:
      tags:
        - AsyncActions
      summary: Get Async Action Configuration
      description: Returns a configuration of an async action service.
      operationId: GetAsyncActionsConfig
      parameters:
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/AsyncActionsConfig'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  resultRetentionTime: 300
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-deny-async-action-registration: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /asyncActions:
    get:
      tags:
        - AsyncActions
      summary: Get Async Actions
      description: Returns a collection resource representation of all active async actions of the current user.
      operationId: GetAsyncActionsInfo
      parameters:
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AsyncActionInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: ecfffc59-b937-4bd6-a1bd-e7818f6ce865
                    initiatorUid: c900282d-b074-464c-98b2-9fe75f2f05a7
                    actionName: StartVb365Job
                    status: failed
                    requestBody: 
                    queryParameters: { }
                  - id: e2a3ee18-a4ce-43d8-81a1-2ab484688ce8
                    initiatorUid: c900282d-b074-464c-98b2-9fe75f2f05a7
                    actionName: DeleteBackupServersPublicCloudApplianceData
                    status: failed
                    requestBody: 
                    queryParameters: { }
                  - id: f740a511-16f6-42e5-8267-9e5b77fc7b48
                    initiatorUid: c900282d-b074-464c-98b2-9fe75f2f05a7
                    actionName: GetUnactivatedVb365Servers
                    status: succeed
                    requestBody: 
                    queryParameters:
                      limit:
                        - '100'
                      offset:
                        - '0'
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-deny-async-action-registration: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/asyncActions/{actionId}':
    get:
      tags:
        - AsyncActions
      summary: Get Async Action
      description: Returns a resource representation of an async action with the specified UID.
      operationId: GetAsyncActionInfo
      parameters:
        - name: actionId
          in: path
          description: Async action UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/AsyncActionInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  id: 07a760e9-6ecf-4121-bfd4-ee514ef9b3ef
                  initiatorUid: 1664927a-da62-4434-9f50-2c1b099948f2
                  actionName: AssignPolicyOnBackupAgent
                  status: running
                  requestBody: 
                  queryParameters:
                    policyUid:
                      - 85e5898a-cf39-404c-a1da-d55bf41e4d2c
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-deny-async-action-registration: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - AsyncActions
      summary: Cancel Async Action
      description: Cancels an action with the specified UID.
      operationId: CancelAsyncAction
      parameters:
        - name: actionId
          in: path
          description: Async action UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-deny-async-action-registration: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/asyncActions/{actionId}/requestData':
    put:
      tags:
        - AsyncActions
      summary: Attach Request Data to Async Action
      description: Attaches provided request data to an async action with the specified UID.
      operationId: AttachRequestDataToAsyncAction
      parameters:
        - name: actionId
          in: path
          description: Async action UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AsyncActionRequestData'
            example:
              requestBody: '{ "siteUid": "d18f40ef-a80f-45c0-a4b6-0de1f5615145", "cloudTenantType": "General", "vCloudOrganizationUid": null, "leaseExpirationEnabled": false, "ownerCredentials": { "userName": "Alpha", "password": "Password1" }, "description": "Site Resource for Alpha Company", "throttlingEnabled": false, "throttlingValue": 1, "throttlingUnit": "MbitPerSec", "maxConcurrentTask": 1, "backupProtectionEnabled": false, "backupProtectionPeriodDays": 1, "gatewaySelectionType": "StandaloneGateways", "isGatewayFailoverEnabled": false}'
              queryParameters: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/AsyncActionInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  id: 07a760e9-6ecf-4121-bfd4-ee514ef9b3ef
                  initiatorUid: 1664927a-da62-4434-9f50-2c1b099948f2
                  actionName: CreateCompanySiteResource
                  status: running
                  requestBody: '{ "siteUid": "d18f40ef-a80f-45c0-a4b6-0de1f5615145", "cloudTenantType": "General", "vCloudOrganizationUid": null, "leaseExpirationEnabled": false, "ownerCredentials": { "userName": "Alpha", "password": "Password1" }, "description": "Site Resource for Alpha Company", "throttlingEnabled": false, "throttlingValue": 1, "throttlingUnit": "MbitPerSec", "maxConcurrentTask": 1, "backupProtectionEnabled": false, "backupProtectionPeriodDays": 1, "gatewaySelectionType": "StandaloneGateways", "isGatewayFailoverEnabled": false}'
                  queryParameters: 
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-deny-async-action-registration: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/asyncActions/{actionId}/result':
    get:
      tags:
        - AsyncActions
      summary: Get Async Action Result
      description: Returns a resource representation of results of an action with the specified UID.
      operationId: GetAsyncActionResult
      parameters:
        - name: actionId
          in: path
          description: Async action UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
              example:
                - id: 62063220-9cf8-420e-b23f-bb0d3967809ffa3c612f-1037-4015-be8b-2d9c96e557d1
                  name: cnn1-wide
                  title: cnn1-wide
                  url: https://cnn1.sharepoint.com/sites/cnn1-wide
                  parentUrl: 
                  isCloud: true
                  isPersonal: false
                  isAvailable: true
                  siteCollectionError: 
                - id: 0cff8a27-3962-4289-b10e-a2e5bea6faa44c93ac7c-5678-41b0-b18a-0854e691e687
                  name: com_site
                  title: com_site
                  url: https://cnn1.sharepoint.com/sites/modern
                  parentUrl: 
                  isCloud: true
                  isPersonal: false
                  isAvailable: true
                  siteCollectionError: 
                - id: 29d8a656-8cd2-4729-be73-4d461c13085a7c71eac2-3bbc-423b-943b-2a9d6033d774
                  name: cnn1_project
                  title: cnn1_project
                  url: https://cnn1.sharepoint.com/sites/cnn1-project
                  parentUrl: 
                  isCloud: true
                  isPersonal: false
                  isAvailable: true
                  siteCollectionError: 
                - id: 9d862fa9-2a86-41fe-aae9-9f9d67a4e7cafbbf6bd5-06b0-4d90-8f4e-3345a8ab7e56
                  name: Alpha Team Site
                  title: Alpha Team Site
                  url: https://cnn1.sharepoint.com/sites/alpha-content
                  parentUrl: 
                  isCloud: true
                  isPersonal: false
                  isAvailable: true
                  siteCollectionError: 
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-deny-async-action-registration: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - AsyncActions
      summary: Delete Async Action Result
      description: Deletes results of an action with the specified UID.
      operationId: ClearAsyncActionResult
      parameters:
        - name: actionId
          in: path
          description: Async action UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-deny-async-action-registration: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /users/me:
    get:
      tags:
        - Accounts
      summary: Get Current User
      description: Returns a resource representation of a currently logged in user.
      operationId: GetCurrentUser
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/User'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 1664927a-da62-4434-9f50-2c1b099948f2
                  organizationUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                  userName: VSPC1\Administrator
                  status: Enabled
                  mfaPolicyStatus: Disabled
                  mfaPolicyConfigurationStatus: NotConfigured
                  role: PortalAdministrator
                  profile:
                    firstName: Stan
                    lastName: Smith
                    title: Mr
                    email: s.smith@mycompany.com
                    address: 
                    phone: 
                  credentials:
                    userName: VSPC1\Administrator
                    password: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /users/logins:
    get:
      tags:
        - Accounts
      summary: Get All User Identities
      description: Returns a collection resource representation of all user identities.
      operationId: GetLogins
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserLogin'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: 67
                    userUid: c37dac86-f273-4133-9bcd-3d5972ef7b40
                    userName: CompanyAdministrator1
                    companyId: 5f6e5f1c-03f3-4ac2-98cb-b2937fd5cc3c
                    companyName: ivzOrg
                    identityProviderName: VSPC
                    description: 
                    isReadAccessOnly: false
                    scopes:
                      - integration
                      - rest
                      - ui
                    status: enabled
                    parameters: ''
                    identifierInProvider: r2_SP_PatchUser_CompanyAdministrator
                    creationDate: '2023-11-19T07:24:37.0193656+01:00'
                  - id: 27
                    userUid: 1b4a5ccf-9f2e-4e05-94ff-6e6f2ca5cfd2
                    userName: Alpha_Admin
                    companyId: ff98a69f-19dd-4a08-898e-a8a3562fe974
                    companyName: Alpha
                    identityProviderName: VBR
                    description: 
                    isReadAccessOnly: false
                    scopes:
                      - integration
                      - rest
                      - ui
                    status: enabled
                    parameters: ''
                    identifierInProvider: alpha
                    creationDate: '2023-11-19T06:57:23.6073442+01:00'
                  - id: 21
                    userUid: cd592141-a9ef-448c-b121-5e1a3800e4c1
                    userName: BetaAdmin
                    companyId: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    companyName: Beta
                    identityProviderName: VSPC
                    description: 
                    isReadAccessOnly: false
                    scopes:
                      - integration
                      - rest
                      - ui
                    status: enabled
                    parameters: ''
                    identifierInProvider: beta
                    creationDate: '2023-11-19T06:39:59.9157620+01:00'
                  - id: 74
                    userUid: c0d22609-861c-4e36-a47d-cd8d05594ffc
                    userName: SigmaAdmin
                    companyId: 5f6e5f1c-03f3-4ac2-98cb-b2937fd5cc3c
                    companyName: Sigma
                    identityProviderName: VSPC
                    description: 
                    isReadAccessOnly: false
                    scopes:
                      - integration
                      - rest
                      - ui
                    status: enabled
                    parameters: ''
                    identifierInProvider: sigma
                    creationDate: '2023-11-19T07:25:47.6712081+01:00'
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/users/{userUid}/logins':
    get:
      tags:
        - Accounts
      summary: Get All Identities of User
      description: Returns a collection resource representation of all authentication types configured for a user with the specified UID.
      operationId: GetUserLogins
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserLogin'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: 1
                    userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                    userName: VSPC1\Administrator
                    companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    companyName: My Company
                    identityProviderName: WIN
                    description: Created by admin
                    isReadAccessOnly: false
                    scopes:
                      - integration
                      - rest
                      - ui
                    status: enabled
                    parameters: ''
                    identifierInProvider: VSPC1\Administrator
                    creationDate: '2023-11-19T04:45:50.3000000+01:00'
                  - id: 28
                    userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                    userName: VSPC1\Administrator
                    companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    companyName: My Company
                    identityProviderName: AA
                    description: ''
                    isReadAccessOnly: false
                    scopes:
                      - rest
                      - ui
                    status: enabled
                    parameters: <RSAKeyValue><Modulus>MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArzPSiDnSAl0903/muIliDnU9i/FBQu1VSh2vsWbRcabRSRjSfRiVlTY+QPoz/SS5npRlKLUBv7jUdytlG3O2ZbTYjbsnuaozflpabHv1CBUEZS+EidfW2qSzSnF26DTy64O+w/8eOJkJH29poq/FJRdZa6jxF9vwnhoXxvjBc+PgOUadEnZNMbjKPDCrm4pclQO0/wEQ4QsY/1JAXIUAaMmbx7dPZSQKxbJMqqy/jsE1rJvFD49y5ou2lMTyqxwD8mOEBeAtmPd+e/b9xrDVDFEsR6wDtGN9QWYwH5tIhzK9Dipb18d4SfTGCdc+ena1gaIdaSXjFdFYqcOp6GaebwIDAQAB</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
                    identifierInProvider: RSA::202C4715D9B6870E016A2E9348B3B56D
                    creationDate: '2023-11-19T07:09:23.3643798+01:00'
                  - id: 35
                    userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                    userName: VSPC1\Administrator
                    companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    companyName: My Company
                    identityProviderName: AA
                    description: ''
                    isReadAccessOnly: false
                    scopes:
                      - rest
                      - ui
                    status: enabled
                    parameters: <RSAKeyValue><Modulus>MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoaOG+CYzoPyegqOOwKT2CSgq38mdBXgUXdbXSdDepTt3GoLWLZBpnmykYYfXMCprGDXYLK5sO7Zbswuv1vB4OM8A+Hrr7hyyWGlnL0jhS3KefhEWhljh8M9Y5xsANTfJY60Y8rT7eQlvc1Wv44H3NK/kORHlpkrXm6KLF6UHCxLiAaPMNckXwKDyd6f0Ecyffk4V4mwxmKYrbsJtHI0yBEFI4LhoBEfBE6ED6LGvUXe+8W40lF/9WoW4tgNjKiiNF8C0OnsF//xEWdAj+M2BSShGoSw9m0uPo3eCIfKgKyVMwEa77M3gSsWJ+7UkT0XxiQ3N8Rf4Z6pwM3lhU0OXAQIDAQAB</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
                    identifierInProvider: RSA::8DF00096789D82AD5EE5A9BDC6BCA58D
                    creationDate: '2023-11-19T07:20:26.1829573+01:00'
                  - id: 36
                    userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                    userName: VSPC1\Administrator
                    companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    companyName: My Company
                    identityProviderName: AA
                    description: ''
                    isReadAccessOnly: false
                    scopes:
                      - rest
                      - ui
                    status: enabled
                    parameters: <RSAKeyValue><Modulus>MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1Y00hvoDc3lTx2XUrMYJ622EHP90/vjowlauqildQfA3gGBAd/iF5+BcMwrrcWQnvSY0NcVfdMxw+hWT/I1+C8aIz+g62yf8jJsKqqEk6TwcJmU+a1dT00avhwG+RCuSMIf3S4h9xQ/3nD6YFJylMGCc7xHJENL4LM0eWAV3wKd4EIk3u7lyy7knrTOWcIeXEB0SPWP2zXb6LsQZ3pQLvE4D5+OvVfAUI9GINuVAUIhU5auADVwK8T1GhKV8ibeoT8zrtXtTpkiOT9DyEQfgVm0wLgR9j+XUhdBpTP36DWGXHlTs50IObnkU04myc51YkrPMRCCLkfZslFC5qlo2ewIDAQAB</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
                    identifierInProvider: RSA::DBBEA0667E5D03D8F357A51B0D9523CB
                    creationDate: '2023-11-19T07:20:26.2454797+01:00'
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /users/backupResources:
    get:
      tags:
        - Accounts
      summary: Get All User Backup Resources
      description: Returns a collection resource representation of subtenant user backup resources.
      operationId: GetUsersBackupResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - userUid: 806cdf82-3a1a-4da1-b3b4-3a774dd5a99c
                    description: Created by Veeam Service Provider Console at 7/23/2025 8:34:59 PM
                    subtenantUid: b9ac2998-56be-4fa3-9b61-723ba8c72ed9
                    vcdUserId: 
                    siteUid: 91c131fc-0a8b-48eb-807e-4625addb7cca
                    tenantBackupResourceUid: d7102e00-4517-4c04-9950-fd1d123b9f34
                    resourceFriendlyName: r2_SP_repo
                    storageQuota: 53687091200
                    storageQuotaUsage: 0
                    isStorageQuotaUnlimited: true
                  - userUid: 977c16ad-606f-4b9c-99ec-5dedebe8cc33
                    description: Created by Veeam Service Provider Console at 7/23/2025 8:41:31 PM
                    subtenantUid: dbf160ca-fd6c-4f14-993f-ead4c717b591
                    vcdUserId: 
                    siteUid: 91c131fc-0a8b-48eb-807e-4625addb7cca
                    tenantBackupResourceUid: d7102e00-4517-4c04-9950-fd1d123b9f34
                    resourceFriendlyName: r2_SP_Company_repo
                    storageQuota: 53687091200
                    storageQuotaUsage: 0
                    isStorageQuotaUnlimited: true
                  - userUid: 99cca618-f4d0-4daf-9ec9-afc74e5d9ea4
                    description: Created by Veeam Service Provider Console at 7/23/2025 8:46:51 PM
                    subtenantUid: 1622b33b-3d88-475b-8a24-dc5b9aa7bfb1
                    vcdUserId: 
                    siteUid: 91c131fc-0a8b-48eb-807e-4625addb7cca
                    tenantBackupResourceUid: d7102e00-4517-4c04-9950-fd1d123b9f34
                    resourceFriendlyName: r2_SP_Company_repo
                    storageQuota: 53687091200
                    storageQuotaUsage: 0
                    isStorageQuotaUnlimited: true
                  - userUid: a5d53997-2d78-45d5-89c6-5a26228b9735
                    description: Created by Veeam Service Provider Console at 7/23/2025 8:44:41 PM
                    subtenantUid: 0853baab-995a-4dc7-99fd-90de08c11b5e
                    vcdUserId: 
                    siteUid: 91c131fc-0a8b-48eb-807e-4625addb7cca
                    tenantBackupResourceUid: d7102e00-4517-4c04-9950-fd1d123b9f34
                    resourceFriendlyName: r3t1_r2val_Repository
                    storageQuota: 53687091200
                    storageQuotaUsage: 0
                    isStorageQuotaUnlimited: true
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/users/{userUid}/logins/totp':
    post:
      tags:
        - Accounts
      summary: Enable MFA for User
      description: Enables multi-factor authentication for a user with the specified UID.
      operationId: AddTotpLogin
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: secretUrl
          in: query
          description: URL-encoded TOTP secret with parameters.
          required: true
          schema:
            type: string
        - name: code
          in: query
          description: Verification code generated for the TOTP secret in the `secretUrl` parameter.
          required: true
          schema:
            maxLength: 100
            type: string
        - name: description
          in: query
          description: Description of the second factor.
          required: true
          schema:
            maxLength: 128
            minLength: 1
            pattern: '^[^<>=]*$'
            type: string
        - name: scopes
          in: query
          description: 'Services that are available to the user identity. In this operation, only the `ui` value is available.'
          required: true
          style: form
          schema:
            type: array
            items:
              enum:
                - unknown
                - integration
                - rest
                - ui
              type: string
              x-ms-enum:
                name: UserLoginScope
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: User identity resource associated with multi-factor authentication.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/UserLogin'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  id: 78
                  userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                  userName: VSPC1\Administrator
                  companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                  companyName: My Company
                  identityProviderName: TOTP
                  description: totp
                  isReadAccessOnly: false
                  scopes:
                    - rest
                  status: enabled
                  parameters: ''
                  identifierInProvider: f42543ec8b1b082f83ab131af5a93b7d46160efc72c284f49be3823d97cf834d04073913bc1bda317022a48e01ffd508dee157dfa06e8dcdf5a4d7d6bcfc5b8d
                  creationDate: '2023-11-19T07:26:20.3560342+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/users/{userUid}/logins/asymmetricalgorithm':
    post:
      tags:
        - Accounts
      summary: Assign Public Key to User
      description: Assigns a public key to a user with the specified UID.
      operationId: AddAsymmetricAlgorithmLogin
      parameters:
        - name: userUid
          in: path
          description: UID of a user to whom a public key must be assigned.
          required: true
          schema:
            type: string
            format: uuid
        - name: description
          in: query
          description: User identity description.
          required: true
          schema:
            maxLength: 128
            minLength: 1
            pattern: '^[^<>=]*$'
            type: string
        - name: scopes
          in: query
          description: Services that are available to the user identity.
          required: true
          style: form
          schema:
            type: array
            items:
              enum:
                - unknown
                - integration
                - rest
                - ui
              type: string
              x-extensible-enum: true
              x-ms-enum:
                name: UserLoginScope
        - name: isReadAccessOnly
          in: query
          description: Defines whether a user identity must have the read-only access.
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Public key.
        content:
          application/octet-stream:
            schema:
              type: string
              format: binary
          application/binary+base64:
            schema:
              type: string
              format: binary
        required: true
      responses:
        '200':
          description: Resource representation of a user identity based on asymmetric algorithm.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/UserLogin'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  id: 303
                  userUid: f354a7b3-807e-4bcb-a1ab-b8cdfc4fe712
                  userName: Admin
                  companyId: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                  companyName: Alpha
                  identityProviderName: AA
                  description: rv3_key
                  isReadAccessOnly: false
                  scopes:
                    - rest
                    - ui
                  status: enabled
                  parameters: <RSAKeyValue><Modulus>reKBJcVqIvSmno63uUsRwjdbJOLP57X8X3EdcABxjQiR+QvlnXCWu0RvlJGjzgEdyxj9Pa+Q/jcsZBE146anoyr/n9OkbQ1UjZIHUFQPkKBOArCgDwQOx9e89GbnoBKDf7uc+egfxVmexsN42TXxg/W8giXu1w3wbUrv1GAGJcYkW9Yl/gi52Xs7O/UE2O/cPLNIUxdz9RogUNobEf9+RM6TI2SMV2XfyqeLoqZW0NLUNfuq2inSqLmqaale4dqahLWpbkLqM+J5cVWdPoojsiO7MSDITncKF0aTa8khF4NvriFwzFuBCM7++vqLZUI6JWKfKjuQZjIz3ZKi0AwFdw==</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
                  identifierInProvider: RSA::16B287544D6F67CB346726F32B8EEEA5
                  creationDate: '2023-11-19T12:11:18.6884425+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/users/{userUid}/logins/apikey':
    post:
      tags:
        - Accounts
      summary: Assign API Key to User
      description: Assigns an API key to a user with the specified UID.
      operationId: AddApiKeyLogin
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: description
          in: query
          description: API key description.
          required: true
          schema:
            maxLength: 128
            minLength: 1
            pattern: '^[^<>=]*$'
            type: string
        - name: scopes
          in: query
          description: Services that are available to the user identity.
          required: true
          style: form
          schema:
            type: array
            items:
              enum:
                - unknown
                - integration
                - rest
                - ui
              type: string
              x-ms-enum:
                name: UserLoginScope
        - name: isReadAccessOnly
          in: query
          description: Defines whether a user identity has the read-only access.
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: User identity resource with the API key located in the parameters property.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/UserLogin'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  id: 71
                  userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                  userName: VSPC1\Administrator
                  companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                  companyName: My Company
                  identityProviderName: AK
                  description: Token for My Company
                  isReadAccessOnly: false
                  scopes:
                    - rest
                    - ui
                  status: enabled
                  parameters: 310cfbbe3fc812741b4RdLdu2uKCqFGzv8YN3SbSF5UXwQ5Ny28h6UvG692J5s2iIvNlci7ssP5cjk1FMFVvmwL1IjWanUQVR2qqmjpHzXy1SpYmL6hUBMGPVW5xl370
                  identifierInProvider: '3534476602111431284'
                  creationDate: '2023-11-19T07:25:46.6863877+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/users/{userUid}/logins/{userLoginId}':
    get:
      tags:
        - Accounts
      summary: Get User Identity
      description: Returns a resource representation of a user identity with the specified ID.
      operationId: GetUserLogin
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: userLoginId
          in: path
          description: User identity ID.
          required: true
          schema:
            type: integer
            format: int64
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/UserLogin'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  id: 1
                  userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                  userName: VSPC1\Administrator
                  companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                  companyName: My Company
                  identityProviderName: WIN
                  description: Created by admin.
                  isReadAccessOnly: false
                  scopes:
                    - integration
                    - rest
                    - ui
                  status: enabled
                  parameters: ''
                  identifierInProvider: VSPC1\Administrator
                  creationDate: '2023-11-19T04:45:50.3000000+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Accounts
      summary: Modify User Identity
      description: Modifies a user identity with the specified ID.
      operationId: UpdateUserLogin
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: userLoginId
          in: path
          description: User identity ID.
          required: true
          schema:
            type: integer
            format: int64
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Modified by admin
                path: /Description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/UserLogin'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  id: 1
                  userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                  userName: VSPC1\Administrator
                  companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                  companyName: My Company
                  identityProviderName: WIN
                  description: Modified by admin
                  isReadAccessOnly: false
                  scopes:
                    - integration
                    - rest
                    - ui
                  status: enabled
                  parameters: ''
                  identifierInProvider: VSPC1\Administrator
                  creationDate: '2023-11-19T04:45:50.3000000+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/UserLogin'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Accounts
      summary: Delete User Identity
      description: Deletes a user identity with the specified ID.
      operationId: DeleteUserLogin
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: userLoginId
          in: path
          description: User identity ID.
          required: true
          schema:
            type: integer
            format: int64
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: Returns the `true` value if the resource is deleted successfully.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: boolean
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /users/resetpassword:
    post:
      tags:
        - Accounts
      summary: Reset User Password
      description: Resets a password of a specific user.
      operationId: CreateResetPasswordRequest
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Properties of a request for a password reset.
        content:
          application/json:
            schema:
              required:
                - email
                - userName
              type: object
              properties:
                email:
                  type: string
                  description: User email address.
                userName:
                  type: string
                  description: User name.
                returnUrl:
                  type: string
                  description: Relative URL that contains the password reset code in query parameters. The URL is send to the user email address provided in the `email` property.
                  nullable: true
            example:
              email: j.smith@alpha.com
              userName: alpha\admin
              returnUrl: /login
        required: true
      responses:
        '200':
          description: Returns the `true` value if the email message is sent successfully.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: boolean
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-allow-anonymous: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    put:
      tags:
        - Accounts
      summary: Complete Password Reset
      description: Completes a request for password reset.
      operationId: CompleteResetPasswordRequest
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Properties required to reset password.
        content:
          application/json:
            schema:
              required:
                - code
                - newPassword
              type: object
              properties:
                code:
                  type: string
                  description: Password reset code.
                newPassword:
                  maxLength: 128
                  minLength: 1
                  type: string
                  description: New user password.
                  format: password
            example:
              code: E2DF8F84479511910E4469B624C72B359C84AC6AE340D7D225BC8FC237BB2E491C217849C5B45F23D0FD6D53BD1B75F37704D908D647D25ADE5914760CEED5256C889432323F9B382826B650969C344C9ACE7E50F11A04F4256F97DA4A881F1EC2E53BB04D773BCD3B4A1935B958D253732CF3C493D868B24EBC0C17A9F4DB58DE07F91952D80E50
              newPassword: password
        required: true
      responses:
        '200':
          description: Returns the `true` value if the password was reset successfully.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: boolean
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-allow-anonymous: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /users:
    get:
      tags:
        - Accounts
      summary: Get All Users
      description: Returns a collection resource representation of all users.
      operationId: GetUsers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c37dac86-f273-4133-9bcd-3d5972ef7b40
                    organizationUid: 5f6e5f1c-03f3-4ac2-98cb-b2937fd5cc3c
                    userName: administrator
                    status: Enabled
                    mfaPolicyStatus: Enabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanyAdministrator
                    profile:
                      firstName: John
                      lastName: Smith
                      title: Mr
                      email: j.smith@alpha.com
                      address: 
                      phone: 
                    credentials:
                      userName: administrator
                      password: 
                  - instanceUid: 1b4a5ccf-9f2e-4e05-94ff-6e6f2ca5cfd2
                    organizationUid: 5f6e5f1c-03f3-4ac2-98cb-b2937fd5cc3c
                    userName: a.west
                    status: Enabled
                    mfaPolicyStatus: Disabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanySubtenant
                    profile:
                      firstName: Adam
                      lastName: West
                      title: Mr
                      email: a.west@alpha.com
                      address: 
                      phone: 410-510-2371
                    credentials:
                      userName: a.west
                      password: 
                  - instanceUid: cd592141-a9ef-448c-b121-5e1a3800e4c1
                    organizationUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    userName: Administrator
                    status: Enabled
                    mfaPolicyStatus: Enabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: ResellerAdministrator
                    profile:
                      firstName: Simon
                      lastName: Cold
                      title: Mr
                      email: s.cold@beta.com
                      address: 
                      phone: 410-510-2317
                    credentials:
                      userName: Administrator
                      password: 
                  - instanceUid: c0d22609-861c-4e36-a47d-cd8d05594ffc
                    organizationUid: 5f6e5f1c-03f3-4ac2-98cb-b2937fd5cc3c
                    userName: atlanta
                    status: Enabled
                    mfaPolicyStatus: Enabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanyLocationUser
                    profile:
                      firstName: 
                      lastName: 
                      title: Unknown
                      email: atlanta@delta.com
                      address: 
                      phone: 
                    credentials:
                      userName: atlanta
                      password: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Accounts
      summary: Create User
      description: Creates a new user with specific properties.
      operationId: CreateUser
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: User properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserInput'
            example:
              organizationUid: bb591af2-7c6b-4bca-856b-603ae6088a1a
              role: CompanySubtenant
              mfaPolicyStatus: Enabled
              profile:
                firstName: John
                lastName: Brown
                title: Mr
                email: j.brown@exon.com
                address: 
                phone: 301 329 9338
              credentials:
                userName: subtenant
                password: Password1
              backupResource:
                siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                tenantBackupResourceUid: bbd634fd-e881-4e03-8aaf-bec7beccd5fb
                description: 
                vcdUserId: 
                resourceFriendlyName: SubtenantRepo
                storageQuota: 1073741824
                isStorageQuotaUnlimited: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/User'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: a1c384f6-4809-45ca-b2db-5c0d99c8c21a
                  organizationUid: 0a093973-274b-4df8-83e2-2316dee0c9a9
                  userName: subtenant
                  status: Enabled
                  mfaPolicyStatus: Enabled
                  mfaPolicyConfigurationStatus: NotConfigured
                  role: CompanyLocationAdministrator
                  profile:
                    firstName: John
                    lastName: Brown
                    title: Mr
                    email: j.brown@exon.com
                    address: 
                    phone: 301 329 9338
                  credentials:
                    userName: subtenant
                    password: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/users/{userUid}':
    get:
      tags:
        - Accounts
      summary: Get User
      description: Returns a resource representation of a user with the specified UID.
      operationId: GetUser
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/User'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 2927487f-079e-4d1e-826a-220dc7a7fa6b
                  organizationUid: 0a093973-274b-4df8-83e2-1316dee0c9a9
                  userName: r2_SP_CompanySubtenant
                  status: Enabled
                  mfaPolicyStatus: Enabled
                  mfaPolicyConfigurationStatus: NotConfigured
                  role: CompanySubtenant
                  profile:
                    firstName: 
                    lastName: 
                    title: Unknown
                    email: 
                    address: 
                    phone: 
                  credentials:
                    userName: r2_SP_CompanySubtenant
                    password: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/User'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Accounts
      summary: Modify User
      description: Modifies a user with the specified UID.
      operationId: PatchUser
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: John
                path: /profile/firstName
                op: replace
              - value: Smith
                path: /profile/lastName
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/User'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: afc20803-e14c-4f9b-8980-d21317f5ba5c
                  organizationUid: 0a093973-274b-4df8-83e2-1316dee0c9a9
                  userName: j.smith
                  status: Enabled
                  mfaPolicyStatus: Enabled
                  mfaPolicyConfigurationStatus: NotConfigured
                  role: CompanySubtenant
                  profile:
                    firstName: John
                    lastName: Smith
                    title: Mr
                    email: j.smith@alpha.com
                    address: 
                    phone: 
                  credentials:
                    userName: j.smith
                    password: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/User'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    delete:
      tags:
        - Accounts
      summary: Delete User
      description: Deletes a user with the specified UID.
      operationId: DeleteUser
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/users/{userUid}/backupResource':
    get:
      tags:
        - Accounts
      summary: Get User Backup Resource
      description: Returns a resource representation of a backup resource available to a subtenant user with the specified UID.
      operationId: GetUserBackupResource
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/UserBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  userUid: 84ff9d2d-2eb8-4a37-bacd-8803800d9837
                  description: Created by Veeam Service Provider Console at 7/23/2025 8:44:41 PM
                  subtenantUid: 542898f0-6a15-46ed-b44b-26381307455c
                  vcdUserId: 
                  siteUid: 91c131fc-0a8b-48eb-807e-4625addb7cca
                  tenantBackupResourceUid: d7102e00-4517-4c04-9950-fd1d123b9f34
                  resourceFriendlyName: r3t1_r2val_Repository
                  storageQuota: 53687091200
                  storageQuotaUsage: 0
                  isStorageQuotaUnlimited: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/UserBackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    patch:
      tags:
        - Accounts
      summary: Modify User Backup Resource
      description: Modifies a backup resource available to a subtenant user with the specified UID.
      operationId: PatchUserBackupResource
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Backup Resource 1
                path: /ResourceFriendlyName
                op: replace
              - value: 2147483648
                path: /StorageQuota
                op: replace
              - value: false
                path: /IsStorageQuotaUnlimited
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/UserBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  userUid: 004fba69-aeca-47f2-95b6-237108e55ea0
                  description: Created by Veeam Service Provider Console at 7/18/2025 1:43:48 AM
                  subtenantUid: a2276564-f648-4370-9b0a-ae51cb72ddd2
                  vcdUserId: 
                  siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                  tenantBackupResourceUid: bbd634fd-e881-4e03-8aaf-bec7beccd5fb
                  resourceFriendlyName: Backup Resource 1
                  storageQuota: 2147483648
                  storageQuotaUsage: 0
                  isStorageQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/UserBackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/users/{userUid}/locations':
    get:
      tags:
        - Accounts
      summary: Get All User Locations
      description: Returns a collection resource representation of all locations assigned to a user with the specified UID.
      operationId: GetUserLocations
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrganizationLocation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 806cdf82-3a1a-4da1-b3b4-3a774dd5a99c
                    organizationUid: b9ac2998-56be-4fa3-9b61-723ba8c72ed9
                    name: Remote
                    quotaGb: 4
                    type: Default
                  - instanceUid: 91c131fc-0a8b-48eb-807e-4625addb7cca
                    organizationUid: b9ac2998-56be-4fa3-9b61-723ba8c72ed9
                    name: CompanyLocationUser-6cfd3
                    quotaGb: 0
                    type: Custom
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Accounts
      summary: Assign Location to User
      description: Assigns a location to a user with the specified UID.
      operationId: SetUserToLocation
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: locationUid
          in: query
          description: Location UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/User'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 26f46a6c-9d30-4c93-b298-ab2afe1bde6c
                  organizationUid: 5f6e5f1c-03f3-4ac2-98cb-b2937fd5cc3c
                  userName: r2_SP_CompanyLocationAdministrator
                  status: Enabled
                  mfaPolicyStatus: Enabled
                  mfaPolicyConfigurationStatus: NotConfigured
                  role: CompanyLocationAdministrator
                  profile:
                    firstName: 
                    lastName: 
                    title: Unknown
                    email: 
                    address: 
                    phone: 
                  credentials:
                    userName: r2_SP_CompanyLocationAdministrator
                    password: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    delete:
      tags:
        - Accounts
      summary: Unassign Location from User
      description: Unassigns a location from a user with the specified UID.
      operationId: DeleteUserFromLocation
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: locationUid
          in: query
          description: Location UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/users/{userUid}/tokens':
    delete:
      tags:
        - Accounts
      summary: Revoke Authentication Token
      description: Revoke access token for a specific user identity or all tokens if the `userLoginId` parameter value is not specified.
      operationId: RevokeAuthenticationToken
      parameters:
        - name: userUid
          in: path
          description: User UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: userLoginId
          in: query
          description: User identity ID.
          schema:
            type: integer
            format: int64
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: Returns the `true` value if the resource is deleted successfully.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: boolean
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /about:
    get:
      tags:
        - About
      summary: Get Veeam Service Provider Console Version
      description: Returns general information about the currently installed version of Veeam Service Provider Console.
      operationId: GetAboutInformation
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/About'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  installationId: 0b47bb94-fd6c-4dda-8143-0f5c0bd65405
                  installationDate: '2023-11-19T03:54:58.8470000+01:00'
                  actualVawVersion: 6.1.0.314
                  actualValVersion: 6.1.0.1466
                  actualVamVersion: 2.1.0.229
                  serverVersion: 8.0.0.16330
                  windowsManagementAgentVersion: 8.0.0.16330
                  linuxManagementAgentVersion: 8.0.0.16330
                  macManagementAgentVersion: 8.0.0.16330
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /configuration/certificates:
    get:
      tags:
        - Configuration
      summary: Get All Certificates on Veeam Service Provider Console Server
      description: Returns a collection resource representation of security cerificates on Veeam Service Provider Console server that are available for installation.
      operationId: GetAllAvailableCertificates
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Certificate'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - issuedTo: CN=Veeam Backup Server Certificate
                    issuedBy: CN=Veeam Backup Server Certificate
                    friendlyName: Veeam Backup Server Certificate
                    thumbprint: EA52EE71DE5E286DBE49C9A307B210E732A95FF9
                    serialNumber: 5668BB0F033E34AA431915C34FFF324C
                    expirationDate: '2029-05-15T13:50:01.0000000+02:00'
                  - issuedTo: CN=Veeam Software
                    issuedBy: 'CN=Veeam Software, O=Veeam Software, OU=Veeam Software'
                    friendlyName: Veeam Software Group GmbH Service Provider Console Communication Certificate
                    thumbprint: D3C3CCD62BAAC5EAAF6EDEA12CD8FA942751AFE1
                    serialNumber: 351963B375A83CBF43BA49B8671699B5
                    expirationDate: '2033-01-18T09:00:00.0000000+01:00'
                  - issuedTo: CN=Veeam Software
                    issuedBy: 'CN=Veeam Software, O=Veeam Software, OU=Veeam Software'
                    friendlyName: Veeam Cloud Connect Certificate
                    thumbprint: CF20F28154135878AB9D46AC2E15C4EB49F345A0
                    serialNumber: 5CD09DE7F25FD19E4D3FC22DF241FF33
                    expirationDate: '2028-07-17T14:17:38.0000000+02:00'
                  - issuedTo: CN=restv3vac.tech.local
                    issuedBy: CN=restv3vac.tech.local
                    friendlyName: Veeam Backup Server Certificate
                    thumbprint: BA16D80F9840379B375F5D06CAAB067ACB4FA931
                    serialNumber: 01A96BF7C18239E57A
                    expirationDate: '2029-05-13T13:00:08.0000000+02:00'
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /configuration/certificates/console:
    get:
      tags:
        - Configuration
      summary: Get Certificate
      description: Returns a Veeam Service Provider Console server security certificate.
      operationId: GetCertificate
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Certificate'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  issuedTo: CN=Veeam Software
                  issuedBy: 'CN=Veeam Software, O=Veeam Software, OU=Veeam Software'
                  friendlyName: Veeam Cloud Connect Certificate
                  thumbprint: CE21F28155125879BB9C36AD3E15C5EC49F356A9
                  serialNumber: 5BC10DE7F15AD19E5E3FD21DF242AEE3
                  expirationDate: '2028-07-17T14:17:38.0000000+02:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    put:
      tags:
        - Configuration
      summary: Install Certificate
      description: Installs a Veeam Service Provider Console server security certificate.
      operationId: InstallCertificate
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstallCertificate'
            example:
              thumbprint: CE21F28155125879BB9C36BD2E15D5DC49F356A8
        required: true
      responses:
        '200':
          description: Installed certificate.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Certificate'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  issuedTo: CN=Veeam Backup Server Certificate
                  issuedBy: CN=Veeam Backup Server Certificate
                  friendlyName: Veeam Backup Server Certificate
                  thumbprint: EB49EE71DF6E2862DE49D0A297B221E652B07EF9
                  serialNumber: 1669DC0F033F43BA432014B45FFA204C
                  expirationDate: '2029-05-15T13:50:01.0000000+02:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /configuration/backupPolicies:
    get:
      tags:
        - Backup Policies
      summary: Get All Backup Policies
      description: Returns a collection resource representation of all backup policies.
      operationId: GetBackupPolicies
      parameters:
        - name: availableToAssignForCompanyUid
          in: query
          description: Limits the collection to the policies that can be assigned to agents of a company with the UID specified in this parameter.
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: d42f9baf-6f6e-4198-be37-d77a3199fb94
                    id: 1
                    organizationUid: 1bc3e325-e636-48bb-8238-5540835de926
                    name: Windows workstation - Personal files
                    description: This policy processes user profile folder including all user settings and data.
                    configId: c82fe3cf-54c6-4c47-b80e-180aa444db75
                    operationMode: Workstation
                    type: Predefined
                    accessMode: Public
                    systemType: Windows
                    createdBy: My Company
                    modifiedDate: '2025-07-18T02:45:19.0500000+02:00'
                    companies:
                      - e5d56b43-cbbb-4038-8246-918b7b33de28
                      - 87d25fcd-9a0a-4d0b-8471-fff519f3260f
                      - 2b2b49b3-73d7-44c4-a566-7bb54224d961
                    agents:
                      - 553887d2-d87c-4e24-8cce-d6c4a41fa209
                      - 74ba1cf1-07dc-452b-aff0-e03aee7eed17
                      - f5ea98b1-42d3-4439-aafe-ac4d32fb7989
                      - 225b7d9e-a41e-4dd5-bf11-b26b4c45e13f
                      - e0f019d7-bd12-4184-b3fe-21d9767bda47
                      - f1cac372-58d8-46ef-8aab-4a6769c81783
                    locations:
                      - fc3efaf9-77ed-439a-92ff-0ff9050d7173
                      - 308f53e1-fda9-4fff-8e14-b185f23d5647
                  - instanceUid: 5ab34bcd-efa7-4a4f-864b-2141f2e4a0cf
                    id: 2
                    organizationUid: 83baba26-a869-439c-8491-c0d6dd71fb48
                    name: Windows server - Entire computer
                    description: 'This policy should be used if you want to create a backup of the entire computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                    configId: a0d1d30d-7db4-4401-898a-c0a45a80de0e
                    operationMode: Server
                    type: Predefined
                    accessMode: Public
                    systemType: Windows
                    createdBy: VAC Company
                    modifiedDate: '2025-07-18T02:45:19.0970000+02:00'
                    companies:
                      - b64d7b8e-49e8-450d-b4f6-60b4ae384b6b
                      - 1451f7d7-9f3a-439e-9f42-09f2428a3a0d
                    agents:
                      - a5a7232a-decf-4002-8e4b-66665dc673c5
                      - 8894c07b-8b53-4d0b-8f04-6de199c583a8
                    locations:
                      - 3eab5715-7a67-4485-974b-8a05b0ac47c5
                      - 510e7b96-87b3-48c3-9547-9aacd87f34a9
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /configuration/backupPoliciesToAssign:
    get:
      tags:
        - Backup Policies
      summary: Get All Available Backup Policies
      description: Returns a collection resource representation of all backup policies that can be assigned to agents.
      operationId: GetBackupPoliciesToAssign
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupPolicyToAssign'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - companyUid: e5d56b43-cbbb-4038-8246-918b7b33de28
                    backupPolicies:
                      - instanceUid: d42f9baf-6f6e-4198-be37-d77a3199fb94
                        id: 1
                        organizationUid: 1bc3e325-e636-48bb-8238-5540835de926
                        name: Windows workstation - Personal files
                        description: This policy processes user profile folder including all user settings and data.
                        configId: c82fe3cf-54c6-4c47-b80e-180aa444db75
                        operationMode: Workstation
                        type: Predefined
                        accessMode: Public
                        systemType: Windows
                        createdBy: My Company
                        modifiedDate: '2025-07-18T02:45:19.0500000+02:00'
                        companies:
                          - e5d56b43-cbbb-4038-8246-918b7b33de28
                          - 87d25fcd-9a0a-4d0b-8471-fff519f3260f
                          - 2b2b49b3-73d7-44c4-a566-7bb54224d961
                        agents:
                          - 553887d2-d87c-4e24-8cce-d6c4a41fa209
                          - 74ba1cf1-07dc-452b-aff0-e03aee7eed17
                          - f5ea98b1-42d3-4439-aafe-ac4d32fb7989
                          - 225b7d9e-a41e-4dd5-bf11-b26b4c45e13f
                          - e0f019d7-bd12-4184-b3fe-21d9767bda47
                          - f1cac372-58d8-46ef-8aab-4a6769c81783
                        locations:
                          - fc3efaf9-77ed-439a-92ff-0ff9050d7173
                          - 308f53e1-fda9-4fff-8e14-b185f23d5647
                      - instanceUid: 5ab34bcd-efa7-4a4f-864b-2141f2e4a0cf
                        id: 2
                        organizationUid: 83baba26-a869-439c-8491-c0d6dd71fb48
                        name: Windows server - Entire computer
                        description: 'This policy should be used if you want to create a backup of the entire computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                        configId: a0d1d30d-7db4-4401-898a-c0a45a80de0e
                        operationMode: Server
                        type: Predefined
                        accessMode: Public
                        systemType: Windows
                        createdBy: VAC Company
                        modifiedDate: '2025-07-18T02:45:19.0970000+02:00'
                        companies:
                          - e5d56b43-cbbb-4038-8246-918b7b33de28
                          - 1451f7d7-9f3a-439e-9f42-09f2428a3a0d
                        agents:
                          - a5a7232a-decf-4002-8e4b-66665dc673c5
                          - 8894c07b-8b53-4d0b-8f04-6de199c583a8
                        locations:
                          - 3eab5715-7a67-4485-974b-8a05b0ac47c5
                          - 510e7b96-87b3-48c3-9547-9aacd87f34a9
                  - companyUid: 2b2b49b3-73d7-44c4-a566-7bb54224d961
                    backupPolicies:
                      - instanceUid: d42f9baf-6f6e-4198-be37-d77a3199fb94
                        id: 1
                        organizationUid: 1bc3e325-e636-48bb-8238-5540835de926
                        name: Windows workstation - Personal files
                        description: This policy processes user profile folder including all user settings and data.
                        configId: c82fe3cf-54c6-4c47-b80e-180aa444db75
                        operationMode: Workstation
                        type: Predefined
                        accessMode: Public
                        systemType: Windows
                        createdBy: My Company
                        modifiedDate: '2025-07-18T02:45:19.0500000+02:00'
                        companies:
                          - e5d56b43-cbbb-4038-8246-918b7b33de28
                          - 87d25fcd-9a0a-4d0b-8471-fff519f3260f
                          - 2b2b49b3-73d7-44c4-a566-7bb54224d961
                        agents:
                          - 553887d2-d87c-4e24-8cce-d6c4a41fa209
                          - 74ba1cf1-07dc-452b-aff0-e03aee7eed17
                          - f5ea98b1-42d3-4439-aafe-ac4d32fb7989
                          - 225b7d9e-a41e-4dd5-bf11-b26b4c45e13f
                          - e0f019d7-bd12-4184-b3fe-21d9767bda47
                          - f1cac372-58d8-46ef-8aab-4a6769c81783
                        locations:
                          - fc3efaf9-77ed-439a-92ff-0ff9050d7173
                          - 308f53e1-fda9-4fff-8e14-b185f23d5647
                      - instanceUid: 5ab34bcd-efa7-4a4f-864b-2141f2e4a0cf
                        id: 2
                        organizationUid: 83baba26-a869-439c-8491-c0d6dd71fb48
                        name: Windows server - Entire computer
                        description: 'This policy should be used if you want to create a backup of the entire computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                        configId: a0d1d30d-7db4-4401-898a-c0a45a80de0e
                        operationMode: Server
                        type: Predefined
                        accessMode: Public
                        systemType: Windows
                        createdBy: VAC Company
                        modifiedDate: '2025-07-18T02:45:19.0970000+02:00'
                        companies:
                          - e5d56b43-cbbb-4038-8246-918b7b33de28
                          - 2b2b49b3-73d7-44c4-a566-7bb54224d961
                        agents:
                          - a5a7232a-decf-4002-8e4b-66665dc673c5
                          - 8894c07b-8b53-4d0b-8f04-6de199c583a8
                        locations:
                          - 3eab5715-7a67-4485-974b-8a05b0ac47c5
                          - 510e7b96-87b3-48c3-9547-9aacd87f34a9
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/configuration/backupPolicies/{policyUid}':
    get:
      tags:
        - Backup Policies
      summary: Get Backup Policy
      description: Returns a resource representation of a backup policy with the specified UID.
      operationId: GetBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 5ab34bcd-efa7-4a4f-864b-2141f2e4a0cf
                  id: 2
                  organizationUid: 83baba26-a869-439c-8491-c0d6dd71fb48
                  name: Windows server - Entire computer
                  description: 'This policy should be used if you want to create a backup of the entire computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                  configId: a0d1d30d-7db4-4401-898a-c0a45a80de0e
                  operationMode: Server
                  type: Predefined
                  accessMode: Public
                  systemType: Windows
                  createdBy: VAC Company
                  modifiedDate: '2025-07-18T02:45:19.0970000+02:00'
                  companies:
                    - e5d56b43-cbbb-4038-8246-918b7b33de28
                    - 2b2b49b3-73d7-44c4-a566-7bb54224d961
                  agents:
                    - a5a7232a-decf-4002-8e4b-66665dc673c5
                    - 8894c07b-8b53-4d0b-8f04-6de199c583a8
                  locations:
                    - 3eab5715-7a67-4485-974b-8a05b0ac47c5
                    - 510e7b96-87b3-48c3-9547-9aacd87f34a9
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/BackupPolicy'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Backup Policies
      summary: Delete Backup Policy
      description: Deletes a backup policy with the specified UID.
      operationId: DeleteBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
    patch:
      tags:
        - Backup Policies
      summary: Modify Backup Policy
      description: Modifies a backup policy with the specified UID.
      operationId: PatchBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: This policy processes user profile folder including all user settings and data.
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 17ea7126-3fc5-48ee-9319-19563ba967b0
                  id: 1
                  organizationUid: 9ce21091-fc13-5165-a72b-2ad5ed722008
                  name: Windows workstation - Personal files
                  description: This policy processes user profile folder including all user settings and data.
                  configId: 4610eb17-b41c-4cc5-81d1-049ee6d89b7a
                  operationMode: Workstation
                  type: Predefined
                  accessMode: Public
                  systemType: Windows
                  createdBy: My Company
                  modifiedDate: '2025-07-22T08:54:31.7770000+02:00'
                  companies: [ ]
                  agents: [ ]
                  locations: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BackupPolicy'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  '/configuration/backupPolicies/{policyUid}/copy':
    post:
      tags:
        - Backup Policies
      summary: Copy Backup Policy
      description: Creates a copy of a backup policy with the specified UID.
      operationId: CopyBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: newPolicyName
          in: query
          description: 'Name of a backup policy copy. Pattern is ''^[^$()%]+$'' for Windows policy and ''^[^~"#%&*:<>?!/\\{|}''`$]+$'' for Linux and Mac policies.'
          required: true
          schema:
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 5ab34bcd-efa7-4a4f-864b-2141f2e4a0cf
                  id: 2
                  organizationUid: 83baba26-a869-439c-8491-c0d6dd71fb48
                  name: Windows server - Entire computer
                  description: 'This policy should be used if you want to create a backup of the entire computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                  configId: a0d1d30d-7db4-4401-898a-c0a45a80de0e
                  operationMode: Server
                  type: Predefined
                  accessMode: Public
                  systemType: Windows
                  createdBy: VAC Company
                  modifiedDate: '2025-07-18T02:45:19.0970000+02:00'
                  companies:
                    - e5d56b43-cbbb-4038-8246-918b7b33de28
                    - 2b2b49b3-73d7-44c4-a566-7bb54224d961
                  agents:
                    - a5a7232a-decf-4002-8e4b-66665dc673c5
                    - 8894c07b-8b53-4d0b-8f04-6de199c583a8
                  locations:
                    - 3eab5715-7a67-4485-974b-8a05b0ac47c5
                    - 510e7b96-87b3-48c3-9547-9aacd87f34a9
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  /configuration/backupPolicies/windows:
    get:
      tags:
        - Backup Policies
      summary: Get All Policies for Windows Computers
      description: Returns a collection resource representation of all backup policies configured for Microsoft Windows computers.
      operationId: GetWindowsBackupPolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WindowsBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 5ab34bcd-efa7-4a4f-864b-2141f2e4a0cf
                    id: 11
                    organizationUid: 83baba26-a869-439c-8491-c0d6dd71fb48
                    name: WindowSchedule
                    description: ''
                    createSubtenants: true
                    createSubFolders: false
                    unlimitedSubtenantQuota: false
                    repositoryQuotaGb: 1
                    operationMode: Server
                    jobConfiguration:
                      backupSource:
                        backupMode: FilesFolders
                        computerLevelOptions: 
                        volumeLevelOptions: 
                        fileLevelOptions:
                          includeDirectories: 
                          excludeDirectories: 
                          inclusionMasks: 
                          exclusionMasks: 
                          osfilesIncluded: true
                          excludeOneDriveFolders: true
                          personalFilesIncluded: true
                          personalFilesAdvancedSettings:
                            inclusions:
                              - Desktop
                            excludeNetworkAccount: false
                      backupTarget:
                        targetType: SharedFolder
                        localPath: 
                        sharedFolder:
                          path: \\vbr\AZShareSMB01
                          credentials:
                            username: administrator
                            password: ••••••
                          backupCacheSettings: 
                        backupRepository: 
                        cloudRepository: 
                      serverModeSettings:
                        retentionSettings:
                          retentionMode: Days
                          retentionCount: 1
                        scheduleSetting:
                          scheduleType: Continuously
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                          continuousScheduleSettings:
                            backupWindowSettings:
                              scheduleWindow:
                                - day: Sunday
                                  hours:
                                    - 0
                                    - 1
                                    - 2
                                    - 3
                                    - 4
                                    - 5
                                    - 6
                                    - 22
                                    - 23
                                - day: Monday
                                  hours: [ ]
                                - day: Tuesday
                                  hours: [ ]
                                - day: Wednesday
                                  hours: [ ]
                                - day: Thursday
                                  hours: [ ]
                                - day: Friday
                                  hours: [ ]
                                - day: Saturday
                                  hours: [ ]
                              shiftForMinutes: 30
                          retrySettings:
                            enabled: true
                            retryTimes: 3
                            waitTimeoutMinutes: 10
                          backupWindow:
                            - day: Tuesday
                              hours:
                                - 0
                                - 1
                                - 2
                                - 3
                                - 4
                                - 5
                                - 6
                                - 22
                                - 23
                            - day: Sunday
                              hours: [ ]
                            - day: Monday
                              hours: [ ]
                            - day: Wednesday
                              hours: [ ]
                            - day: Thursday
                              hours: [ ]
                            - day: Friday
                              hours: [ ]
                            - day: Saturday
                              hours: [ ]
                        indexingSettings: 
                        applicationAwareProcessingSettings:
                          enabled: true
                          transactionLogProcessingMode: ProcessTransactionLogsWithJob
                          sqlServerTransactionLogHandlingSettings:
                            credentials:
                              username: usernameTL
                              password: 
                            logsProcessingMode: TruncateLogs
                            periodicallyBackupSetting: 
                          oracleTransactionLogHandlingSettings:
                            credentials:
                              accountType: Oracle
                              username: usernameORL
                              password: ••••••
                            archivedLogsRetentionMode: DeleteLogsOlderThanHours
                            backupLifeTimeHours: 60
                            backupSizeThresholdGb: 10
                            backupLogsPeriodically: true
                            periodicallyBackupSetting:
                              backupLogsEveryMin: 480
                              backupRetentionMode: KeepLastDays
                              keepBackupsOnlyLastDays: 60
                          sharePointAccountSettings: 
                          scriptSettings:
                            mode: IgnoreErrors
                            preFreezeScript:
                              fileName: prefreeze_Script1.bat
                              content: 
                            postThawScript:
                              fileName: postthaw_Script2.exe
                              content: 
                            credentials:
                              username: usernameS
                              password: ••••••
                      workstationModeSettings: 
                      advancedSettings:
                        backupStorage:
                          compressionLevel: Dedupe
                          storageOptimization: Lan512KB
                          encryptionEnabled: true
                          password: ••••••
                          passwordHint: passwordhint
                        scheduleSettings:
                          syntheticFullOnDays: 
                          activeFullSettings: 
                        maintenanceSettings:
                          backupHealthCheckSettings: 
                          fullBackupFileMaintenanceSettings:
                            enableDeletedFilesRetention: true
                            removeDeletedItemsDataAfter: 30
                            defragmentAndCompactFullBackupFileSettings: 
                          fullHealthCheck: false
                      gfsRetentionSettings: 
                    type: Provider
                    accessMode: Private
                    createdBy: My Company
                    modifiedDate: '2025-07-26T02:31:02.4755583+02:00'
                    companies: [ ]
                    agents: [ ]
                    locations: [ ]
                  - instanceUid: a0d1d30d-7db4-4401-898a-c0a45a80de0e
                    id: 2
                    organizationUid: b64d7b8e-49e8-450d-b4f6-60b4ae384b6b
                    name: Windows server - Entire computer
                    description: 'This policy should be used if you want to create a backup of the entire computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                    createSubtenants: true
                    createSubFolders: false
                    unlimitedSubtenantQuota: true
                    repositoryQuotaGb: 
                    operationMode: Server
                    jobConfiguration:
                      backupSource:
                        backupMode: EntireComputer
                        computerLevelOptions:
                          includeUsbDrives: false
                        volumeLevelOptions: 
                        fileLevelOptions: 
                      backupTarget:
                        targetType: CloudRepository
                        localPath: 
                        sharedFolder: 
                        backupRepository: 
                        cloudRepository: 
                      serverModeSettings:
                        retentionSettings:
                          retentionMode: RestorePoints
                          retentionCount: 7
                        scheduleSetting:
                          scheduleType: Daily
                          dailyScheduleSettings:
                            time: '2025-09-09T00:30:00.0000000+02:00'
                            dailyMode: Everyday
                            specificDays: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                          continuousScheduleSettings: 
                          retrySettings:
                            enabled: true
                            retryTimes: 3
                            waitTimeoutMinutes: 10
                          backupWindow: 
                        indexingSettings: 
                        applicationAwareProcessingSettings:
                          enabled: true
                          transactionLogProcessingMode: ProcessTransactionLogsWithJob
                          sqlServerTransactionLogHandlingSettings:
                            credentials: 
                            logsProcessingMode: TruncateLogs
                            periodicallyBackupSetting: 
                          oracleTransactionLogHandlingSettings:
                            credentials: 
                            archivedLogsRetentionMode: DoNotDeleteArchivedLogs
                            backupLifeTimeHours: 24
                            backupSizeThresholdGb: 10
                            backupLogsPeriodically: false
                            periodicallyBackupSetting: 
                          sharePointAccountSettings: 
                          scriptSettings:
                            mode: Disabled
                            preFreezeScript: 
                            postThawScript: 
                            credentials: 
                      workstationModeSettings: 
                      advancedSettings:
                        backupStorage:
                          compressionLevel: Optimal
                          storageOptimization: Lan512KB
                          encryptionEnabled: false
                          password: 
                          passwordHint: 
                        scheduleSettings:
                          syntheticFullOnDays: 
                          activeFullSettings: 
                        maintenanceSettings:
                          backupHealthCheckSettings: 
                          fullBackupFileMaintenanceSettings:
                            enableDeletedFilesRetention: false
                            removeDeletedItemsDataAfter: 30
                            defragmentAndCompactFullBackupFileSettings: 
                          fullHealthCheck: false
                      gfsRetentionSettings: 
                    type: Predefined
                    accessMode: Public
                    createdBy: VAC Company
                    modifiedDate: '2025-07-26T00:57:25.1130000+02:00'
                    companies:
                      - 1451f7d7-9f3a-439e-9f42-09f2428a3a0d
                      - a5a7232a-decf-4002-8e4b-66665dc673c5
                    agents:
                      - 8894c07b-8b53-4d0b-8f04-6de199c583a8
                      - 3eab5715-7a67-4485-974b-8a05b0ac47c5
                    locations:
                      - 510e7b96-87b3-48c3-9547-9aacd87f34a9
                      - ffb77a79-5925-4426-b2c6-c076bb384df4
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Backup Policies
      summary: Create Backup Policy for Windows Computers
      description: Creates a backup policy for Microsoft Windows computers.
      operationId: CreateWindowsBackupPolicy
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Backup policy properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WindowsBackupPolicyInput'
            example:
              name: WWrkstEntireCloud
              description: temp description
              operationMode: Workstation
              accessMode: Public
              createSubtenants: true
              createSubFolders: false
              unlimitedSubtenantQuota: false
              repositoryQuotaGb: 1
              jobConfiguration:
                backupSource:
                  backupMode: EntireComputer
                  computerLevelOptions:
                    includeUsbDrives: true
                  volumeLevelOptions: 
                  fileLevelOptions: 
                backupTarget:
                  targetType: CloudRepository
                  localPath: 
                  sharedFolder: 
                  backupRepository: 
                  cloudRepository:
                    backupCacheSettings:
                      location: C:\string
                      maximumSizeGb: 1
                serverModeSettings:
                  retentionSettings:
                    retentionMode: RestorePoints
                    retentionCount: 7
                  scheduleSetting:
                    scheduleType: Daily
                    dailyScheduleSettings:
                      time: '2025-09-09T00:30:00.0000000+02:00'
                      dailyMode: Everyday
                      specificDays: 
                    monthlyScheduleSettings: 
                    periodicalScheduleSettings: 
                    continuousScheduleSettings:
                      backupWindowSettings:
                        scheduleWindow: 
                        shiftForMinutes: 0
                    retrySettings:
                      enabled: true
                      retryTimes: 3
                      waitTimeoutMinutes: 10
                    backupWindow: 
                  indexingSettings: 
                  applicationAwareProcessingSettings:
                    enabled: false
                    transactionLogProcessingMode: ProcessTransactionLogsWithJob
                    sqlServerTransactionLogHandlingSettings: 
                    oracleTransactionLogHandlingSettings: 
                    sharePointAccountSettings: 
                    scriptSettings: 
                workstationModeSettings:
                  scheduleSetting:
                    periodicalScheduleEnabled: true
                    periodicalScheduleSettings:
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      shutdownAction: SkipBackup
                      finalizingAction: KeepRunning
                    eventTriggerSettings:
                      backupOnLock: false
                      backupOnLogOff: false
                      backupOnTargetConnection: false
                      ejectTargetOnBackupComplete: false
                      backupNotOften: 3
                      notOftenTimeUnit: Hours
                  retentionSettings:
                    retentionDays: 7
                advancedSettings:
                  backupStorage:
                    compressionLevel: Optimal
                    storageOptimization: Local1MB
                    encryptionEnabled: false
                    password: 
                    passwordHint: 
                  scheduleSettings: 
                  maintenanceSettings: 
                gfsRetentionSettings: 
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 63d71674-76ed-4701-9426-e5c9403a37c2
                  id: 18
                  organizationUid: 8f54f378-f79b-4924-a67b-8a10a3a6737c
                  name: WWrkstEntireCloud
                  description: ''
                  createSubtenants: true
                  createSubFolders: false
                  unlimitedSubtenantQuota: false
                  repositoryQuotaGb: 100
                  operationMode: Workstation
                  jobConfiguration:
                    backupSource:
                      backupMode: EntireComputer
                      computerLevelOptions:
                        includeUsbDrives: false
                      volumeLevelOptions: 
                      fileLevelOptions: 
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      cloudRepository: 
                    serverModeSettings:
                      retentionSettings:
                        retentionMode: RestorePoints
                        retentionCount: 7
                      scheduleSetting:
                        scheduleType: Daily
                        dailyScheduleSettings:
                          time: '2025-09-09T00:30:00.0000000+02:00'
                          dailyMode: Everyday
                          specificDays: 
                        monthlyScheduleSettings: 
                        periodicalScheduleSettings: 
                        continuousScheduleSettings: 
                        retrySettings:
                          enabled: true
                          retryTimes: 3
                          waitTimeoutMinutes: 10
                        backupWindow: 
                      indexingSettings: 
                      applicationAwareProcessingSettings:
                        enabled: false
                        transactionLogProcessingMode: ProcessTransactionLogsWithJob
                        sqlServerTransactionLogHandlingSettings: 
                        oracleTransactionLogHandlingSettings: 
                        sharePointAccountSettings: 
                        scriptSettings: 
                    workstationModeSettings: 
                    advancedSettings:
                      backupStorage:
                        compressionLevel: Optimal
                        storageOptimization: Local1MB
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                      scheduleSettings:
                        syntheticFullOnDays: 
                        activeFullSettings: 
                      maintenanceSettings:
                        backupHealthCheckSettings: 
                        fullBackupFileMaintenanceSettings:
                          enableDeletedFilesRetention: false
                          removeDeletedItemsDataAfter: 30
                          defragmentAndCompactFullBackupFileSettings: 
                        fullHealthCheck: false
                    gfsRetentionSettings: 
                  type: Provider
                  accessMode: Public
                  createdBy: Alpha
                  modifiedDate: '2025-07-24T07:26:22.7291470+02:00'
                  companies: [ ]
                  agents: [ ]
                  locations: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  /configuration/backupPolicies/linux:
    get:
      tags:
        - Backup Policies
      summary: Get All Policies for Linux Computers
      description: Returns a collection resource representation of all backup policies configured for Linux computers.
      operationId: GetLinuxBackupPolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LinuxBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: a594d2f6-217f-4a7a-9859-d24fa39b76ce
                    id: 13
                    organizationUid: eaf4034e-f4a7-4f6d-8de4-85764963887c
                    name: LServerVolumeCloud
                    description: Linux server volume job
                    createSubtenants: true
                    unlimitedSubtenantQuota: false
                    repositoryQuotaGB: 1
                    operationMode: Server
                    jobConfiguration:
                      backupSource:
                        backupMode: Volume
                        volumeLevelOptions:
                          volumes:
                            - volumeType: MountPoint
                              path: /cafe
                            - volumeType: Device
                              path: /work
                        fileLevelOptions: 
                      backupTarget:
                        targetType: CloudRepository
                        localPath: 
                        sharedFolder: 
                        backupRepository: 
                        enableDeletedFilesRetention: false
                        removeDeletedItemsDataAfter: 30
                      backupStorage:
                        compressionLevel: Optimal
                        blockSize: Local1MB
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                        isSnapshotRequired: true
                      indexingSettings:
                        indexingType: ExceptSpecifiedFolders
                        includedFolders: 
                        excludedFolders:
                          - home
                          - work
                          - smthelse
                      scriptSettings:
                        enabled: true
                        preJobScript:
                          fileName: prejob_pre.sh
                          content: 
                        postJobScript:
                          fileName: postjob_post.sh
                          content: 
                        preFreezeScript: 
                        postThawScript: 
                      retentionSettings:
                        restorePointsCount: 7
                      scheduleSettings:
                        scheduleType: NotScheduled
                        dailyScheduleSettings: 
                        monthlyScheduleSettings: 
                        periodicallyScheduleSettings: 
                        activeFullSettings: 
                        retrySettings:
                          enabled: false
                          retryTimes: 3
                          waitTimeoutMinutes: 10
                        backupHealthCheckScheduleSettings: 
                      applicationAwareProcessingSettings:
                        oracleAapSettings:
                          processingType: TryProcess
                          credentials:
                            username: root1
                            password: ••••••
                          truncationConfig:
                            truncationMode: TruncateDisabled
                            sizeGB: 10
                            lifeTimeHours: 24
                          useOracleCredentials: true
                        mySqlAapSettings:
                          processingType: RequireSuccess
                          credentials:
                            username: root2
                            password: ••••••
                          authType: MySQLPassword
                          passwordFilePath: ''
                        postgreSqlAapSettings:
                          processingType: TryProcess
                          credentials:
                            username: root3
                            password: ••••••
                          authType: PSQLPassword
                      gfsRetentionSettings: 
                    type: Provider
                    accessMode: Public
                    createdBy: My Company
                    modifiedDate: '2025-07-18T04:29:40.7669167+02:00'
                    companies: [ ]
                    agents: [ ]
                    locations: [ ]
                  - instanceUid: 2fb7b81d-05d2-4deb-b5b1-a9bcd66336f6
                    id: 4
                    organizationUid: 875d2322-7e7b-4b74-a354-1744c2a8c5c5
                    name: Linux server - Entire computer
                    description: 'This policy should be used if you want to create a backup of the entire Linux computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                    createSubtenants: true
                    unlimitedSubtenantQuota: true
                    repositoryQuotaGB: 
                    operationMode: Server
                    jobConfiguration:
                      backupSource:
                        backupMode: EntireComputer
                        volumeLevelOptions: 
                        fileLevelOptions: 
                      backupTarget:
                        targetType: CloudRepository
                        localPath: 
                        sharedFolder: 
                        backupRepository: 
                        enableDeletedFilesRetention: false
                        removeDeletedItemsDataAfter: 30
                      backupStorage:
                        compressionLevel: Optimal
                        blockSize: Local1MB
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                        isSnapshotRequired: true
                      indexingSettings:
                        indexingType: None
                        includedFolders: 
                        excludedFolders:
                          - /cdrom
                          - /dev
                          - /media
                          - /mnt
                          - /proc
                          - /tmp
                          - /lost+found
                      scriptSettings:
                        enabled: false
                        preJobScript: 
                        postJobScript: 
                        preFreezeScript: 
                        postThawScript: 
                      retentionSettings:
                        restorePointsCount: 7
                      scheduleSettings:
                        scheduleType: Daily
                        dailyScheduleSettings:
                          time: '2025-09-09T00:30:00.0000000+02:00'
                          dailyMode: Everyday
                          specificDays: 
                        monthlyScheduleSettings: 
                        periodicallyScheduleSettings: 
                        activeFullSettings:
                          scheduleType: NotScheduled
                          monthly: 
                          weeklyOnDays: 
                        retrySettings:
                          enabled: true
                          retryTimes: 3
                          waitTimeoutMinutes: 10
                        backupHealthCheckScheduleSettings: 
                      applicationAwareProcessingSettings:
                        oracleAapSettings:
                          processingType: DisableProcess
                          credentials: 
                          truncationConfig:
                            truncationMode: TruncateDisabled
                            sizeGB: 10
                            lifeTimeHours: 24
                          useOracleCredentials: true
                        mySqlAapSettings:
                          processingType: DisableProcess
                          credentials: 
                          authType: MySQLPassword
                          passwordFilePath: 
                        postgreSqlAapSettings:
                          processingType: DisableProcess
                          credentials: 
                          authType: PSQLPassword
                      gfsRetentionSettings: 
                    type: Predefined
                    accessMode: Public
                    createdBy: VAC Company
                    modifiedDate: '2025-07-18T02:45:19.1770000+02:00'
                    companies:
                      - 4d5d6711-053a-4fd6-8cfb-8c802b5e0af2
                    agents:
                      - 9cdccf69-8e48-47e3-8f64-dc780ce11684
                      - 78c322bc-b70d-4e75-a14d-bad67a087eff
                    locations:
                      - bea50fe4-9658-44cf-bd28-015f1bf58d21
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Backup Policies
      summary: Create Backup Policy for Linux Computers
      description: Creates a backup policy for Linux computers.
      operationId: CreateLinuxBackupPolicy
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Backup policy properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinuxBackupPolicyInput'
            example:
              name: LinuxSrvtEntireCloud
              description: ''
              operationMode: Server
              accessMode: Public
              createSubtenants: true
              unlimitedSubtenantQuota: false
              repositoryQuotaGB: 100
              jobConfiguration:
                backupSource:
                  backupMode: EntireComputer
                  volumeLevelOptions: 
                  fileLevelOptions: 
                backupTarget:
                  targetType: CloudRepository
                  localPath: 
                  sharedFolder: 
                  backupRepository: 
                  enableDeletedFilesRetention: false
                  removeDeletedItemsDataAfter: 30
                backupStorage:
                  compressionLevel: Optimal
                  blockSize: Local1MB
                  encryptionEnabled: false
                  password: 
                  passwordHint: 
                  isSnapshotRequired: true
                indexingSettings: 
                scriptSettings: 
                retentionSettings:
                  restorePointsCount: 7
                scheduleSettings:
                  scheduleType: NotScheduled
                  dailyScheduleSettings:
                    time: '2025-09-09T00:30:00.0000000+02:00'
                    dailyMode: Everyday
                    specificDays: 
                  monthlyScheduleSettings: 
                  periodicallyScheduleSettings: 
                  activeFullSettings: 
                  retrySettings:
                    enabled: false
                    retryTimes: 3
                    waitTimeoutMinutes: 10
                  backupHealthCheckScheduleSettings: 
                applicationAwareProcessingSettings: 
                gfsRetentionSettings: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 00e8481d-d872-428b-835f-bff07716bb21
                  id: 17
                  organizationUid: 8f54f378-f79b-4924-a67b-8a10a3a6737c
                  name: LinuxSrvEntireCloud
                  description: ''
                  createSubtenants: true
                  unlimitedSubtenantQuota: false
                  repositoryQuotaGB: 100
                  operationMode: Server
                  jobConfiguration:
                    backupSource:
                      backupMode: EntireComputer
                      volumeLevelOptions: 
                      fileLevelOptions: 
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local1MB
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                      isSnapshotRequired: true
                    indexingSettings: 
                    scriptSettings: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: NotScheduled
                      dailyScheduleSettings: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings: 
                      retrySettings:
                        enabled: false
                        retryTimes: 3
                        waitTimeoutMinutes: 10
                      backupHealthCheckScheduleSettings: 
                    applicationAwareProcessingSettings: 
                    gfsRetentionSettings: 
                  type: Provider
                  accessMode: Public
                  createdBy: Alpha
                  modifiedDate: '2025-07-24T07:26:21.8963094+02:00'
                  companies: [ ]
                  agents: [ ]
                  locations: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  /configuration/backupPolicies/mac:
    get:
      tags:
        - Preview Operations
      summary: Get All Policies for Mac Computers
      description: Returns a collection resource representation of all backup policies configured for Mac computers.
      operationId: GetMacBackupPolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MacBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0acc4945-3b5d-44aa-b63c-8171a97ab63d
                    id: 5
                    organizationUid: e8b7c1af-3cea-4571-b70e-7bc59c244c44
                    name: Mac workstation - Users directory
                    description: This policy processes /Users directory.
                    createSubtenants: true
                    createSubFolders: false
                    unlimitedSubtenantQuota: true
                    repositoryQuotaGb: 
                    operationMode: Workstation
                    jobConfiguration:
                      backupSource:
                        backupDirectlyFromLiveFileSystem: true
                        includeUsbDrives: false
                        includeDirectories: 
                        inclusionMasks: 
                        excludeDirectories: 
                        exclusionMasks: 
                        personalFilesAdvancedSettings:
                          inclusions:
                            - Desktop
                            - Documents
                            - Downloads
                            - Video
                            - Music
                            - Pictures
                            - Favorites
                            - ApplicationData
                            - OtherFilesAndFolders
                            - Library
                          excludeNetworkAccount: true
                      backupTarget:
                        targetType: CloudRepository
                        localPath: 
                        sharedFolder: 
                        backupRepository: 
                        enableDeletedFilesRetention: false
                        removeDeletedItemsDataAfter: 30
                      backupStorage:
                        compressionLevel: Optimal
                        blockSize: Local1Mb
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                      retentionSettings:
                        restorePointsCount: 7
                      scheduleSettings:
                        scheduleType: Daily
                        dailyScheduleSettings:
                          time: '2025-09-09T00:30:00.0000000+02:00'
                          dailyMode: Everyday
                          specificDays: 
                        monthlyScheduleSettings: 
                        periodicallyScheduleSettings: 
                        activeFullSettings:
                          scheduleType: NotScheduled
                          monthly: 
                          weeklyOnDays: 
                        retrySettings: 
                        backupHealthCheckScheduleSettings: 
                      gfsRetentionSettings: 
                    accessMode: Public
                    createdBy: My Company
                    modifiedDate: '2025-08-04T08:53:22.8200000+02:00'
                    companies: [ ]
                    agents: [ ]
                    locations: [ ]
                  - instanceUid: e079e065-3e62-4857-af5d-c00100b55e9a
                    id: 6
                    organizationUid: 3c02d82e-ac77-49a5-97fc-582c642e8bfd
                    name: Mac server - Entire computer
                    description: 'This policy should be used if you want to create a backup of the entire Mac computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                    createSubtenants: true
                    createSubFolders: false
                    unlimitedSubtenantQuota: true
                    repositoryQuotaGb: 
                    operationMode: Server
                    jobConfiguration:
                      backupSource:
                        backupDirectlyFromLiveFileSystem: true
                        includeUsbDrives: false
                        includeDirectories:
                          - /
                        inclusionMasks: 
                        excludeDirectories: 
                        exclusionMasks: 
                        personalFilesAdvancedSettings: 
                      backupTarget:
                        targetType: CloudRepository
                        localPath: 
                        sharedFolder: 
                        backupRepository: 
                        enableDeletedFilesRetention: false
                        removeDeletedItemsDataAfter: 30
                      backupStorage:
                        compressionLevel: Optimal
                        blockSize: Local1Mb
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                      retentionSettings:
                        restorePointsCount: 7
                      scheduleSettings:
                        scheduleType: Daily
                        dailyScheduleSettings:
                          time: '2025-09-09T00:30:00.0000000+02:00'
                          dailyMode: Everyday
                          specificDays: 
                        monthlyScheduleSettings: 
                        periodicallyScheduleSettings: 
                        activeFullSettings:
                          scheduleType: NotScheduled
                          monthly: 
                          weeklyOnDays: 
                        retrySettings:
                          enabled: true
                          retryTimes: 3
                          waitTimeoutMinutes: 10
                        backupHealthCheckScheduleSettings: 
                      gfsRetentionSettings: 
                    accessMode: Public
                    createdBy: My Company
                    modifiedDate: '2025-08-04T08:53:22.8370000+02:00'
                    companies: [ ]
                    agents: [ ]
                    locations: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Preview Operations
      summary: Create Backup Policy for Mac Computers
      description: Creates a backup policy for Mac computers.
      operationId: CreateMacBackupPolicy
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Backup policy properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MacBackupPolicyInput'
            example:
              name: Mac workstation - Users directory
              description: This policy processes /Users directory.
              operationMode: Server
              accessMode: Public
              createSubtenants: true
              unlimitedSubtenantQuota: false
              repositoryQuotaGB: 100
              jobConfiguration:
                backupSource:
                  backupDirectlyFromLiveFileSystem: true
                  includeUsbDrives: false
                  includeDirectories: 
                  inclusionMasks: 
                  excludeDirectories: 
                  exclusionMasks: 
                  personalFilesAdvancedSettings:
                    inclusions:
                      - Desktop
                      - Documents
                      - Downloads
                      - Video
                      - Music
                      - Pictures
                      - Favorites
                      - ApplicationData
                      - OtherFilesAndFolders
                      - Library
                    excludeNetworkAccount: true
                backupTarget:
                  targetType: CloudRepository
                  localPath: 
                  sharedFolder: 
                  backupRepository: 
                  enableDeletedFilesRetention: false
                  removeDeletedItemsDataAfter: 30
                backupStorage:
                  compressionLevel: Optimal
                  blockSize: Local1MB
                  encryptionEnabled: false
                  password: 
                  passwordHint: 
                retentionSettings:
                  restorePointsCount: 7
                scheduleSettings:
                  scheduleType: Daily
                  dailyScheduleSettings:
                    time: '2025-09-09T00:30:00.0000000+02:00'
                    dailyMode: Everyday
                    specificDays: 
                  monthlyScheduleSettings: 
                  periodicallyScheduleSettings: 
                  activeFullSettings: 
                  retrySettings:
                    enabled: false
                    retryTimes: 3
                    waitTimeoutMinutes: 10
                  backupHealthCheckScheduleSettings: 
                gfsRetentionSettings: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/MacBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 75cb17a5-65e1-4ce7-8fab-649c4f64f868
                  id: 5
                  organizationUid: 8ca4e1bf-2e12-4895-b1f2-dba1baa85838
                  name: Mac workstation - Users directory
                  description: This policy processes /Users directory.
                  createSubtenants: true
                  createSubFolders: false
                  unlimitedSubtenantQuota: true
                  repositoryQuotaGb: 
                  operationMode: Workstation
                  jobConfiguration:
                    backupSource:
                      backupDirectlyFromLiveFileSystem: true
                      includeUsbDrives: false
                      includeDirectories: 
                      inclusionMasks: 
                      excludeDirectories: 
                      exclusionMasks: 
                      personalFilesAdvancedSettings:
                        inclusions:
                          - Desktop
                          - Documents
                          - Downloads
                          - Video
                          - Music
                          - Pictures
                          - Favorites
                          - ApplicationData
                          - OtherFilesAndFolders
                          - Library
                        excludeNetworkAccount: true
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local1Mb
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings:
                        scheduleType: NotScheduled
                        monthly: 
                        weeklyOnDays: 
                      retrySettings: 
                      backupHealthCheckScheduleSettings: 
                    gfsRetentionSettings: 
                  accessMode: Public
                  createdBy: My Company
                  modifiedDate: '2025-07-28T11:19:27.8670000+02:00'
                  companies: [ ]
                  agents: [ ]
                  locations: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  '/configuration/backupPolicies/windows/{policyUid}':
    get:
      tags:
        - Backup Policies
      summary: Get Backup Policy for Windows Computers
      description: Returns a resource representation of a Windows computer backup policy with the specified UID.
      operationId: GetWindowsBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: ecf34047-f392-4178-a7a3-dd1c622476cf
                  id: 1
                  organizationUid: 402d60f2-c2e3-4bb9-96d5-324f3d340674
                  name: Windows workstation - Personal files
                  description: This policy processes user profile folder including all user settings and data.
                  createSubtenants: true
                  createSubFolders: false
                  unlimitedSubtenantQuota: true
                  repositoryQuotaGb: 
                  operationMode: Workstation
                  jobConfiguration:
                    backupSource:
                      backupMode: FilesFolders
                      computerLevelOptions: 
                      volumeLevelOptions: 
                      fileLevelOptions:
                        includeDirectories: 
                        excludeDirectories: 
                        inclusionMasks: 
                        exclusionMasks: 
                        osfilesIncluded: false
                        excludeOneDriveFolders: false
                        personalFilesIncluded: true
                        personalFilesAdvancedSettings:
                          inclusions:
                            - Desktop
                            - Documents
                            - Pictures
                            - Video
                            - Music
                            - Favorites
                            - Downloads
                            - ApplicationData
                            - OtherFilesAndFolders
                          excludeNetworkAccount: false
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      cloudRepository: 
                    serverModeSettings: 
                    workstationModeSettings:
                      scheduleSetting:
                        periodicalScheduleEnabled: true
                        periodicalScheduleSettings:
                          dailyScheduleSettings:
                            time: '2025-09-09T00:30:00.0000000+02:00'
                            dailyMode: Everyday
                            specificDays: 
                          shutdownAction: BackupOncePoweredOn
                          finalizingAction: KeepRunning
                        eventTriggerSettings:
                          backupOnLock: false
                          backupOnLogOff: false
                          backupOnTargetConnection: false
                          ejectTargetOnBackupComplete: false
                          backupNotOften: 2
                          notOftenTimeUnit: Hours
                      retentionSettings:
                        retentionDays: 7
                    advancedSettings:
                      backupStorage:
                        compressionLevel: Optimal
                        storageOptimization: Lan512KB
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                      scheduleSettings:
                        syntheticFullOnDays: 
                        activeFullSettings: 
                      maintenanceSettings:
                        backupHealthCheckSettings: 
                        fullBackupFileMaintenanceSettings:
                          enableDeletedFilesRetention: false
                          removeDeletedItemsDataAfter: 30
                          defragmentAndCompactFullBackupFileSettings: 
                        fullHealthCheck: false
                    gfsRetentionSettings: 
                  type: Predefined
                  accessMode: Public
                  createdBy: My Company
                  modifiedDate: '2025-07-18T02:45:19.0500000+02:00'
                  companies:
                    - 2442dfe5-4ca8-476b-b59e-8e5b7b0cc149
                    - d94782b7-42c1-4619-b21b-0e2fee8e2d30
                    - 906e1f39-e271-4c42-8a5d-bceecdb32db6
                  agents:
                    - c3fdce33-3083-4b2a-b8c4-33d0aa425586
                    - a7ddf8b1-72a2-4d83-8825-a565c54653ba
                    - 6de16052-84ab-4410-9b6e-4fcad333fbac
                    - 86cf186b-27fe-46d0-a2ad-d6953820e111
                    - 18a00066-5ecc-4b01-9c49-e12e429fa5ec
                  locations:
                    - 3c8b7db9-11d6-4634-bdc9-0502317ea8e4
                    - 714211f8-288c-4eff-94e5-5959519b0ad5
                    - 7342a9a5-8b78-45da-896b-3080fc22fdf5
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/WindowsBackupPolicy'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Backup Policies
      summary: Modify Backup Policy for Windows Computers
      description: Modifies a Windows computer backup policy with the specified UID.
      operationId: PatchWindowsBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 
                path: /jobconfiguration/backuptarget/cloudrepository
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 63d71674-76ed-4701-9426-e5c9403a37c2
                  id: 18
                  organizationUid: 8f54f378-f79b-4924-a67b-8a10a3a6737c
                  name: WWrkstEntireCloud
                  description: ''
                  createSubtenants: true
                  createSubFolders: false
                  unlimitedSubtenantQuota: false
                  repositoryQuotaGb: 100
                  operationMode: Workstation
                  jobConfiguration:
                    backupSource:
                      backupMode: EntireComputer
                      computerLevelOptions:
                        includeUsbDrives: false
                      volumeLevelOptions: 
                      fileLevelOptions: 
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      cloudRepository: 
                    serverModeSettings:
                      retentionSettings:
                        retentionMode: RestorePoints
                        retentionCount: 7
                      scheduleSetting:
                        scheduleType: Daily
                        dailyScheduleSettings:
                          time: '2025-09-09T00:30:00.0000000+02:00'
                          dailyMode: Everyday
                          specificDays: 
                        monthlyScheduleSettings: 
                        periodicalScheduleSettings: 
                        continuousScheduleSettings: 
                        retrySettings:
                          enabled: true
                          retryTimes: 3
                          waitTimeoutMinutes: 10
                        backupWindow: 
                      indexingSettings: 
                      applicationAwareProcessingSettings:
                        enabled: false
                        transactionLogProcessingMode: ProcessTransactionLogsWithJob
                        sqlServerTransactionLogHandlingSettings: 
                        oracleTransactionLogHandlingSettings: 
                        sharePointAccountSettings: 
                        scriptSettings: 
                    workstationModeSettings: 
                    advancedSettings:
                      backupStorage:
                        compressionLevel: Optimal
                        storageOptimization: Local1MB
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                      scheduleSettings:
                        syntheticFullOnDays: 
                        activeFullSettings: 
                      maintenanceSettings:
                        backupHealthCheckSettings: 
                        fullBackupFileMaintenanceSettings:
                          enableDeletedFilesRetention: false
                          removeDeletedItemsDataAfter: 30
                          defragmentAndCompactFullBackupFileSettings: 
                        fullHealthCheck: false
                    gfsRetentionSettings: 
                  type: Provider
                  accessMode: Public
                  createdBy: Alpha
                  modifiedDate: '2025-07-24T07:26:22.7291470+02:00'
                  companies: [ ]
                  agents: [ ]
                  locations: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/WindowsBackupPolicy'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  '/configuration/backupPolicies/linux/{policyUid}':
    get:
      tags:
        - Backup Policies
      summary: Get Backup Policy for Linux Computers
      description: Returns a resource representation of a Linux computer backup policy with the specified UID.
      operationId: GetLinuxBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d6c8d3e8-6788-4536-a974-664f0635777f
                  id: 3
                  organizationUid: ea24ac4f-1b96-4764-af36-3ddaa4915432
                  name: Linux workstation - Home directory
                  description: This policy processes /home directory.
                  createSubtenants: true
                  unlimitedSubtenantQuota: true
                  repositoryQuotaGB: 
                  operationMode: Workstation
                  jobConfiguration:
                    backupSource:
                      backupMode: FilesFolders
                      volumeLevelOptions: 
                      fileLevelOptions:
                        directories:
                          - /home
                        inclusionMasks: 
                        exclusionMasks: 
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local1MB
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                      isSnapshotRequired: true
                    indexingSettings:
                      indexingType: None
                      includedFolders: 
                      excludedFolders:
                        - /cdrom
                        - /dev
                        - /media
                        - /mnt
                        - /proc
                        - /tmp
                        - /lost+found
                    scriptSettings:
                      enabled: false
                      preJobScript: 
                      postJobScript: 
                      preFreezeScript: 
                      postThawScript: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings:
                        scheduleType: NotScheduled
                        monthly: 
                        weeklyOnDays: 
                      retrySettings: 
                      backupHealthCheckScheduleSettings: 
                    applicationAwareProcessingSettings:
                      oracleAapSettings:
                        processingType: DisableProcess
                        credentials: 
                        truncationConfig:
                          truncationMode: TruncateDisabled
                          sizeGB: 10
                          lifeTimeHours: 24
                        useOracleCredentials: true
                      mySqlAapSettings:
                        processingType: DisableProcess
                        credentials: 
                        authType: MySQLPassword
                        passwordFilePath: 
                      postgreSqlAapSettings:
                        processingType: DisableProcess
                        credentials: 
                        authType: PSQLPassword
                    gfsRetentionSettings: 
                  type: Predefined
                  accessMode: Public
                  createdBy: My Company
                  modifiedDate: '2025-07-18T02:45:19.1600000+02:00'
                  companies: [ ]
                  agents: [ ]
                  locations: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/LinuxBackupPolicy'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Backup Policies
      summary: Modify Backup Policy for Linux Computers
      description: Modifies a Linux computer backup policy with the specified UID.
      operationId: PatchLinuxBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: CloudRepository
                path: /jobconfiguration/backuptarget/targettype
                op: replace
        required: true
      responses:
        '200':
          description: Modified backup policy.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 00e8481d-d872-428b-835f-bff07716bb21
                  id: 17
                  organizationUid: 8f54f378-f79b-4924-a67b-8a10a3a6737c
                  name: LinuxSrvEntireCloud
                  description: ''
                  createSubtenants: true
                  unlimitedSubtenantQuota: false
                  repositoryQuotaGB: 100
                  operationMode: Server
                  jobConfiguration:
                    backupSource:
                      backupMode: EntireComputer
                      volumeLevelOptions: 
                      fileLevelOptions: 
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local1MB
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                      isSnapshotRequired: true
                    indexingSettings: 
                    scriptSettings: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: NotScheduled
                      dailyScheduleSettings: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings: 
                      retrySettings:
                        enabled: false
                        retryTimes: 3
                        waitTimeoutMinutes: 10
                      backupHealthCheckScheduleSettings: 
                    applicationAwareProcessingSettings: 
                    gfsRetentionSettings: 
                  type: Provider
                  accessMode: Public
                  createdBy: Alpha
                  modifiedDate: '2025-07-24T07:26:21.8963094+02:00'
                  companies: [ ]
                  agents: [ ]
                  locations: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/LinuxBackupPolicy'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  '/configuration/backupPolicies/mac/{policyUid}':
    get:
      tags:
        - Preview Operations
      summary: Get Backup Policy for Mac Computers
      description: Returns a resource representation of a Mac computer backup policy with the specified UID.
      operationId: GetMacBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/MacBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 9e2bdc26-40d3-4a8a-a5ed-3bbcc8d65dd4
                  id: 5
                  organizationUid: 931d4e26-f592-4d14-89ef-5b96e3cc6dc5
                  name: Mac workstation - Users directory
                  description: This policy processes /Users directory.
                  createSubtenants: true
                  createSubFolders: false
                  unlimitedSubtenantQuota: true
                  repositoryQuotaGb: 
                  operationMode: Workstation
                  jobConfiguration:
                    backupSource:
                      backupDirectlyFromLiveFileSystem: true
                      includeUsbDrives: false
                      includeDirectories: 
                      inclusionMasks: 
                      excludeDirectories: 
                      exclusionMasks: 
                      personalFilesAdvancedSettings:
                        inclusions:
                          - Desktop
                          - Documents
                          - Downloads
                          - Video
                          - Music
                          - Pictures
                          - Favorites
                          - ApplicationData
                          - OtherFilesAndFolders
                          - Library
                        excludeNetworkAccount: true
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local1Mb
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings:
                        scheduleType: NotScheduled
                        monthly: 
                        weeklyOnDays: 
                      retrySettings: 
                      backupHealthCheckScheduleSettings: 
                    gfsRetentionSettings: 
                  accessMode: Public
                  createdBy: My Company
                  modifiedDate: '2025-08-04T08:53:22.8200000+02:00'
                  companies: [ ]
                  agents: [ ]
                  locations: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/MacBackupPolicy'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Preview Operations
      summary: Modify Backup Policy for Mac Computers
      description: Modifies a Mac computer backup policy with the specified UID.
      operationId: PatchMacBackupPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: CloudRepository
                path: /jobconfiguration/backuptarget/targettype
                op: replace
        required: true
      responses:
        '200':
          description: Modified backup policy.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/MacBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 75cb17a5-65e1-4ce7-8fab-649c4f64f868
                  id: 5
                  organizationUid: 8ca4e1bf-2e12-4895-b1f2-dba1baa85838
                  name: Mac workstation - Users directory
                  description: This policy processes /Users directory.
                  createSubtenants: true
                  createSubFolders: false
                  unlimitedSubtenantQuota: true
                  repositoryQuotaGb: 
                  operationMode: Workstation
                  jobConfiguration:
                    backupSource:
                      backupDirectlyFromLiveFileSystem: true
                      includeUsbDrives: false
                      includeDirectories: 
                      inclusionMasks: 
                      excludeDirectories: 
                      exclusionMasks: 
                      personalFilesAdvancedSettings:
                        inclusions:
                          - Desktop
                          - Documents
                          - Downloads
                          - Video
                          - Music
                          - Pictures
                          - Favorites
                          - ApplicationData
                          - OtherFilesAndFolders
                          - Library
                        excludeNetworkAccount: true
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local1Mb
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings:
                        scheduleType: NotScheduled
                        monthly: 
                        weeklyOnDays: 
                      retrySettings: 
                      backupHealthCheckScheduleSettings: 
                    gfsRetentionSettings: 
                  accessMode: Public
                  createdBy: My Company
                  modifiedDate: '2025-07-28T11:19:27.8670000+02:00'
                  companies: [ ]
                  agents: [ ]
                  locations: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/MacBackupPolicy'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  /organizations/containers:
    get:
      tags:
        - Containers
      summary: Get All Containers
      description: Returns a collection resource representation of all organization containers.
      operationId: GetOrgContainers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrgContainer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e4c58977-2b42-4995-8e34-1836237d1783
                    name: Managed Companies
                    type: DefaultCompanies
                    childrenOrganizations:
                      - 566ef568-4044-4c91-95fa-e2d4f98d3dec
                      - f3387d08-1380-4cb8-9cdb-5e01420bb260
                      - d0f80b1b-1f53-4803-94eb-15ed1ebf9d75
                      - ece6d725-2fc2-48e6-af85-b78b3778b63c
                      - ada1a61e-caaf-4352-85ef-fae903037163
                      - e48d3862-28d7-4a23-99c6-c507a1a8f35a
                    childrenContainers: [ ]
                  - instanceUid: 0288aaef-01b6-42c4-8a3d-9c690bfb2938
                    name: Resellers
                    type: DefaultResellers
                    childrenOrganizations:
                      - 4e66bccf-9c1e-4138-84ff-572c59a796cf
                      - 1b2a8ffc-4d4f-45e8-b3dc-7fe2ff2bdb9f
                      - e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    childrenContainers: [ ]
                  - instanceUid: 8b1ef0fa-8ef7-45c7-840e-0c896dd792fa
                    name: Mercury Container
                    type: Custom
                    childrenOrganizations:
                      - 5b78a306-6ee3-4889-9217-ef2ce5731729
                    childrenContainers: [ ]
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    post:
      tags:
        - Containers
      summary: Create Container
      description: Creates a new organization container with specific properties.
      operationId: CreateOrgContainer
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Container properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrgContainerInput'
            example:
              name: Container1
              childrenOrganizations:
                - 4e66bccf-9c1e-4138-84ff-572c59a796da
              childrenContainers: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/OrgContainer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 2718e76f-1c23-491f-ab7e-7f754fdfbdc5
                  name: Container1
                  type: Custom
                  childrenOrganizations:
                    - 4e66bccf-9c1e-4138-84ff-572c59a796da
                  childrenContainers: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/containers/{containerUid}':
    get:
      tags:
        - Containers
      summary: Get Container
      description: Returns a resource representation of an organization container with the specified UID.
      operationId: GetOrgContainer
      parameters:
        - name: containerUid
          in: path
          description: Container UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/OrgContainer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 8b1ef0fa-8ef7-45c7-840e-0c896dd792fa
                  name: Mercury Container
                  type: Custom
                  childrenOrganizations:
                    - 5b78a306-6ee3-4889-9217-ef2ce5731729
                  childrenContainers: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/OrgContainer'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    patch:
      tags:
        - Containers
      summary: Modify Container
      description: Modifies an organization container with the specified UID.
      operationId: PatchOrgContainer
      parameters:
        - name: containerUid
          in: path
          description: Container UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Container1_modified
                path: /name
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/OrgContainer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 8b1ef0fa-8ef7-45c7-840e-0c896dd792fa
                  name: Container1_modified
                  type: Custom
                  childrenOrganizations:
                    - 5b78a306-6ee3-4889-9217-ef2ce5731729
                  childrenContainers: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/OrgContainer'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Containers
      summary: Delete Container
      description: Deletes an organization container with the specified UID.
      operationId: DeleteOrgContainer
      parameters:
        - name: containerUid
          in: path
          description: Container UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: Container has been deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers:
    get:
      tags:
        - Resellers
      summary: Get All Resellers
      description: Returns a collection resource representation of all resellers.
      operationId: GetResellers
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ResellerExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Reseller'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 2442dfe5-4ca8-476b-b59e-8e5b7b0cc149
                    proPartnerId: 
                    name: ActLogReseller
                    status: Active
                    isRestAccessEnabled: true
                    resellerServices:
                      hostedServices:
                        backupResourcesEnabled: false
                        vb365ManagementEnabled: false
                        vbPublicCloudManagementEnabled: false
                      remoteServices:
                        backupAgentsManagement:
                          workstationAgentsQuota: 
                          serverAgentsQuota: 
                        vb365ManagementEnabled: false
                        backupServersManagementEnabled: false
                        vbPublicCloudManagementEnabled: false
                      cloudConnectQuota:
                        dataTransferOutQuota: 
                        insiderProtectionQuota: 
                        throttlingValue: 
                        throttlingUnit: 
                        maxConcurrentTask: 
                        isWanAccelerationEnabled: false
                      cloudConnectManagementEnabled: false
                      isFileLevelRestoreEnabled: false
                    _embedded:
                      organization: 
                  - instanceUid: 906e1f39-e271-4c42-8a5d-bceecdb32db6
                    proPartnerId: 
                    name: AccReseller
                    status: Active
                    isRestAccessEnabled: true
                    resellerServices:
                      hostedServices:
                        backupResourcesEnabled: false
                        vb365ManagementEnabled: false
                        vbPublicCloudManagementEnabled: false
                      remoteServices:
                        backupAgentsManagement:
                          workstationAgentsQuota: 
                          serverAgentsQuota: 
                        vb365ManagementEnabled: false
                        backupServersManagementEnabled: false
                        vbPublicCloudManagementEnabled: false
                      cloudConnectQuota:
                        dataTransferOutQuota: 
                        insiderProtectionQuota: 
                        throttlingValue: 
                        throttlingUnit: 
                        maxConcurrentTask: 
                        isWanAccelerationEnabled: false
                      cloudConnectManagementEnabled: false
                      isFileLevelRestoreEnabled: false
                    _embedded:
                      organization: 
                  - instanceUid: c3fdce33-3083-4b2a-b8c4-33d0aa425586
                    proPartnerId: 
                    name: PhiladelphiaReseller
                    status: Active
                    isRestAccessEnabled: true
                    resellerServices:
                      hostedServices:
                        backupResourcesEnabled: false
                        vb365ManagementEnabled: false
                        vbPublicCloudManagementEnabled: false
                      remoteServices:
                        backupAgentsManagement:
                          workstationAgentsQuota: 51
                          serverAgentsQuota: 5
                        vb365ManagementEnabled: false
                        backupServersManagementEnabled: true
                        vbPublicCloudManagementEnabled: false
                      cloudConnectQuota:
                        dataTransferOutQuota: 
                        insiderProtectionQuota: 20
                        throttlingValue: 
                        throttlingUnit: 
                        maxConcurrentTask: 
                        isWanAccelerationEnabled: false
                      cloudConnectManagementEnabled: false
                      isFileLevelRestoreEnabled: false
                    _embedded:
                      organization: 
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Resellers
      summary: Create Reseller
      description: Creates a new reseller with specific properties.
      operationId: CreateReseller
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Reseller properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResellerInput'
            example:
              description: 
              proPartnerId: 
              organizationInput:
                name: Atrium Solutions
                alias: atrium
                taxId: '34598'
                email: d.baker@atriumsol.com
                phone: 606-932-3427
                country: 1
                state: 38
                countryName: USA
                regionName: 
                city: South Shore
                street: 464 Hinkle Deegan Lake Road
                locationAdmin0Code: us
                locationAdmin1Code: us-ma
                locationAdmin2Code: 
                notes: Basic configuration
                zipCode: '41175'
                website: www.atriumsol.com
                veeamTenantId: '11'
                companyId: 
              resellerServices:
                hostedServices:
                  backupResourcesEnabled: false
                  vb365ManagementEnabled: false
                  vbPublicCloudManagementEnabled: false
                remoteServices:
                  backupAgentsManagement:
                    workstationAgentsQuota: 
                    serverAgentsQuota: 
                  vb365ManagementEnabled: false
                  backupServersManagementEnabled: false
                  vbPublicCloudManagementEnabled: false
                cloudConnectQuota: 
                cloudConnectManagementEnabled: false
                isFileLevelRestoreEnabled: false
              ownerCredentials:
                userName: ResVcdExternalOwner
                password: Password1
              isRestAccessEnabled: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Reseller'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: ec53826f-1e2f-48cf-a93c-1189d7570912
                  proPartnerId: 
                  name: Atrium Solutions
                  status: Active
                  isRestAccessEnabled: true
                  resellerServices:
                    hostedServices:
                      backupResourcesEnabled: false
                      vb365ManagementEnabled: false
                      vbPublicCloudManagementEnabled: false
                    remoteServices:
                      backupAgentsManagement:
                        workstationAgentsQuota: 
                        serverAgentsQuota: 
                      vb365ManagementEnabled: false
                      backupServersManagementEnabled: false
                      vbPublicCloudManagementEnabled: false
                    cloudConnectQuota: 
                    cloudConnectManagementEnabled: false
                    isFileLevelRestoreEnabled: false
                  _embedded:
                    organization: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/identityProviders:
    get:
      tags:
        - Single Sign On
      summary: Get All Identity Providers
      description: Returns a collection resource representation of all identity providers.
      operationId: GetIdentityProviders
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IdentityProviderSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - name: MacRes
                    displayName: MacRes
                    template: Keycloak
                    type: SAML2
                    configurationValidationSucceeded: true
                    errorMessage: 
                    configuration:
                      entityId: MacRes
                      returnUrl: https://vspc1.tech.local:1280/Saml2/MacRes/
                      modulePath: Saml2/MacRes/
                      authenticateRequestSigningBehavior: IfIdpWantAuthnRequestsSigned
                      outboundSigningAlgorithm: RsaSha256
                      minIncomingSigningAlgorithm: RsaSha256
                      validateCertificates: 
                      publicOrigin: 
                      requestedAuthnContext:
                        classRef: Password
                        comparison: Exact
                      metadata:
                        cacheDuration: PT1H
                        validDuration: 7.12:00:00
                        wantAssertionsSigned: true
                        organization:
                          name: MacRes
                          displayName: MacRes
                          url: https://vspc1.tech.local:1280
                          language: en
                        contactPerson:
                          type: Other
                          company: 
                          givenName: 
                          surname: 
                          phoneNumber: 
                          email: ''
                        requestedAttributes:
                          - name: Minimal
                            friendlyName: 
                            nameFormat: 
                            isRequired: 
                      identityProviders:
                        - entityId: http://keycloak.tech.local:8080/auth/realms/master
                          signOnUrl: 
                          wantAuthnRequestsSigned: 
                          binding: 
                          allowUnsolicitedAuthnResponse: true
                          loadMetadata: true
                          outboundSigningAlgorithm: 
                          metadataLocation: http://keycloak.tech.local:8080/auth/realms/master/protocol/saml/descriptor
                      serviceCertificates:
                        - use: Both
                          status: Current
                          privateKeyContent: 
                          certificateThumbprint: 4D55401A6BE5D2B5098A3FC8C782B47DCA56C3E5
                          storeName: My
                          storeLocation: LocalMachine
                          x509FindType: FindByThumbprint
                          metadataPublishOverride: 
                      compatibility:
                        ignoreMissingInResponseTo: true
                        ignoreAuthenticationContextInResponse: 
                        unpackEntitiesDescriptorInIdentityProviderMetadata: true
                    rulesCount: 0
                    configurationCompleted: true
                    enabled: true
                    organizationUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                  - name: MyCompanyIdP
                    displayName: MyCompanyIdP
                    template: Keycloak
                    type: SAML2
                    configurationValidationSucceeded: true
                    errorMessage: 
                    configuration:
                      entityId: MyCompanyIdP
                      returnUrl: https://vspc1.tech.local:1280/Saml2/MyCompanyIdP/
                      modulePath: Saml2/MyCompanyIdP/
                      authenticateRequestSigningBehavior: IfIdpWantAuthnRequestsSigned
                      outboundSigningAlgorithm: RsaSha256
                      minIncomingSigningAlgorithm: RsaSha256
                      validateCertificates: 
                      publicOrigin: 
                      requestedAuthnContext:
                        classRef: Password
                        comparison: Exact
                      metadata:
                        cacheDuration: PT1H
                        validDuration: 7.12:00:00
                        wantAssertionsSigned: true
                        organization:
                          name: MyCompanyIdP
                          displayName: MyCompanyIdP
                          url: https://vspc1.tech.local:1280
                          language: en
                        contactPerson:
                          type: Other
                          company: 
                          givenName: 
                          surname: 
                          phoneNumber: 
                          email: ''
                        requestedAttributes:
                          - name: Minimal
                            friendlyName: 
                            nameFormat: 
                            isRequired: 
                      identityProviders:
                        - entityId: http://vspc1.tech.local:8080/auth/realms/master
                          signOnUrl: 
                          wantAuthnRequestsSigned: 
                          binding: 
                          allowUnsolicitedAuthnResponse: true
                          loadMetadata: true
                          outboundSigningAlgorithm: 
                          metadataLocation: http://keycloak.tech.local:8080/auth/realms/master/protocol/saml/descriptor
                      serviceCertificates:
                        - use: Both
                          status: Current
                          privateKeyContent: 
                          certificateThumbprint: EA63EE71DE5E297DBE49C1B307B210E732A95FG1
                          storeName: My
                          storeLocation: LocalMachine
                          x509FindType: FindByThumbprint
                          metadataPublishOverride: 
                      compatibility:
                        ignoreMissingInResponseTo: true
                        ignoreAuthenticationContextInResponse: 
                        unpackEntitiesDescriptorInIdentityProviderMetadata: true
                    rulesCount: 0
                    configurationCompleted: true
                    enabled: true
                    organizationUid: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  /organizations/identityProviders/name:
    post:
      tags:
        - Single Sign On
      summary: Check Uniqueness of Identity Provider Name.
      description: Checks whether the specified name of an identity provider is unique.
      operationId: CheckUniquenessForIdentityProviderName
      parameters:
        - name: name
          in: query
          description: Identity provider name.
          required: true
          schema:
            maxLength: 32
            minLength: 5
            pattern: '^[\._a-zA-Z0-9]+$'
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: The `true` value indicates that the identity provider name is unique. The `false` value insicates that the identity provider name is already taken.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: boolean
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/identityProviders':
    get:
      tags:
        - Single Sign On
      summary: Get All Identity Providers of Organization
      description: Returns a collection resource representation of all identity providers managing user identities of an organization with the specified UID.
      operationId: GetOrganizationIdentityProviders
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IdentityProviderSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - name: MacRes
                    displayName: MacRes
                    template: Keycloak
                    type: SAML2
                    configurationValidationSucceeded: true
                    errorMessage: 
                    configuration:
                      entityId: MacRes
                      returnUrl: https://vspc1.tech.local:1280/Saml2/MacRes/
                      modulePath: Saml2/MacRes/
                      authenticateRequestSigningBehavior: IfIdpWantAuthnRequestsSigned
                      outboundSigningAlgorithm: RsaSha256
                      minIncomingSigningAlgorithm: RsaSha256
                      validateCertificates: 
                      publicOrigin: 
                      requestedAuthnContext:
                        classRef: Password
                        comparison: Exact
                      metadata:
                        cacheDuration: PT1H
                        validDuration: 7.12:00:00
                        wantAssertionsSigned: true
                        organization:
                          name: MacRes
                          displayName: MacRes
                          url: https://vspc1.tech.local:1280
                          language: en
                        contactPerson:
                          type: Other
                          company: 
                          givenName: 
                          surname: 
                          phoneNumber: 
                          email: ''
                        requestedAttributes:
                          - name: Minimal
                            friendlyName: 
                            nameFormat: 
                            isRequired: 
                      identityProviders:
                        - entityId: http://keycloak.tech.local:8080/auth/realms/master
                          signOnUrl: 
                          wantAuthnRequestsSigned: 
                          binding: 
                          allowUnsolicitedAuthnResponse: true
                          loadMetadata: true
                          outboundSigningAlgorithm: 
                          metadataLocation: http://keycloak.tech.local:8080/auth/realms/master/protocol/saml/descriptor
                      serviceCertificates:
                        - use: Both
                          status: Current
                          privateKeyContent: 
                          certificateThumbprint: 4D55401A6BE5D2B5098A3FC8C782B47DCA56C3E5
                          storeName: My
                          storeLocation: LocalMachine
                          x509FindType: FindByThumbprint
                          metadataPublishOverride: 
                      compatibility:
                        ignoreMissingInResponseTo: true
                        ignoreAuthenticationContextInResponse: 
                        unpackEntitiesDescriptorInIdentityProviderMetadata: true
                    rulesCount: 0
                    configurationCompleted: true
                    enabled: true
                    organizationUid: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
                  - name: MyCompanyIdP
                    displayName: MyCompanyIdP
                    template: Keycloak
                    type: SAML2
                    configurationValidationSucceeded: true
                    errorMessage: 
                    configuration:
                      entityId: MyCompanyIdP
                      returnUrl: https://vspc1.tech.local:1280/Saml2/MyCompanyIdP/
                      modulePath: Saml2/MyCompanyIdP/
                      authenticateRequestSigningBehavior: IfIdpWantAuthnRequestsSigned
                      outboundSigningAlgorithm: RsaSha256
                      minIncomingSigningAlgorithm: RsaSha256
                      validateCertificates: 
                      publicOrigin: 
                      requestedAuthnContext:
                        classRef: Password
                        comparison: Exact
                      metadata:
                        cacheDuration: PT1H
                        validDuration: 7.12:00:00
                        wantAssertionsSigned: true
                        organization:
                          name: MyCompanyIdP
                          displayName: MyCompanyIdP
                          url: https://vspc1.tech.local:1280
                          language: en
                        contactPerson:
                          type: Other
                          company: 
                          givenName: 
                          surname: 
                          phoneNumber: 
                          email: ''
                        requestedAttributes:
                          - name: Minimal
                            friendlyName: 
                            nameFormat: 
                            isRequired: 
                      identityProviders:
                        - entityId: http://vspc1.tech.local:8080/auth/realms/master
                          signOnUrl: 
                          wantAuthnRequestsSigned: 
                          binding: 
                          allowUnsolicitedAuthnResponse: true
                          loadMetadata: true
                          outboundSigningAlgorithm: 
                          metadataLocation: http://keycloak.tech.local:8080/auth/realms/master/protocol/saml/descriptor
                      serviceCertificates:
                        - use: Both
                          status: Current
                          privateKeyContent: 
                          certificateThumbprint: EA63EE71DE5E297DBE49C1B307B210E732A95FG1
                          storeName: My
                          storeLocation: LocalMachine
                          x509FindType: FindByThumbprint
                          metadataPublishOverride: 
                      compatibility:
                        ignoreMissingInResponseTo: true
                        ignoreAuthenticationContextInResponse: 
                        unpackEntitiesDescriptorInIdentityProviderMetadata: true
                    rulesCount: 0
                    configurationCompleted: true
                    enabled: true
                    organizationUid: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/identityProviders/saml2':
    post:
      tags:
        - Single Sign On
      summary: Create SAML2 Identity Provider
      description: "Creates a new SAML2 identity provider.\n> Before you create a new SAML2 identity provider for a company you must generate a company portal URL.\n"
      operationId: CreateSaml2IdentityProvider
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderSettingsInput'
            example:
              name: MyCompany
              displayName: MyCompany
              template: Keycloak
              configuration:
                entityId: MyCompany_remove
                returnUrl: https://vspc1.tech.local:1280/Saml2/MyCompany/
                modulePath: Saml2/MyCompany/
                authenticateRequestSigningBehavior: IfIdpWantAuthnRequestsSigned
                outboundSigningAlgorithm: RsaSha256
                minIncomingSigningAlgorithm: RsaSha256
                validateCertificates: 
                publicOrigin: 
                requestedAuthnContext:
                  classRef: Password
                  comparison: Exact
                metadata:
                  cacheDuration: PT1H
                  validDuration: 7.12:00:00
                  wantAssertionsSigned: true
                  organization:
                    name: MyCompany
                    displayName: MyCompany
                    url: https://vspc1.tech.local:1280
                    language: en
                  contactPerson:
                    type: Other
                    company: 
                    givenName: 
                    surname: 
                    phoneNumber: 
                    email: ''
                  requestedAttributes:
                    - name: Minimal
                      friendlyName: 
                      nameFormat: 
                      isRequired: 
                identityProviders:
                  - entityId: http://keycloak.tech.local:8080/auth/realms/master
                    signOnUrl: 
                    wantAuthnRequestsSigned: 
                    binding: 
                    allowUnsolicitedAuthnResponse: true
                    loadMetadata: true
                    outboundSigningAlgorithm: 
                    metadataLocation: http://keycloak.tech.local:8080/auth/realms/master/protocol/saml/descriptor
                serviceCertificates:
                  - use: Both
                    status: Current
                    privateKeyContent: 'data:application/x-pkcs12;base64,MIIdGhvdWdoaGFsZndheWJhc2lzYW55aGVyc2VsZmV5ZXNwb2tlbnB1c2h0cmlja3NhbGVwZXJzb25hbHdpbGRidXN5YnJlZXplYWRkaXRpb25zZW50cGFya2dvdGFsaWtlcmljaGVnZ2dhaW5hbW9uZ2FsdGhvdWdoYXJlbWl4Y291bGRyZW1hcmthYmxlYnJlYWtmYXN0YnJlYXRoZWJyb2tlcGlua3Bvc3NpYmx5Y2FtZXNhZGRsZXZvd2VscmVhcnRyZWF0ZWR3aGVlbG9yZGVycnVsZXJ0b3VjaHN3ZWV0c2xvd2x5c3ViamVjdG9uZXJhaW5sYWtlbm9yaW52b2x2ZWRjb3VwbGViaWdnZXJwYXJ0aWNsZXNicmlkZ2V3YWl0dGhyb3VnaHNwZWNpZmljYmVuZGZ1cnRoZXJwdXNoYXZvaWRqYXJmaW5pc2hzdW1vZmZpY2VtYXJrZXRtb3VzZXBvbnljb250aW51ZWRyZWNlbnRpY2VsYWNrYmFuZGFueWRlZXBseWRpZmZpY3VsdHRocm91Z2hwbGVudHlkYWlseWFueXdheXNvbHV0aW9ucmV0dXJuZGVwZW5kc2FuZGRvb3JhY3Jvc3NoYXZpbmdzb2xpZHBvbGljZW1hbmNhcnJ5ZXNzZW50aWFsdmFwb3JwYXJ0aWN1bGFybHloaWxsYXJ0ZG96ZW5idWZmYWxvZHJpdmVyb3V0ZXB1bGxnaWFudGd1ZXNzY2FzZWhhcHBpbHlzdXJwcmlzZXNwbGl0bGlrZWx5c2hhbGxydXNocHVwaWxwb3B1bGF0aW9ucmVjb2duaXplcHJvcGVydHlkZWVwZ3JlZW5raXRjaGVud2FzdGVpc2xhbmRtYW51ZmFjdHVyaW5nd2hpc3BlcmVkYmlydGhqdW5nbGVzdG9yeWNvbXBhcmVsZXR0ZXJzZXR0aW5nY2xlYXJ0aGV5dGhyb3d0aHJvdWdob3V0cmVxdWlyZWNhcmVmdWxseW1vdmllcmluZ3NpbWlsYXJ0cmlja2Zsb2F0aW5nd2VyZXVuaW9ucnVubmluZ3JlY29nbml6ZXdoaXRlZGFuZ2Vyb3VzcGVyY2VudGNob29zZW1vc3RlbXB0eWFwcGxpZWRicmVhdGhlc2FuZ21hdGhlbWF0aWNzdW50aWxjaGVja3NpbGx5c3BlbnRtaW5kbGFkeXByaWRlY2Fubm90dG93YXJkcmVndWxhcnVuaW9uYWxvdWRoYWJpdHJpc2luZ2Nsb3RodGVycmlibGVhbHRob3VnaGRpbm5lcmdsYWRjbG90aGluZ2Rpc2hyZWNvcmRvZnRyYWZmaWN0cm9vcHNodXJyaWVkZW52aXJvbm1lbnRob21lY2hhbmdpbmdmdWVsbGF0ZWNob3NlbnRoZW9yeW9sZGVyb2xkZXN0ZmlsbGZpbmFsbmV3c3BhcGVyd29ya2VydmljdG9yeWhvdGRpZmZlcmVudGdyZWF0YWR2ZW50dXJlY2VudHJhbGZhbW91c3BhcnRzdHJlZXRzb2Z0bHlib3JuZmlsbXdlYWx0aGFzbGVlcHBoeXNpY2FsbW91bnRhaW53ZXN0cmVmZXJidWZmYWxvcmVkcmVwbGFjZWFibGVqdXN0Z3JlYXRseWZvbGxvd2FsaXZlaXJvbmV4cHJlc3Npb25wYWxlb2ZmZXJhcnRpY2xlZm9ydHllbGVwaGFudGZhcnRoZXJkcmF3bG93ZXJ1cGZyZXF1ZW50bHlraWRzYnJva2V0cmlja2VzcGVjaWFsbHllbGV2ZW5yb2xsc2luZ3JlYWR5c2xpcHBlZG9yZ2FuaXplZGRvd25sZWFzdG5vd2Zpc2hkb2N0b3Jjb3B5Ym90aHJlcHJlc2VudHNvY2lldHlwb3dkZXJjcmVhbWx1Y2t5Y29udGluZW50bGlwc3N3aW1za2lsbGxpZmVtZWx0ZWRkcmlua3Jhbmdlc3R1ZHlpbmdncmV3ZmFzdGVuZWRzaGFyZWNvbnRhaW5mYWlyaW52b2x2ZWR3b2xmb2JqZWN0bWlsZWJhZGx5cHJhY3RpY2FsaW50b2ZyZXF1ZW50bHl0b3dhcmRkZXRlcm1pbmVuZWFybHlqb3lpbmNvbWVkaWRhbGl2ZWNvbGxlZ2VjaG9vc2VsaXN0ZGlzY3Vzc2hvbGR1bmtub3duc2hvcnRicmVhdGhlYmFsYW5jZW1vc3RicmVlemVhY2NlcHRraWxsd2hpdGVwaHJhc2VhbmdsZWFjdHVhbGJyZWF0aGRvY3RvcnRvd25zY2VuZW1ldGZsYW1lc2hlcm9kcG9saWNlbWFuZm9yZWlnbm1hbm5lcmdyZWF0d2hpdGVvcGluaW9uc29sYXJiZWFyc21va2VyZWFybm9kZGVkcHJpbWl0aXZlc3RhcmVkY29tbXVuaXR5bWFkZWFkamVjdGl2ZWdpcmx3YW50c2FsbW9ubmVlZGxldG9mZWF0dXJleW91cmpvaW5ibG9vZHBhcnRwZXJiaWdnZXJub25lZm91Z2h0d2F2ZWdpZnRmYXJ0aGVyd2F5bWFraW5ncHJlc2VudHdob21hcnJvd3BsZWFzdXJlZnJvZ2Jyb3duZmFjZXF1aWV0bHlza3lzdG9ybXRvZGF5cHJvY2Vzc3BhcmVudGVhZ2VycG9ldHJ5YnJlYWRzaG9ldG9vdGhlZWRyaW5rZ3JlZW5wYWxhY2Vwcm92aWRldXNlZnVsY2xvc2VyaGFzc3RhcnRtYW5jb2FjaGFmdGVybm9vbnBhZ2V0cmllZGZhc3RzdXJmYWNlYnJlYXRobWlycm9ydHJpYmVkcmVzc2JhcnBhcmFsbGVsc3BlZWR0aWV0d29waWdldmVuaW5nbGFpZGNhcnJ5YmVhdHRhc2t0ZWxldmlzaW9uc25vd29jY3Vyd2F0ZXJhcHByb3ByaWF0ZXN3ZWV0d29yZW9mZmVyaGFpcmFtb25nZmFybWVybWFkYWdhaW5zdGRpZmZpY3VsdHl3b29kZW5wYXJ0eW9yZm91Z2h0bmFtZWZlbGxiZWNhbWVmaW5pc2htaXNzaW9uc29saWR0b29mb3J0eWxpZmV0b3dhcmRsdW5jaHNoYWxscHVyZXN0b21hY2hvbGRlc3RiYXNld2VsbHNvbHZlbGFiZWxmZWV0ZWFybGllcmFkZGl0aW9uYWxuZXh0cXVhcnRlcmVpZ2h0bmVhcmJ5bmV2ZXJjYXN0cmVhc29uaXJvbmRlYWxvcHBvc2l0ZWxpcHNyZW1hcmthYmxlcHJpemVuaWdodHN0aWxsZWlnaHRsb2didXN5ZWxsb3dvcGVucmlkaW5nc2ltcGxlbm9zZXN0b25lc3R1ZGVudGNvbnN0YW50bHlmb3JnZXRiZXR0ZXJncmVhdGhpc3RvcnlyZWFsc2lkZXNjYXJyeWZpbGxrbm93bGVkZ2VzdHJvbmdlcmZhY3Rvcmdsb2JlZWF0ZW5taW5lcmFsc2d1bGZraW5kcm9zZWV4cHJlc3Npb25yZWFsaXplbG9va2ZyZWVkdXR5dG9uZ3VlZGVlcGRpc2hiYW5kcmVhcmNoYXJhY3RlcmlzdGljaHVzYmFuZG1pbmVyYWxzcG9uZHBhaW5hcmVhZnJpZW5kY3JlYXRlZnJlc2hyb2NreWF0dGVtcHR5b3VuZ2NvbnZlcnNhdGlvbmtuZXd3aGljaHRocm93Z2lybGNhbm5vdGZsaWVzc291dGhqb3VybmV5aW5kZWVkY29tYmluZXNsZWVwZmVuY2VldmVudHBhdGhiaWxsbG9zZXdvb2xmb3JlaWduaW5kZXBlbmRlbnRiYWxsb29ud2l0aGlub25seXBsZWFzdXJlbWVhdGJpdHNjaWVudGlmaWNkb3dubG93aG90c2hvcnRlcnNsaWdodGx5YWxvbmdzaG91dG1ldGFscmVzdHNvbWV0aGluZ2V4cGVyaWVuY2VzdWNoYXJteXdpbmdyZW1haW5raXRjaGVuc3RyYW5nZXJzb3V0aHJoeXRobXN1cnByaXNlY2hhcmFjdGVyaXN0aWNkaXN0YW5jZXZlcnliZWxvbmdicmVhdGhpbmdhbHJlYWR5YmVsaWV2ZWRoZWFyZHBvc3NpYmxlcG9saWNlc29vbmNvd3NhbmR3YXZlZG96ZW5wZW5yaXNlaGFwcHlzdGF0ZW1lbnRjbGltYnBlcnNvbmVhcm5tb29kYmVjb21pbmdlbmdpbmVuZWdhdGl2ZXNvbWVoYXNtaWxsc2xpZGV3aGVhdGJlZW5pdHNjYWtlb2xkZXJ2aWxsYWdlc2F2ZWRiZWFudGVsZXBob25lYmVpbmdiYWxsY2xvc2VycG9zc2libHljbGltYnN0cnVjdHVyZWZ1cnBhaXJmaWZ0aHNob3Jlc3VubGln'
                    metadataPublishOverride: 
                compatibility:
                  ignoreMissingInResponseTo: true
                  ignoreAuthenticationContextInResponse: 
                  unpackEntitiesDescriptorInIdentityProviderMetadata: true
              configurationCompleted: true
              enabled: true
        required: true
      responses:
        '200':
          description: Resource representation of a created identity provider.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/IdentityProviderSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: MyCompany
                  displayName: MyCompany
                  template: Keycloak
                  type: SAML2
                  configurationValidationSucceeded: true
                  errorMessage: 
                  configuration:
                    entityId: MyCompany_remove
                    returnUrl: https://vspc1.tech.local:1280/Saml2/MyCompany/
                    modulePath: Saml2/MyCompany/
                    authenticateRequestSigningBehavior: IfIdpWantAuthnRequestsSigned
                    outboundSigningAlgorithm: RsaSha256
                    minIncomingSigningAlgorithm: RsaSha256
                    validateCertificates: 
                    publicOrigin: 
                    requestedAuthnContext:
                      classRef: Password
                      comparison: Exact
                    metadata:
                      cacheDuration: PT1H
                      validDuration: 7.12:00:00
                      wantAssertionsSigned: true
                      organization:
                        name: MyCompany
                        displayName: MyCompany_remove
                        url: https://vspc1.tech.local:1280
                        language: en
                      contactPerson:
                        type: Other
                        company: 
                        givenName: 
                        surname: 
                        phoneNumber: 
                        email: ''
                      requestedAttributes:
                        - name: Minimal
                          friendlyName: 
                          nameFormat: 
                          isRequired: 
                    identityProviders:
                      - entityId: http://keycloak.tech.local:8080/auth/realms/master
                        signOnUrl: 
                        wantAuthnRequestsSigned: 
                        binding: 
                        allowUnsolicitedAuthnResponse: true
                        loadMetadata: true
                        outboundSigningAlgorithm: 
                        metadataLocation: http://keycloak.tech.local:8080/auth/realms/master/protocol/saml/descriptor
                    serviceCertificates:
                      - use: Both
                        status: Current
                        privateKeyContent: 
                        certificateThumbprint: 8CF86A67600CC1A564EF256A3C7B90CCEE575B68
                        storeName: My
                        storeLocation: LocalMachine
                        x509FindType: FindByThumbprint
                        metadataPublishOverride: 
                    compatibility:
                      ignoreMissingInResponseTo: true
                      ignoreAuthenticationContextInResponse: 
                      unpackEntitiesDescriptorInIdentityProviderMetadata: true
                  rulesCount: 0
                  configurationCompleted: false
                  enabled: true
                  organizationUid: c5de30c9-0f5a-5140-a0e9-2e95c38f3f62
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codegen-request-body-name: settings
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/identityProviders/rules':
    get:
      tags:
        - Single Sign On
      summary: Get Mapping Rules of All Organization Identity Providers
      description: Returns a collection resource representation of mapping rules configured for all identity providers of an organization with the specified UID.
      operationId: GetOrganizationIdentityProvidersRules
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/IdentityProviderRoleMappingRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IdentityProviderRoleMappingRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                    name: PortalAdministrator
                    providerName: MyCompanyIdP
                    description: PortalAdministrator Keycloak
                    role: PortalAdministrator
                    enabled: true
                    managedCompaniesUids: 
                    manageAllCompanies: true
                    hasAccessToProvider: false
                    organizationMappingSourceClaimType: Company
                    locationsMappingSourceClaimType: 
                    companyTenantMappingClaims: 
                    additionalMappings: [ ]
                    attributeMappings: [ ]
                    _embedded:
                      providerInfo:
                        name: MyCompanyIdP
                        displayName: MyCompanyIdP
                        template: Keycloak
                        type: SAML2
                        organizationUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                        enabled: true
                  - instanceUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                    name: ResellerOwner
                    providerName: MyCompanyIdP
                    description: ResellerOwner Keycloak
                    role: ResellerOwner
                    enabled: true
                    managedCompaniesUids: 
                    manageAllCompanies: true
                    hasAccessToProvider: false
                    organizationMappingSourceClaimType: Company
                    locationsMappingSourceClaimType: 
                    companyTenantMappingClaims: 
                    additionalMappings: [ ]
                    attributeMappings: [ ]
                    _embedded:
                      providerInfo:
                        name: MyCompanyIdP
                        displayName: MyCompanyIdP
                        template: Keycloak
                        type: SAML2
                        organizationUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                        enabled: true
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  /organizations/identityProviders/rules:
    get:
      tags:
        - Single Sign On
      summary: Get All Mapping Rules
      description: Returns a collection resource representation of all mapping rules.
      operationId: GetOrganizationsIdentityProvidersRules
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/IdentityProviderRoleMappingRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IdentityProviderRoleMappingRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                    name: PortalAdministrator
                    providerName: MyCompanyIdP
                    description: PortalAdministrator Keycloak
                    role: PortalAdministrator
                    enabled: true
                    managedCompaniesUids: 
                    manageAllCompanies: true
                    hasAccessToProvider: false
                    organizationMappingSourceClaimType: Company
                    locationsMappingSourceClaimType: 
                    companyTenantMappingClaims: 
                    additionalMappings: [ ]
                    attributeMappings: [ ]
                    _embedded:
                      providerInfo:
                        name: MyCompanyIdP
                        displayName: MyCompanyIdP
                        template: Keycloak
                        type: SAML2
                        organizationUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                        enabled: true
                  - instanceUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                    name: ResellerOwner
                    providerName: MyCompanyIdP
                    description: ResellerOwner Keycloak
                    role: ResellerOwner
                    enabled: true
                    managedCompaniesUids: 
                    manageAllCompanies: true
                    hasAccessToProvider: false
                    organizationMappingSourceClaimType: Company
                    locationsMappingSourceClaimType: 
                    companyTenantMappingClaims: 
                    additionalMappings: [ ]
                    attributeMappings: [ ]
                    _embedded:
                      providerInfo:
                        name: MyCompanyIdP
                        displayName: MyCompanyIdP
                        template: Keycloak
                        type: SAML2
                        organizationUid: cdd60d1c-ad8f-4d22-8b5f-e2c9a6da5bc6
                        enabled: true
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/identityProviders/{identityProviderName}/rules':
    get:
      tags:
        - Single Sign On
      summary: Get Mapping Rules of Organization Identity Provider
      description: Returns a collection resource representation of mapping rules configured for an organization identity provider with the specified name.
      operationId: GetIdentityProviderRules
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/IdentityProviderRoleMappingRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/IdentityProviderRoleMappingRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7cff66d7-4d1e-4c5d-9faa-ec913fb77cfe
                    name: ResellerAdministrator
                    providerName: MacRes
                    description: ResellerAdministrator Keycloak
                    role: ResellerAdministrator
                    enabled: true
                    managedCompaniesUids: 
                    manageAllCompanies: true
                    hasAccessToProvider: false
                    organizationMappingSourceClaimType: Company
                    locationsMappingSourceClaimType: 
                    companyTenantMappingClaims: 
                    additionalMappings: [ ]
                    attributeMappings: [ ]
                    _embedded:
                      providerInfo: 
                  - instanceUid: 149a26a3-9956-438e-8343-f59c9f1efee5
                    name: CompanyOwner
                    providerName: MacRes
                    description: CompanyOwner Keycloak
                    role: CompanyOwner
                    enabled: true
                    managedCompaniesUids: 
                    manageAllCompanies: true
                    hasAccessToProvider: false
                    organizationMappingSourceClaimType: Company
                    locationsMappingSourceClaimType: 
                    companyTenantMappingClaims: 
                    additionalMappings: [ ]
                    attributeMappings: [ ]
                    _embedded:
                      providerInfo: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
    post:
      tags:
        - Single Sign On
      summary: Create Mapping Rule for Organization Identity Provider
      description: Creates mapping rule for an organization identity provider with the specified name.
      operationId: CreateIdentityProviderRule
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentityProviderRoleMappingRule'
            example:
              name: PortalOperator
              description: Portal Operator Keycloak
              role: PortalOperator
              enabled: true
              managedCompaniesUids: 
              manageAllCompanies: true
              hasAccessToProvider: true
              organizationMappingSourceClaimType: Company
              locationsMappingSourceClaimType: 
              companyTenantMappingClaims: 
              additionalMappings: 
              attributeMappings: 
              _embedded: 
        required: true
      responses:
        '200':
          description: Created mapping rule.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/IdentityProviderRoleMappingRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: de89662d-9905-4669-a1eb-5be428738c6f
                  name: PortalOperator
                  providerName: MyCompany
                  description: Portal Operator Keycloak
                  role: Portal Operator
                  enabled: true
                  managedCompaniesUids: 
                  manageAllCompanies: true
                  hasAccessToProvider: true
                  organizationMappingSourceClaimType: Company
                  locationsMappingSourceClaimType: 
                  companyTenantMappingClaims: 
                  additionalMappings: [ ]
                  attributeMappings: [ ]
                  _embedded:
                    providerInfo: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-codegen-request-body-name: settings
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/identityProviders/{identityProviderName}/rules/{ruleUid}':
    get:
      tags:
        - Single Sign On
      summary: Get Organization Identity Provider Mapping Rule
      description: Returns a resource representation of an organization identity provider mapping rule with the specified UID.
      operationId: GetIdentityProviderRule
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: ruleUid
          in: path
          description: Mapping rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/IdentityProviderRoleMappingRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 7cff66d7-4d1e-4c5d-9faa-ec913fb77cfe
                  name: ResellerAdministrator
                  providerName: MacRes
                  description: ResellerAdministrator Keycloak
                  role: ResellerAdministrator
                  enabled: true
                  managedCompaniesUids: 
                  manageAllCompanies: true
                  hasAccessToProvider: false
                  organizationMappingSourceClaimType: Company
                  locationsMappingSourceClaimType: 
                  companyTenantMappingClaims: 
                  additionalMappings: [ ]
                  attributeMappings: [ ]
                  _embedded:
                    providerInfo: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/IdentityProviderRoleMappingRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
    patch:
      tags:
        - Single Sign On
      summary: Modify Organization Identity Provider Mapping Rule
      description: Modifies an organization identity provider mapping rule with the specified UID.
      operationId: PatchIdentityProviderRule
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: ruleUid
          in: path
          description: Mapping rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: false
                path: /Enabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/IdentityProviderRoleMappingRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: de89662d-8895-4669-a1eb-5bd318738c6f
                  name: Portal Read-only Operator
                  providerName: MyCompany
                  description: Portal Read-only Operator Rule Keycloak
                  role: PortalReadonlyOperator
                  enabled: false
                  managedCompaniesUids: 
                  manageAllCompanies: true
                  hasAccessToProvider: false
                  organizationMappingSourceClaimType: Company
                  locationsMappingSourceClaimType: 
                  companyTenantMappingClaims: 
                  additionalMappings: [ ]
                  attributeMappings: [ ]
                  _embedded:
                    providerInfo: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/IdentityProviderRoleMappingRule'
      x-codegen-request-body-name: modelPatches
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
    delete:
      tags:
        - Single Sign On
      summary: Delete Organization Identity Provider Mapping Rule
      description: Deletes an organization identity provider mapping rule with the specified UID.
      operationId: DeleteIdentityProviderRule
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: ruleUid
          in: path
          description: Mapping rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/identityProviders/{identityProviderName}':
    get:
      tags:
        - Single Sign On
      summary: Get Organization Identity Provider
      description: Returns a resource representation of an organization identity provider with the specified name.
      operationId: GetIdentityProvider
      parameters:
        - name: organizationUid
          in: path
          description: Organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/IdentityProviderSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: MyCompanyIdP
                  displayName: MyCompanyIdP
                  template: Keycloak
                  type: SAML2
                  configurationValidationSucceeded: true
                  errorMessage: 
                  configuration:
                    entityId: MyCompanyIdP
                    returnUrl: https://vspc1.tech.local:1280/Saml2/MyCompanyIdP/
                    modulePath: Saml2/MyCompanyIdP/
                    authenticateRequestSigningBehavior: IfIdpWantAuthnRequestsSigned
                    outboundSigningAlgorithm: RsaSha256
                    minIncomingSigningAlgorithm: RsaSha256
                    validateCertificates: 
                    publicOrigin: 
                    requestedAuthnContext:
                      classRef: Password
                      comparison: Exact
                    metadata:
                      cacheDuration: PT1H
                      validDuration: 7.12:00:00
                      wantAssertionsSigned: true
                      organization:
                        name: MyCompanyIdP
                        displayName: MyCompanyIdP
                        url: https://vspc1.tech.local:1280
                        language: en
                      contactPerson:
                        type: Other
                        company: 
                        givenName: 
                        surname: 
                        phoneNumber: 
                        email: ''
                      requestedAttributes:
                        - name: Minimal
                          friendlyName: 
                          nameFormat: 
                          isRequired: 
                    identityProviders:
                      - entityId: http://vspc1.tech.local:8080/auth/realms/master
                        signOnUrl: 
                        wantAuthnRequestsSigned: 
                        binding: 
                        allowUnsolicitedAuthnResponse: true
                        loadMetadata: true
                        outboundSigningAlgorithm: 
                        metadataLocation: http://keycloak.tech.local:8080/auth/realms/master/protocol/saml/descriptor
                    serviceCertificates:
                      - use: Both
                        status: Current
                        privateKeyContent: 
                        certificateThumbprint: EA63EE71DE5E297DBE49C1B307B210E732A95FG1
                        storeName: My
                        storeLocation: LocalMachine
                        x509FindType: FindByThumbprint
                        metadataPublishOverride: 
                    compatibility:
                      ignoreMissingInResponseTo: true
                      ignoreAuthenticationContextInResponse: 
                      unpackEntitiesDescriptorInIdentityProviderMetadata: true
                  rulesCount: 0
                  configurationCompleted: true
                  enabled: true
                  organizationUid: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/IdentityProviderSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
    patch:
      tags:
        - Single Sign On
      summary: Modify Organization Identity Provider
      description: Modifies an organization identity provider with the specified name.
      operationId: PatchIdentityProvider
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: false
                path: /Enabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/IdentityProviderSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: Mac_Res
                  displayName: Mac_Res
                  template: Keycloak
                  type: SAML2
                  configurationValidationSucceeded: true
                  errorMessage: 
                  configuration:
                    entityId: Mac_Res_patch
                    returnUrl: https://vspc1.tech.local:1280/Saml2/Mac_Res/
                    modulePath: Saml2/Mac_Res/
                    authenticateRequestSigningBehavior: IfIdpWantAuthnRequestsSigned
                    outboundSigningAlgorithm: RsaSha256
                    minIncomingSigningAlgorithm: RsaSha256
                    validateCertificates: 
                    publicOrigin: 
                    requestedAuthnContext:
                      classRef: Password
                      comparison: Exact
                    metadata:
                      cacheDuration: PT1H
                      validDuration: 7.12:00:00
                      wantAssertionsSigned: true
                      organization:
                        name: Mac_Res
                        displayName: Mac_Res
                        url: https://vspc1.tech.veeam.local:1280
                        language: en
                      contactPerson:
                        type: Other
                        company: 
                        givenName: 
                        surname: 
                        phoneNumber: 
                        email: ''
                      requestedAttributes:
                        - name: Minimal
                          friendlyName: 
                          nameFormat: 
                          isRequired: 
                    identityProviders:
                      - entityId: http://vspc1.tech.local:8080/auth/realms/master
                        signOnUrl: 
                        wantAuthnRequestsSigned: 
                        binding: 
                        allowUnsolicitedAuthnResponse: true
                        loadMetadata: true
                        outboundSigningAlgorithm: 
                        metadataLocation: http://vspc1.tech.local:8080/auth/realms/master/protocol/saml/descriptor
                    serviceCertificates:
                      - use: Both
                        status: Current
                        privateKeyContent: 
                        certificateThumbprint: 8CF86A67600CC1A564EF256A3C7B90CCEE575B68
                        storeName: My
                        storeLocation: LocalMachine
                        x509FindType: FindByThumbprint
                        metadataPublishOverride: 
                    compatibility:
                      ignoreMissingInResponseTo: true
                      ignoreAuthenticationContextInResponse: 
                      unpackEntitiesDescriptorInIdentityProviderMetadata: true
                  rulesCount: 0
                  configurationCompleted: false
                  enabled: false
                  organizationUid: c19ad7ea-47fa-4c91-9d81-7349d86047d9
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/IdentityProviderSettings'
      x-codegen-request-body-name: modelPatches
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
    delete:
      tags:
        - Single Sign On
      summary: Delete Organization Identity Provider
      description: Deletes an organization identity provider with the specified name.
      operationId: DeleteIdentityProvider
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/identityProviders/{identityProviderName}/revalidate':
    post:
      tags:
        - Single Sign On
      summary: Revalidate Organization Identity Provider
      description: Revalidates an organization identity provider with the specified name.
      operationId: RevalidateIdentityProvider
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/identityProviders/saml2/{identityProviderName}/metadata':
    get:
      tags:
        - Single Sign On
      summary: Get Metadata for Organization Identity Provider.
      description: "Returns content of the metadata XML file that is sent to an organization identity provider.\n> Error response is returned in the JSON format.\n"
      operationId: GetSaml2IdentityProviderClientMetadata
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: identityProviderName
          in: path
          description: Identity provider name.
          required: true
          schema:
            minLength: 1
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                type: object
                description: Metadata in the XML format.
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-allow-anonymous: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/organizations/resellers/{resellerUid}':
    get:
      tags:
        - Resellers
      summary: Get Reseller
      description: Returns a resource representation of a reseller with the specified UID.
      operationId: GetReseller
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Reseller'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                  proPartnerId: 
                  name: Gamma
                  status: Active
                  isRestAccessEnabled: true
                  resellerServices:
                    hostedServices:
                      backupResourcesEnabled: false
                      vb365ManagementEnabled: false
                      vbPublicCloudManagementEnabled: false
                    remoteServices:
                      backupAgentsManagement:
                        workstationAgentsQuota: 
                        serverAgentsQuota: 
                      vb365ManagementEnabled: false
                      backupServersManagementEnabled: false
                      vbPublicCloudManagementEnabled: false
                    cloudConnectQuota:
                      dataTransferOutQuota: 
                      insiderProtectionQuota: 
                      throttlingValue: 
                      throttlingUnit: 
                      maxConcurrentTask: 
                      isWanAccelerationEnabled: false
                    cloudConnectManagementEnabled: false
                    isFileLevelRestoreEnabled: false
                  _embedded:
                    organization: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/Reseller'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Resellers
      summary: Modify Reseller
      description: Modifies a reseller with the specified UID.
      operationId: PatchReseller
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /isRestAccessEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Reseller'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 0b1b656a-994e-42cc-9731-5a1802e38e85
                  proPartnerId: 
                  name: Beta
                  status: Active
                  isRestAccessEnabled: true
                  resellerServices:
                    hostedServices:
                      backupResourcesEnabled: false
                      vb365ManagementEnabled: false
                      vbPublicCloudManagementEnabled: false
                    remoteServices:
                      backupAgentsManagement:
                        workstationAgentsQuota: 51
                        serverAgentsQuota: 5
                      vb365ManagementEnabled: false
                      backupServersManagementEnabled: true
                      vbPublicCloudManagementEnabled: false
                    cloudConnectQuota:
                      dataTransferOutQuota: 
                      insiderProtectionQuota: 20
                      throttlingValue: 
                      throttlingUnit: 
                      maxConcurrentTask: 
                      isWanAccelerationEnabled: false
                    cloudConnectManagementEnabled: false
                    isFileLevelRestoreEnabled: false
                  _embedded:
                    organization: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/Reseller'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Resellers
      summary: Delete Reseller
      description: Deletes a reseller with the specified UID.
      operationId: DeleteReseller
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: Reseller has been deleted.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/resellers/{resellerUid}/welcomeEmail':
    post:
      tags:
        - Resellers
      summary: Send Welcome Email to Reseller
      description: Sends a welcome email to a reseller with the specified UID.
      operationId: SendWelcomeEmailToReseller
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        description: Password for the account.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WelcomeEmailOptions'
            example:
              password: Password1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/resellers/{resellerUid}/companies':
    get:
      tags:
        - Resellers
      summary: Get All Companies Managed by Reseller
      description: Returns a collection resource representation of companies managed by a reseller with the specified UID.
      operationId: GetCompaniesByReseller
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/CompanyExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Company'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: eb866e8f-a0f5-41f4-9dd9-8cc59266ff25
                    name: Alpha
                    status: Active
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    subscriptionPlanUid: 
                    isRestAccessEnabled: false
                    isAlarmDetectEnabled: false
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement:
                          workstationAgentsQuota: 
                          serverAgentsQuota: 
                        backupServersManagement: 
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: alphaowner
                      password: 
                    _embedded:
                      organization:
                        instanceUid: eb866e8f-a0f5-41f4-9dd9-8cc59266ff2
                        name: Alpha
                        alias: alpha
                        type: Company
                        taxId: 12345
                        email: s.smith@alpha.com
                        phone: 414-351-6025
                        country: 1
                        state: 49
                        countryName: USA
                        regionName: Midwest
                        city: Milwaukee
                        street: 3025 Johnny Lane
                        locationAdmin0Code: us
                        locationAdmin1Code: us-wi
                        locationAdmin2Code: 
                        notes: ''
                        zipCode: '53217'
                        website: www.alpha.com
                        veeamTenantId: 2
                        companyId: 
                  - instanceUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                    name: Beta
                    status: Active
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    subscriptionPlanUid: 
                    isRestAccessEnabled: false
                    isAlarmDetectEnabled: false
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement:
                          workstationAgentsQuota: 
                          serverAgentsQuota: 
                        backupServersManagement: 
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: betaowner
                      password: 
                    _embedded:
                      organization:
                        instanceUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                        name: Beta
                        alias: beta
                        type: Company
                        taxId: 9876
                        email: m.lore@beta.com
                        phone: 503-254-0212
                        country: 1
                        state: 37
                        countryName: USA
                        regionName: West
                        city: Portland
                        street: 5006 Gateway Road
                        locationAdmin0Code: us
                        locationAdmin1Code: us-or
                        locationAdmin2Code: 
                        notes: Company with network appliance
                        zipCode: '11202'
                        website: www.beta.com
                        veeamTenantId: ''
                        companyId: ''
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Resellers
      summary: Assign Company to Reseller
      description: Assigns a company with the specified UID to a reseller.
      operationId: AssignCompanyToReseller
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/companyUid_query'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Resellers
      summary: Unassign Company from Reseller
      description: Unassigns a company with the specified UID from a reseller.
      operationId: UnassignCompanyFromReseller
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/companyUid_query'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/configuration/notification/welcomeEmails:
    get:
      tags:
        - Organizations
      summary: Get All Custom Settings of Email Notification
      description: Returns a collection resource representation of all custom settings configured for email notifications.
      operationId: GetCustomWelcomeEmailTemplates
      parameters:
        - name: organizationUid
          in: query
          schema:
            type: string
            description: Organization UID.
            format: uuid
            nullable: true
        - name: organizationType
          in: query
          schema:
            enum:
              - Unknown
              - Company
              - Reseller
            type: string
            description: Organization type.
            nullable: true
            x-ms-enum:
              name: NotificationOrganizationType
        - name: organizationScope
          in: query
          schema:
            enum:
              - Unknown
              - CurrentObject
              - ChildObjects
            type: string
            description: Scope of notified organizations.
            nullable: true
            x-ms-enum:
              name: NotificationOrganizationScope
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CustomWelcomeEmailTemplate'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - organizationUid: d0f80b1b-1f53-4803-94eb-15ed1ebf9d75
                    organizationType: Company
                    organizationScope: CurrentObject
                    emailContent: R2_SP_ Company welcome template
                    showSelfServiceSection: true
                    isDefault: false
                  - organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    organizationType: Reseller
                    organizationScope: CurrentObject
                    emailContent: R2_SP_ Reseller welcome template
                    showSelfServiceSection: true
                    isDefault: false
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/{organizationUid}/configuration/notification/welcomeEmail':
    get:
      tags:
        - Organizations
      summary: Get Custom Settings of Organization Email Notifications
      description: Returns a resource representation of custom settings configured for email notifications of an organization with the specified UID.
      operationId: GetCustomWelcomeEmailTemplate
      parameters:
        - name: organizationUid
          in: path
          required: true
          schema:
            type: string
            description: Organization UID.
            format: uuid
        - name: organizationType
          in: query
          required: true
          schema:
            enum:
              - Unknown
              - Company
              - Reseller
            type: string
            description: Organization type.
            x-ms-enum:
              name: NotificationOrganizationType
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CustomWelcomeEmailTemplate'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                  organizationType: Reseller
                  organizationScope: CurrentObject
                  emailContent: R2_SP_ Reseller welcome template
                  showSelfServiceSection: true
                  isDefault: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/CustomWelcomeEmailTemplate'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    post:
      tags:
        - Organizations
      summary: Configure Custom Settings for Organization Email Notifications
      description: Configures custom settings for email notifications of an organization with the specified UID.
      operationId: CreateCustomWelcomeEmailTemplate
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Email notification settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomWelcomeEmailTemplate'
            example:
              emailContent: SP Company welcome template
              showSelfServiceSection: true
              isDefault: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CustomWelcomeEmailTemplate'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  organizationUid: d0f80b1b-1f53-4803-94eb-15ed2abf9d75
                  organizationType: Company
                  organizationScope: CurrentObject
                  emailContent: SP Company welcome template
                  showSelfServiceSection: true
                  isDefault: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    patch:
      tags:
        - Organizations
      summary: Modify Custom Settings of Organization Email Notifications
      description: Modifies custom settings configured for email notification of an organization with the specified UID.
      operationId: PatchCustomWelcomeEmailTemplate
      parameters:
        - name: organizationUid
          in: path
          description: Organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: organizationType
          in: query
          required: true
          schema:
            enum:
              - Unknown
              - Company
              - Reseller
            type: string
            description: Organization type.
            x-ms-enum:
              name: NotificationOrganizationType
        - name: organizationScope
          in: query
          required: true
          schema:
            enum:
              - Unknown
              - CurrentObject
              - ChildObjects
            type: string
            description: Scope of notified organizations.
            x-ms-enum:
              name: NotificationOrganizationScope
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: r2_SP_ Reseller welcome template_modified
                path: /EmailContent
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CustomWelcomeEmailTemplate'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                  organizationType: Reseller
                  organizationScope: CurrentObject
                  emailContent: r2_SP_ Reseller welcome template_modified
                  showSelfServiceSection: true
                  isDefault: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/CustomWelcomeEmailTemplate'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/{organizationUid}/configuration/alarms':
    get:
      tags:
        - Organizations
      summary: Get All Organization Alarm Templates
      description: Returns a resource representation of all alarm templates configured for an organization with the specified UID.
      operationId: GetOrganizationAlarms
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Alarm'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: ac664538-b77e-4bdf-8108-04bf32509900
                    name: Job state
                    category: BackupVmJob
                    organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    internalId: 1
                    knowledge:
                      summary: Job is in a disabled state or without any configured schedule for more than an allowed time period.
                      cause: 'Veeam Backup & Replication server allows disabling scheduled jobs during maintenance windows. If a job stays in a disabled state or does not have any schedule at all for more than an allowed time period, it should be enabled back or the schedule has to be configured.'
                      resolution: Enable all disabled jobs using the backup portal UI or the Veeam Backup & Replication console.
                    isPredifined: true
                    isEnabled: false
                  - instanceUid: 1c260bcc-4314-4dd7-8311-ae9e8ef95e77
                    name: Max allowed job duration
                    category: BackupVmJob
                    organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    internalId: 2
                    knowledge:
                      summary: Job has exceeded its allowed execution time.
                      cause: Veeam job has exceeded the configured threshold of maximum allowed job duration.
                      resolution: 'Verify that VMware CBT was used for all VMs in the configured backup/replication job. Check the number of read and transferred data blocks for each VM or changed files during the latest file job session, make sure your Veeam proxy servers have sufficient number of concurrently running tasks allowed. Alternatively, adjust the maximum allowed job duration threshold for this alarm. Once triggered, this alarm needs to be resolved manually.'
                    isPredifined: true
                    isEnabled: false
                  - instanceUid: 7f31a822-b411-462b-b7d9-536fe500b810
                    name: Backup proxy connection state
                    category: BackupProxy
                    organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    internalId: 3
                    knowledge:
                      summary: Veeam Backup & Replication server lost connection to the proxy server.
                      cause: 'Veeam Backup & Replication may lose connection to the backup proxy due to one of the following reasons: failure of the network cable, disconnect of the cable, failure of the physical network card, backup proxy services failure, firewall issues, backup proxy power state.'
                      resolution: Verify that backup proxy is accessible by Veeam Backup & Replication server. Check firewall settings on the proxy server (if applicable) and make sure Veeam backup proxy services are up and running.
                    isPredifined: true
                    isEnabled: false
                  - instanceUid: bddd04dc-430f-4346-a084-4d488c18294c
                    name: Backup repository connection state
                    category: BackupRepository
                    organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    internalId: 4
                    knowledge:
                      summary: Veeam Backup & Replication server lost connection to the backup repository.
                      cause: 'Veeam Backup & Replication may lose connection to the backup repository due to one of the following reasons: failure of the network cable, disconnect of the cable, failure of the physical network card, backup repository services failure, firewall issues, backup repository power state.'
                      resolution: Verify that backup repository is accessible by both backup proxy and Veeam Backup & Replication servers. Check firewall settings on the proxy server (if applicable) and make sure Veeam backup repository services are up and running.
                    isPredifined: true
                    isEnabled: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/organizations/{organizationUid}/configuration/alarms/enable':
    post:
      tags:
        - Organizations
      summary: Enable Organization Alarm Templates
      description: Enables all alarm templates configured for an organization with the specified UID.
      operationId: EnableOrganizationAlarms
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/configuration/alarms/disable':
    post:
      tags:
        - Organizations
      summary: Disable Organization Alarm Templates
      description: Disables all alarm templates configured for an organization with the specified UID.
      operationId: DisableOrganizationAlarms
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/configuration/policy':
    get:
      tags:
        - Organizations
      summary: Get Organization Policy Settings
      description: Returns a resource representation of policy settings configured for an organization with the specified UID.
      operationId: GetOrganizationPolicySettings
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PolicySettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  mfaPolicyStatus: Enabled
                  enforceMfaPolicy: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PolicySettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
    patch:
      tags:
        - Organizations
      summary: Modify Organization Policy Settings
      description: Modifies policy settings configured for an organization with the specified UID.
      operationId: PatchOrganizationPolicySettings
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /EnforceMfaPolicy
                op: replace
              - value: Enabled
                path: /MfaPolicyStatus
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PolicySettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  mfaPolicyStatus: Enabled
                  enforceMfaPolicy: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PolicySettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/configuration/notification':
    get:
      tags:
        - Organizations
      summary: Get Organization Notification Settings
      description: Returns a resource representation of notification settings of an organization with the specified UID.
      operationId: GetOrganizationNotificationSettings
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/NotificationSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  smtp:
                    serverAddress: smtp://srv18.tech.local:25
                    tlsMode: auto
                    timeout: '2025-09-09T00:04:21.0000000+02:00'
                    passwordCredential:
                      userName: administrator
                      password: 
                      saslMechanism: 
                    oAuth2Credential: 
                    exclusivelyAcceptedCertificateHash: 
                  billing:
                    senderName: 
                    from: billing@mycompany.com
                    subject: '%company%: %invoicePeriod%'
                  discovery:
                    senderName: 
                    from: discovery@mycompany.com
                    to: j.smith@mycompany.com
                    subject: 'Company: "%company%", Location: "%location%", Rule: "%ruleName%", Status: "%ruleStatus%" '
                    isDailyNotificationEnabled: true
                    dailyTime: '2025-09-09T10:17:00.0000000+02:00'
                  alarms:
                    senderName: 
                    from: alarms@mycompany.com
                    to: j.smith@mycompany.com
                    dailySubject: 'Company: "%company%", Location: "%location%", Alarm: "%alarmName%", Status: "%alarmStatus%" '
                    isDailyNotificationEnabled: true
                    dailyTime: '2025-09-09T10:17:00.0000000+02:00'
                    dailyStatusFilter:
                      - Resolved
                      - Info
                      - Warning
                      - Error
                      - Acknowledged
                    dailySorting: ByTime
                  license:
                    senderName: 
                    from: licensing@mycompany.com
                    to: k.thormer@mycompany.com
                    enabled: false
                  level: summary
                  defaultSenderName: 
                  defaultFrom: summary@mycompany.com
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/NotificationSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Organizations
      summary: Modify Organization Notification Settings
      description: Modifies notification settings of an organization with the specified UID.
      operationId: PatchOrganizationNotificationSettings
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: notifications@mycompany.com
                path: /defaultfrom
                op: replace
              - value: smtp://smtp1.tech.local:25
                path: /smtp/serveraddress
                op: add
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/NotificationSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  smtp:
                    serverAddress: smtp://smtp1.tech.local:25
                    tlsMode: auto
                    timeout: '2025-09-09T00:04:21.0000000+02:00'
                    passwordCredential:
                      userName: administrator
                      password: ••••••
                      saslMechanism: 
                    oAuth2Credential: 
                    exclusivelyAcceptedCertificateHash: 
                  billing:
                    senderName: 
                    from: notifications@mycompany.com
                    subject: '%company%: %invoicePeriod%'
                  discovery:
                    senderName: 
                    from: notifications@mycompany.com
                    to: admin@mycompany.com
                    subject: 'Company: "%company%", Location: "%location%", Rule: "%ruleName%", Status: "%ruleStatus%" '
                    isDailyNotificationEnabled: true
                    dailyTime: '2025-09-09T10:17:00.0000000+02:00'
                  alarms:
                    senderName: 
                    from: notifications@mycompany.com
                    to: admin@mycompany.com
                    dailySubject: 'Company: "%company%", Location: "%location%", Alarm: "%alarmName%", Status: "%alarmStatus%" '
                    isDailyNotificationEnabled: true
                    dailyTime: '2025-09-09T10:17:00.0000000+02:00'
                    dailyStatusFilter:
                      - Resolved
                      - Info
                      - Warning
                      - Error
                      - Acknowledged
                    dailySorting: ByTime
                  license:
                    senderName: 
                    from: notifications@mycompany.com
                    to: licensing@mycompany.com
                    enabled: false
                  level: summary
                  defaultSenderName: 
                  defaultFrom: notifications@mycompany.com
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/NotificationSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/{organizationUid}/configuration/notification/smtp/test':
    post:
      tags:
        - Organizations
      summary: Test SMTP Server Settings
      description: Checks provided SMTP server settings. Returns updated and corrected settings and additional information on SMTP server.
      operationId: TestNotificationSmtpSettings
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: SMTP settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SmtpSettings'
            example:
              serverAddress: smtp://smtp1.tech.local:25
              tlsMode: auto
              timeout: '2025-09-09T00:05:00.0000000+02:00'
              passwordCredential: 
              oAuth2Credential: 
              exclusivelyAcceptedCertificateHash: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TestSmtpSettingsResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  smtpSettings:
                    serverAddress: smtp://smtp1.tech.local:25/
                    tlsMode: auto
                    timeout: '2025-09-09T00:05:00.0000000+02:00'
                    passwordCredential: 
                    oAuth2Credential: 
                    exclusivelyAcceptedCertificateHash: 
                  serverCertificate: 
                  result: Ok
                  error: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/{organizationUid}/configuration/notification/test':
    post:
      tags:
        - Organizations
      summary: Test Email Notifications
      description: Sends test email message with the specified settings.
      operationId: SendTestNotificationEmail
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        description: Test email settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestEmailOptions'
            example:
              senderName: 
              from: notifications@mycompany.com
              to: admin@mycompany.com
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/{organizationUid}/configuration/notification/oauth2/signin':
    post:
      tags:
        - Organizations
      summary: Send SMTP Server OAuth 2.0 Authorization Request
      description: Sends an OAuth 2.0 authorization request to access an SMTP server for an organization with the specified UID.
      operationId: PrepareSmtpOAuth2SignIn
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              required:
                - clientSettings
                - redirectUrl
              type: object
              properties:
                clientSettings:
                  allOf:
                    - $ref: '#/components/schemas/OAuth2ClientSettings'
                  description: OAuth 2.0 client settings.
                redirectUrl:
                  type: string
                  description: 'Redirect URI. For details, see [RFC6749](https://datatracker.ietf.org/doc/html/rfc6749#section-3.1.2).'
                state:
                  type: string
                  description: 'Request state returned to a client. For details, see [RFC6749](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.1).'
                  default: 
                  nullable: true
            example:
              clientSettings:
                kind: Google
                clientId: 79305292066-5iihp5kte0j1mrd4jamdstoh3a1u64lc.apps.googleusercontent.com
                clientSecret: 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
                scope: 
                tenantId: 
              redirectUrl: https://local.vspc.com:1280
              state: 
      responses:
        '200':
          description: Authentication parameters.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/OAuth2SignInParameters'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  location: https://accounts.google.com/o/oauth2/v2/auth?client_id=79415293167-5iihp5kte0g3mrd4jamdsj5h3a1u64lb.apps.googleusercontent.com&scope=openid%20email%20https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fgmail.send&response_type=code&access_type=offline&prompt=consent&redirect_uri=https%3A%2F%2Fatlocal.vspc.com%3A44325&state=2F4B5DF945760D150CDFD568E03F0245122843B78DAD1C9562EC48D2F2DD09B2AC3CC78CCFB7713EBACFB0F38E9C9EB631FAF7F56D22E940E5F6D81F63AB4DC2
                  navigationMode: redirect
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/{organizationUid}/configuration/notification/oauth2/signin/completion':
    get:
      tags:
        - Organizations
      summary: Obtain SMTP Server OAuth 2.0 Authorization Tokens
      description: Returns a pair of OAuth 2.0 authorization tokens to access an SMTP server for an organization with the specified UID.
      operationId: CompleteSmtpOAuth2SignIn
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: error
          in: query
          description: Error message.
          schema:
            type: string
        - name: error_description
          in: query
          description: Detailed error description.
          schema:
            type: string
        - name: code
          in: query
          description: 'Authorization code. For details, see [RFC6749](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2).'
          schema:
            type: string
        - name: state
          in: query
          description: 'Request state returned to a client. For details, see [RFC6749](https://datatracker.ietf.org/doc/html/rfc6749#section-4.1.2).'
          schema:
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: Authorization result.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompleteSmtpOAuth2SignInResponseData'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  credential:
                    clientSettings:
                      kind: Google
                      clientId: 79315292066-5iihp5kte1k1mrd4jamdstoh3a1u64lb.apps.googleusercontent.com
                      clientSecret: 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
                      scope: 
                      tenantId: 
                    userId: alpha@gmail.com
                    accessToken: MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnFetaXamsmdJZ1g6lo5vFjXuMur5kOe/HJ2CcFU0bIzRv9CzwQMO3Tv7WVUeX4tSxf8V1a+ZaatO2489Zjk9kKU/lHdroTV6+C2BWNftzjA9t5pkQt2R5JP1Ro5eN1iSODoPqeKvz9a3aycRdaVNr5k5GdtGtYwZo9dIxigXnfy2XbsaxyQCYb5wrMe76tw3DXGzcxbsyntqr9FNyeyQj9b8G2f9EV0DxdWlQzW1ZbdKwKiWN9A5hycgcCrOcFx8TFdOiUfqCWXKaRWqNNAxp08moMkpLYw9hz3x39/9RcC2Z8FSLVWyG23KXI4ZqSGHG2qvsi9vFw51GC5zoCXOiQIDAQAB
                    accessTokenExpiration: '2023-11-18T14:03:18.4129508+01:00'
                    refreshToken: 1//195V27v93D-glDtRIARBBGAkNSwF-L5Iri9-bB81fc_qKW11uHPaeRINi9ygi-ADio-4VmoadtTW4P1afXiUQ9CqwdlYJsYWhd8k
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/{organizationUid}/configuration/branding':
    get:
      tags:
        - Organizations
      summary: Get Organization Branding Settings
      description: Returns a resource representation of branding settings of an organization with the specified UID.
      operationId: GetOrganizationBrandingSettings
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BrandingSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  portalColorTheme: Turquoise
                  managedOrganizationsBrandingPolicy: AllowCustomization
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/BrandingSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Organizations
      summary: Modify Organization Branding Settings
      description: Modifies branding settings of an organization with the specified UID.
      operationId: PatchOrganizationBrandingSettings
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Green
                path: /portalColorTheme
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BrandingSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  portalColorTheme: Green
                  managedOrganizationsBrandingPolicy: AllowCustomization
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BrandingSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/{organizationUid}/configuration/loginUrl':
    get:
      tags:
        - Organizations
      summary: Get Organization Portal URL
      description: Returns a resource representation of a portal URL configured for an organization with the specified UID.
      operationId: GetOrganizationLoginUrl
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/OrganizationLoginUrlAndSuggestion'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  loginUrl: https://deltareseller.VSPC1.tech.local:1280/
                  loginUrlIsInherited: false
                  loginUrlSuggestion: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    put:
      tags:
        - Organizations
      summary: Replace Organization Portal URL
      description: "Replaces a portal configured for an organization with the specified UID.\n> Applies a portal URL to organizations that has no portal URL configured.\n> If the organization is a company and it has at least one configured IdP the operation will return an error with the 1000 code.\n> If the specified URL is already occupied by another organization the operation will return an error with the 10500 code.\n"
      operationId: ReplaceOrganizationLoginUrl
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: loginUrl
          in: query
          description: Portal URL.
          required: true
          schema:
            maxLength: 256
            minLength: 1
            pattern: '^(http|https):\/\/[\w\d\-._~:/?#$&''()*+,;=]+$'
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: https://VSPC1.tech.local:1280/
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/configuration/autodeployment':
    get:
      tags:
        - Organizations
      summary: Get Organization Automatic Deployment Settings
      description: Returns a resource representation of Veeam backup agent automatic deployment settings configured for an organization with the specified UID.
      operationId: GetOrganizationAutoDeploymentSettings
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/AutoDeploymentSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                  isEnabled: false
                  windowsBackupPolicyUid: 
                  linuxBackupPolicyUid: 
                  macBackupPolicyUid: 
                  isRetryEnabled: false
                  retryCount: 7
                  retryInterval: 7
                  acceptNewConnections: true
                  installDriver: false
                  setReadOnlyAccess: false
                  backupAgentSettings:
                    backupAgentUid: 00000000-0000-0000-0000-000000000000
                    disableScheduledBackups: false
                    disableControlPanelNotification: false
                    disableBackupOverMeteredConnection: true
                    disableScheduleWakeup: false
                    throttleBackupActivity: true
                    restrictVpnConnections: false
                    limitBandwidthConsumption: false
                    bandwidthSpeedLimit: 1
                    bandwidthSpeedLimitUnit: MbitPerSec
                    flrWithoutAdminPrivilegesAllowed: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/AutoDeploymentSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Organizations
      summary: Modify Organization Automatic Deployment Settings
      description: Modifies Veeam backup agent automatic deployment settings configured for an organization with the specified UID.
      operationId: PatchOrganizationAutoDeploymentSettings
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: '7'
                path: /retryInterval
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/AutoDeploymentSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                  isEnabled: false
                  windowsBackupPolicyUid: 
                  linuxBackupPolicyUid: 
                  macBackupPolicyUid: 
                  isRetryEnabled: false
                  retryCount: 7
                  retryInterval: 7
                  acceptNewConnections: true
                  installDriver: false
                  setReadOnlyAccess: false
                  backupAgentSettings:
                    backupAgentUid: 00000000-0000-0000-0000-000000000000
                    disableScheduledBackups: false
                    disableControlPanelNotification: false
                    disableBackupOverMeteredConnection: true
                    disableScheduleWakeup: false
                    throttleBackupActivity: true
                    restrictVpnConnections: false
                    limitBandwidthConsumption: false
                    bandwidthSpeedLimit: 1
                    bandwidthSpeedLimitUnit: MbitPerSec
                    flrWithoutAdminPrivilegesAllowed: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/AutoDeploymentSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /organizations/resellers/licenseResource:
    get:
      tags:
        - Resellers
      summary: Get All Reseller License Management Resources
      description: Returns a collection resource representation of all license management resources allocated to resellers.
      operationId: GetResellersLicenseResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerLicenseResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - resellerUid: 34c25899-e0b1-4ad4-8bdb-91fb3c545ce8
                    pulseConfigurationStatus: Warning
                    pulseConfigurationStatusMessage: 'The VCSP Pulse plugin has been disabled by the service provider. '
                    pulseAutoConnectWithProviderToken: false
                    isLicenseManagementEnabled: false
                    licenseContractId: 
                    licensePointsQuota: 0
                    isLicensePointsQuotaUnlimited: true
                    licensePointsUsage: 0
                    isCreatingNewCompaniesToPulseEnabled: false
                  - resellerUid: 4e95b8e2-314a-4d8f-ac86-8d89bf2b3f3c
                    pulseConfigurationStatus: Warning
                    pulseConfigurationStatusMessage: 'The VCSP Pulse plugin has been disabled by the service provider. '
                    pulseAutoConnectWithProviderToken: false
                    isLicenseManagementEnabled: false
                    licenseContractId: 
                    licensePointsQuota: 0
                    isLicensePointsQuotaUnlimited: true
                    licensePointsUsage: 0
                    isCreatingNewCompaniesToPulseEnabled: false
                  - resellerUid: 6e3356ab-628a-4fb6-acf8-b36ef33d9c15
                    pulseConfigurationStatus: Warning
                    pulseConfigurationStatusMessage: 'The VCSP Pulse plugin has been disabled by the service provider. '
                    pulseAutoConnectWithProviderToken: false
                    isLicenseManagementEnabled: false
                    licenseContractId: 
                    licensePointsQuota: 0
                    isLicensePointsQuotaUnlimited: true
                    licensePointsUsage: 0
                    isCreatingNewCompaniesToPulseEnabled: false
                  - resellerUid: 2f196ee5-3134-4cb0-8ed0-fb482121277f
                    pulseConfigurationStatus: Warning
                    pulseConfigurationStatusMessage: 'The VCSP Pulse plugin has been disabled by the service provider. '
                    pulseAutoConnectWithProviderToken: false
                    isLicenseManagementEnabled: false
                    licenseContractId: 
                    licensePointsQuota: 0
                    isLicensePointsQuotaUnlimited: true
                    licensePointsUsage: 0
                    isCreatingNewCompaniesToPulseEnabled: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/licenseResource':
    get:
      tags:
        - Resellers
      summary: Get License Management Resource Allocated to Reseller
      description: Returns a resource representation of a license management resource allocated to a reseller with the specified UID.
      operationId: GetResellerLicenseResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerLicenseResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  resellerUid: 693fa5c7-27c5-43c3-bba0-ebd888e5d953
                  pulseConfigurationStatus: Warning
                  pulseConfigurationStatusMessage: The VCSP Pulse plugin has been disabled by the service provider.
                  pulseAutoConnectWithProviderToken: false
                  isLicenseManagementEnabled: false
                  licenseContractId: 
                  licensePointsQuota: 0
                  isLicensePointsQuotaUnlimited: true
                  licensePointsUsage: 0
                  isCreatingNewCompaniesToPulseEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerLicenseResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Resellers
      summary: Modify License Management Resource Allocated to Reseller
      description: Modifies a license management resource allocated to a reseller with the specified UID.
      operationId: PatchResellerLicenseResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 'true'
                path: /isLicenseManagementEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerLicenseResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  resellerUid: 693fa5c7-27c5-43c3-bba0-ebd888e5d953
                  pulseConfigurationStatus: NotConfigured
                  pulseConfigurationStatusMessage: ''
                  pulseAutoConnectWithProviderToken: false
                  isLicenseManagementEnabled: true
                  licenseContractId: '02553265'
                  licensePointsQuota: 0
                  isLicensePointsQuotaUnlimited: true
                  licensePointsUsage: 0
                  isCreatingNewCompaniesToPulseEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ResellerLicenseResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/hostedResources/vb365:
    get:
      tags:
        - Resellers
      summary: Get All Reseller Veeam Backup for Microsoft 365 Resources
      description: Returns a collection resource representation of Veeam Backup for Microsoft 365 resources allocated to all resellers.
      operationId: GetResellersVb365Resources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 2c5dd019-0a1f-49bf-9f54-de580a51a13f
                    vb365ServerUid: 2c5dd019-0a1f-49bf-9f54-de580a51a13f
                    friendlyName: VBM
                    resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                    vb365Repositories:
                      - instanceUid: 3458bb60-4d64-4ba7-86bf-2e0536bb39e1
                        resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                        vb365ResourceUid: 2c5dd019-0a1f-49bf-9f54-de580a51a13f
                        repositoryUid: 3458bb60-4d64-4ba7-86bf-2e0536bb39e1
                        proxyUid: 652f5aa3-69c1-4f31-a0f1-7e42bc8baafe
                        proxyPoolUid: 
                        storageQuota: 128321581056
                        isStorageQuotaUnlimited: false
                  - instanceUid: 3a0f9d20-3937-43bb-9a27-342a9dde8bdf
                    vb365ServerUid: 3a0f9d20-3937-43bb-9a27-342a9dde8bdf
                    friendlyName: VBM2
                    resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                    vb365Repositories:
                      - instanceUid: 45e1ff7b-4baf-45b9-b94c-9b2609938283
                        resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                        vb365ResourceUid: 3a0f9d20-3937-43bb-9a27-342a9dde8bdf
                        repositoryUid: 45e1ff7b-4baf-45b9-b94c-9b2609938283
                        proxyUid: e444d352-2856-4b7e-8c7c-e761b6e27add
                        proxyPoolUid: 
                        storageQuota: 128321581056
                        isStorageQuotaUnlimited: false
                      - instanceUid: 0890a10a-e400-4a3c-b5ba-9feb4465b2e7
                        resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                        vb365ResourceUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                        repositoryUid: 0890a10a-e400-4a3c-b5ba-9feb4465b2e7
                        proxyUid: 9dfc7201-5d91-4818-9cc0-1d844b0503de
                        proxyPoolUid: 
                        storageQuota: 106846744576
                        isStorageQuotaUnlimited: false
                  - instanceUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                    vb365ServerUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                    friendlyName: VBM3
                    resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                    vb365Repositories:
                      - instanceUid: 215c8f93-b1a6-4ab9-9849-c45e94976000
                        resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                        vb365ResourceUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                        repositoryUid: 215c8f93-b1a6-4ab9-9849-c45e94976000
                        proxyUid: 496565fa-7018-433a-ae93-15a5cd0b88f0
                        proxyPoolUid: 
                        storageQuota: 128321581056
                        isStorageQuotaUnlimited: false
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/hostedResources/vb365':
    get:
      tags:
        - Resellers
      summary: Get All Veeam Backup for Microsoft 365 Resources of Reseller
      description: Returns a collection resource representation of all Veeam Backup for Microsoft 365 resources allocated to a reseller with the specified UID.
      operationId: GetResellerVb365Resources
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 2c5dd019-0a1f-49bf-9f54-de580a51a13f
                    vb365ServerUid: 2c5dd019-0a1f-49bf-9f54-de580a51a13f
                    friendlyName: VBM
                    resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                    vb365Repositories:
                      - instanceUid: 3458bb60-4d64-4ba7-86bf-2e0536bb39e1
                        resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                        vb365ResourceUid: 2c5dd019-0a1f-49bf-9f54-de580a51a13f
                        repositoryUid: 3458bb60-4d64-4ba7-86bf-2e0536bb39e1
                        proxyUid: 652f5aa3-69c1-4f31-a0f1-7e42bc8baafe
                        proxyPoolUid: 
                        storageQuota: 128321581056
                        isStorageQuotaUnlimited: false
                  - instanceUid: 3a0f9d20-3937-43bb-9a27-342a9dde8bdf
                    vb365ServerUid: 3a0f9d20-3937-43bb-9a27-342a9dde8bdf
                    friendlyName: VBM2
                    resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                    vb365Repositories:
                      - instanceUid: 45e1ff7b-4baf-45b9-b94c-9b2609938283
                        resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                        vb365ResourceUid: 3a0f9d20-3937-43bb-9a27-342a9dde8bdf
                        repositoryUid: 45e1ff7b-4baf-45b9-b94c-9b2609938283
                        proxyUid: e444d352-2856-4b7e-8c7c-e761b6e27add
                        proxyPoolUid: 
                        storageQuota: 128321581056
                        isStorageQuotaUnlimited: false
                      - instanceUid: 0890a10a-e400-4a3c-b5ba-9feb4465b2e7
                        resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                        vb365ResourceUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                        repositoryUid: 0890a10a-e400-4a3c-b5ba-9feb4465b2e7
                        proxyUid: 9dfc7201-5d91-4818-9cc0-1d844b0503de
                        proxyPoolUid: 
                        storageQuota: 106846744576
                        isStorageQuotaUnlimited: false
                  - instanceUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                    vb365ServerUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                    friendlyName: VBM3
                    resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                    vb365Repositories:
                      - instanceUid: 215c8f93-b1a6-4ab9-9849-c45e94976000
                        resellerUid: 1bb11e4f-e848-411d-bcf1-0c970a004546
                        vb365ResourceUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                        repositoryUid: 215c8f93-b1a6-4ab9-9849-c45e94976000
                        proxyUid: 496565fa-7018-433a-ae93-15a5cd0b88f0
                        proxyPoolUid: 
                        storageQuota: 128321581056
                        isStorageQuotaUnlimited: false
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Resellers
      summary: Create Reseller Veeam Backup for Microsoft 365 Resource.
      description: Allocates a Veeam Backup for Microsoft 365 resource to a reseller with the specified UID.
      operationId: CreateResellerVb365Resource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Reseller Veeam Backup for Microsoft 365 resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResellerVb365ResourceInput'
            example:
              vb365ServerUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
              friendlyName: VBM365 Resource
              vb365RepositoriesUids:
                - 215c8f93-b1a6-4ab9-9849-c45e94976000
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                  vb365ServerUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                  friendlyName: VBM365 Resource
                  resellerUid: 99e23b91-c8a0-482d-82fe-5baf68705309
                  vb365Repositories:
                    - instanceUid: 215c8f93-b1a6-4ab9-9849-c45e94976000
                      resellerUid: 99e23b91-c8a0-482d-82fe-5baf68705309
                      vb365ResourceUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                      repositoryUid: 215c8f93-b1a6-4ab9-9849-c45e94976000
                      proxyUid: 496565fa-7018-433a-ae93-15a5cd0b88f0
                      proxyPoolUid: 
                      storageQuota: 128321581056
                      isStorageQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/resellers/{resellerUid}/hostedResources/vb365/{resourceUid}':
    get:
      tags:
        - Resellers
      summary: Get Reseller Veeam Backup for Microsoft 365 Resource
      description: Returns a resource representation of a reseller Veeam Backup for Microsoft 365 resource with the specified UID.
      operationId: GetResellerVb365Resource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: resourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                  vb365ServerUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                  friendlyName: VBM3
                  resellerUid: 99e23b91-c8a0-482d-82fe-5baf68705309
                  vb365Repositories:
                    - instanceUid: 0890a10a-e400-4a3c-b5ba-9feb4465b2e7
                      resellerUid: 99e23b91-c8a0-482d-82fe-5baf68705309
                      vb365ResourceUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                      repositoryUid: 0890a10a-e400-4a3c-b5ba-9feb4465b2e7
                      proxyUid: 9dfc7201-5d91-4818-9cc0-1d844b0503de
                      proxyPoolUid: 
                      storageQuota: 106846744576
                      isStorageQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerVb365Resource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Resellers
      summary: Modify Reseller Veeam Backup for Microsoft 365 Resource
      description: Modifies a reseller Veeam Backup for Microsoft 365 resource with the specified UID.
      operationId: PatchResellerVb365Resource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: resourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Vb365
                path: /friendlyName
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                  vb365ServerUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                  friendlyName: VBM365 Resource
                  resellerUid: 99e23b91-c8a0-482d-82fe-5baf68705309
                  vb365Repositories:
                    - instanceUid: 0890a10a-e400-4a3c-b5ba-9feb4465b2e7
                      resellerUid: 99e23b91-c8a0-482d-82fe-5baf68705309
                      vb365ResourceUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                      repositoryUid: 0890a10a-e400-4a3c-b5ba-9feb4465b2e7
                      proxyUid: 9dfc7201-5d91-4818-9cc0-1d844b0503de
                      proxyPoolUid: 
                      storageQuota: 106846744576
                      isStorageQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ResellerVb365Resource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Resellers
      summary: Delete Reseller Veeam Backup for Microsoft 365 Resource
      description: Deletes a reseller Veeam Backup for Microsoft 365 resource with the specified UID.
      operationId: DeleteResellerVb365Resource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: resourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/resellers/{resellerUid}/hostedResources/vb365/{resourceUid}/repositoryResources/{repositoryUid}':
    delete:
      tags:
        - Resellers
      summary: Delete Reseller Veeam Backup for Microsoft 365 Repository
      description: Deletes a reseller Veeam Backup for Microsoft 365 repository with the specified UID.
      operationId: DeleteResellerVb365RepositoryResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: resourceUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: repositoryUid
          in: path
          description: Veeam Backup for Microsoft 365 repository UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/hostedResources/vbr:
    get:
      tags:
        - Resellers
      summary: Get All Reseller Veeam Backup & Replication Server Resources
      description: Returns a collection resource representation of Veeam Backup & Replication server resources allocated to all resellers.
      operationId: GetResellersVbrResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                    vbrServerUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                    friendlyName: BetaVBRRes1
                    resellerUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                  - instanceUid: cdd60d1c-ad8f-4d22-8b5f-e2c9a6da5bc6
                    vbrServerUid: 7cff66d7-4d1e-4c5d-9faa-ec913fb77cfe
                    friendlyName: GammaVBRRes1
                    resellerUid: 149a26a3-9956-438e-8343-f59c9f1efee5
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/hostedResources/vbr':
    get:
      tags:
        - Resellers
      summary: Get All Veeam Backup & Replication Server Resources of Reseller
      description: Returns a collection resource representation of all Veeam Backup & Replication server resources allocated to a reseller with the specified UID.
      operationId: GetResellerVbrResources
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                    vbrServerUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                    friendlyName: BetaVBRRes1
                    resellerUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                  - instanceUid: cdd60d1c-ad8f-4d22-8b5f-e2c9a6da5bc6
                    vbrServerUid: 7cff66d7-4d1e-4c5d-9faa-ec913fb77cfe
                    friendlyName: BetaVBRRes2
                    resellerUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Resellers
      summary: Create Reseller Veeam Backup & Replication Server Resource
      description: Allocates a Veeam Backup & Replication server resource to a reseller with the specified UID.
      operationId: CreateResellerVbrResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Reseller Veeam Backup & Replication server resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResellerVbrResourceInput'
            example:
              vbrServerUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              friendlyName: Beta VBR Resource
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  vbrServerUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  friendlyName: Beta VBR Resource
                  resellerUid: 6f213654-b538-4695-ac69-aa677e41862e
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/resellers/{resellerUid}/hostedResources/vbr/{resourceUid}':
    get:
      tags:
        - Resellers
      summary: Get Reseller Veeam Backup & Replication Server Resource
      description: Returns a resource representation of a reseller Veeam Backup & Replication server resource with the specified UID.
      operationId: GetResellerVbrResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: resourceUid
          in: path
          description: Veeam Backup & Replication server resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                  vbrServerUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                  friendlyName: BetaVBRRes1
                  resellerUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerVbrResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Resellers
      summary: Modify Reseller Veeam Backup & Replication Server Resource
      description: Modifies a reseller Veeam Backup & Replication server resource with the specified UID.
      operationId: PatchResellerVbrResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: resourceUid
          in: path
          description: Veeam Backup & Replication server resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Beta VBR Resource
                path: friendlyName
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  vbrServerUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  friendlyName: Beta VBR Resource
                  resellerUid: 6f213654-b538-4695-ac69-aa677e41862e
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ResellerVbrResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Resellers
      summary: Delete Reseller Veeam Backup & Replication Server Resource
      description: Deletes a reseller Veeam Backup & Replication server resource with the specified UID.
      operationId: DeleteResellerVbrResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: resourceUid
          in: path
          description: Veeam Backup & Replication server resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/sites:
    get:
      tags:
        - Resellers
      summary: Get All Reseller Site Resources
      description: Returns a collection resource representation of managed company quotas configured for all resellers.
      operationId: GetResellersSiteResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - resellerUid: 398ded41-0671-4a55-aa2e-feac5f422eef
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    tenantsQuota: 45
                    usedTenantsQuota: 4
                    isTenantsQuotaUnlimited: false
                  - resellerUid: 900b283f-ac11-4ad3-8ceb-16b56ed817e1
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    tenantsQuota: 45
                    usedTenantsQuota: 5
                    isTenantsQuotaUnlimited: false
                  - resellerUid: 05466d17-8660-4490-81c9-62a3d15f97db
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    tenantsQuota: 45
                    usedTenantsQuota: 7
                    isTenantsQuotaUnlimited: false
                  - resellerUid: f8149920-cd51-41d3-b3dd-d8aa82bf7d63
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    tenantsQuota: 45
                    usedTenantsQuota: 4
                    isTenantsQuotaUnlimited: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/sites':
    get:
      tags:
        - Resellers
      summary: Get All Site Resources Allocated to Reseller
      description: Returns a collection resource representation of managed company quotas configured for a reseller with the specified UID on all sites.
      operationId: GetResellerSiteResources
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - resellerUid: 86528a21-6944-441b-9e1b-7363e2d45a42
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    tenantsQuota: 45
                    usedTenantsQuota: 13
                    isTenantsQuotaUnlimited: false
                  - resellerUid: 86528a21-6944-441b-9e1b-7363e2d45a42
                    siteUid: 491a2482-2d20-43d2-b199-d54fdde8dfee
                    tenantsQuota: 25
                    usedTenantsQuota: 7
                    isTenantsQuotaUnlimited: false
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Resellers
      summary: Create Reseller Site Resource
      description: Creates a managed company quota for a reseller with the specified UID.
      operationId: CreateResellerSiteResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Company quota properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResellerSiteResource'
            example:
              siteUid: d83442bc-03fc-469b-be4e-c0761bfc9ddd
              tenantsQuota: 45
              isTenantsQuotaUnlimited: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  resellerUid: 5f7f23cd-72c2-46ce-a9d8-48e3c1adaabc
                  siteUid: d83442bc-03fc-469b-be4e-c0761bfc9ddd
                  tenantsQuota: 45
                  usedTenantsQuota: 0
                  isTenantsQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}':
    get:
      tags:
        - Resellers
      summary: Get Reseller Site Resource
      description: Returns a resource representation of a managed companies quota configured for a reseller on a Veeam Cloud Connect site with the specified UID.
      operationId: GetResellerSiteResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                  siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                  tenantsQuota: 50
                  usedTenantsQuota: 2
                  isTenantsQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerSiteResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Resellers
      summary: Modify Reseller Site Resource
      description: Modifies a managed companies quota configured for a reseller on the Veeam Cloud Connect site with the specified UID.
      operationId: PatchResellerSiteResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: false
                path: /isTenantsQuotaUnlimited
                op: replace
              - value: 71
                path: /tenantsQuota
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  resellerUid: 398ded41-0671-4a55-aa2e-feac5f422eef
                  siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  tenantsQuota: 71
                  usedTenantsQuota: 0
                  isTenantsQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ResellerSiteResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Resellers
      summary: Delete Reseller Site Resource
      description: Deletes a managed companies quota configured for a reseller on the Veeam Cloud Connect site with the specified UID.
      operationId: DeleteResellerSiteResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/sites/backupResources:
    get:
      tags:
        - Resellers
      summary: Get All Reseller Backup Resources
      description: Returns a collection resource representation of all reseller cloud backup resources.
      operationId: GetResellersSiteBackupResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 8a13b272-6081-649a-a18e-0074a4e42f98
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: 398ded41-0671-4a55-aa2e-feac5f422eef
                    repositoryUid: 4a57a173-cdfa-4ec7-bfc5-6cdf853530c3
                    resourceFriendlyName: res repo
                    storageQuota: 1073741824
                    isStorageQuotaUnlimited: false
                    serversQuota: 1
                    isServersQuotaUnlimited: false
                    workstationsQuota: 1
                    isWorkstationsQuotaUnlimited: false
                    vmsQuota: 1
                    isVmsQuotaUnlimited: false
                  - instanceUid: 8a13b272-6081-649a-a18e-0074a4e42f98
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    repositoryUid: 4a57a173-cdfa-4ec7-bfc5-6cdf853530c3
                    resourceFriendlyName: res repo 2
                    storageQuota: 10737418240
                    isStorageQuotaUnlimited: false
                    serversQuota: 
                    isServersQuotaUnlimited: true
                    workstationsQuota: 
                    isWorkstationsQuotaUnlimited: true
                    vmsQuota: 
                    isVmsQuotaUnlimited: true
                  - instanceUid: 5a061be4-8218-645b-9674-364cb252b6e1
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    resourceFriendlyName: _Res VSPC1\Default Backup Repository
                    storageQuota: 109521666048
                    isStorageQuotaUnlimited: false
                    serversQuota: 
                    isServersQuotaUnlimited: true
                    workstationsQuota: 
                    isWorkstationsQuotaUnlimited: true
                    vmsQuota: 
                    isVmsQuotaUnlimited: true
                  - instanceUid: 8a13b272-6081-649a-a18e-0074a4e42f98
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: 58fd5d0c-6446-4fe0-ab38-0f20569c2be8
                    repositoryUid: 4a57a173-cdfa-4ec7-bfc5-6cdf853530c3
                    resourceFriendlyName: res repo 3
                    storageQuota: 2147483648
                    isStorageQuotaUnlimited: false
                    serversQuota: 2
                    isServersQuotaUnlimited: false
                    workstationsQuota: 2
                    isWorkstationsQuotaUnlimited: false
                    vmsQuota: 
                    isVmsQuotaUnlimited: true
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources':
    get:
      tags:
        - Resellers
      summary: Get All Backup Resources Allocated to Reseller on Site
      description: Returns a collection resource representation of all cloud backup resources allocated to a reseller on a Veeam Cloud Connect site with the specified UID.
      operationId: GetResellerSiteBackupResources
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 5a061be4-8218-645b-9674-364cb252b6e1
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    resourceFriendlyName: _Res VSPC1\Default Backup Repository
                    storageQuota: 109521666048
                    isStorageQuotaUnlimited: false
                    serversQuota: 
                    isServersQuotaUnlimited: true
                    workstationsQuota: 
                    isWorkstationsQuotaUnlimited: true
                    vmsQuota: 
                    isVmsQuotaUnlimited: true
                  - instanceUid: 8a13b272-6081-649a-a18e-0074a4e42f98
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    repositoryUid: 4a57a173-cdfa-4ec7-bfc5-6cdf853530c3
                    resourceFriendlyName: res repo 3
                    storageQuota: 2147483648
                    isStorageQuotaUnlimited: false
                    serversQuota: 2
                    isServersQuotaUnlimited: false
                    workstationsQuota: 2
                    isWorkstationsQuotaUnlimited: false
                    vmsQuota: 
                    isVmsQuotaUnlimited: true
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Resellers
      summary: Create Reseller Backup Resource on Site
      description: Creates a reseller cloud backup resource on a Veeam Cloud Connect site with the specified UID.
      operationId: CreateResellerSiteBackupResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResellerSiteBackupResourceInput'
            example:
              repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              resourceFriendlyName: Beta Site Resource
              storageQuota: 10737418240
              isStorageQuotaUnlimited: false
              serversQuota: 5
              isServersQuotaUnlimited: false
              workstationsQuota: 5
              isWorkstationsQuotaUnlimited: false
              vmsQuota: 5
              isVmsQuotaUnlimited: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  siteUid: 6f213654-b538-4695-ac69-aa677e41862e
                  resellerUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  resourceFriendlyName: Beta Site Resource
                  storageQuota: 10737418240
                  isStorageQuotaUnlimited: false
                  serversQuota: 5
                  isServersQuotaUnlimited: false
                  workstationsQuota: 5
                  isWorkstationsQuotaUnlimited: false
                  vmsQuota: 5
                  isVmsQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/sites/backupResources/usage:
    get:
      tags:
        - Resellers
      summary: Get Usage of All Reseller Backup Resources
      description: Returns a collection resource representation of cloud backup resource usage by all resellers.
      operationId: GetResellersSiteBackupResourcesUsages
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteBackupResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - backupResourceUid: f10a8f5c-419b-475a-9fae-5e6cd2075da3
                    resellerUid: 48389f5a-06d4-4b26-b654-6179895e269b
                    storageQuota: 32212254720
                    usedStorageQuota: 9855565824
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 5
                    workstationBackups: 0
                    vmBackups: 0
                  - backupResourceUid: f10a8f5c-419b-475a-9fae-5e6cd2075da3
                    resellerUid: c454078c-d59a-45d9-8fca-4ba80c49f78c
                    storageQuota: 53687091200
                    usedStorageQuota: 12582912
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 0
                    workstationBackups: 1
                    vmBackups: 0
                  - backupResourceUid: f10a8f5c-419b-475a-9fae-5e6cd2075da3
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    storageQuota: 53687091200
                    usedStorageQuota: 16027484160
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 2
                    workstationBackups: 0
                    vmBackups: 0
                  - backupResourceUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    storageQuota: 109521666048
                    usedStorageQuota: 3145728
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 0
                    workstationBackups: 0
                    vmBackups: 1
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources/usage':
    get:
      tags:
        - Resellers
      summary: Get Usage of Reseller Backup Resources on Site
      description: Returns a resource representation of usage of all cloud backup resources allocated to a reseller on a Veeam Cloud Connect site with the specified UID.
      operationId: GetResellerSiteBackupResourcesUsage
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteBackupResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - backupResourceUid: f10a8f5c-419b-475a-9fae-5e6cd2075da3
                    resellerUid: 34c25899-e0b1-4ad4-8bdb-91fb3c545ce8
                    storageQuota: 10737418240
                    usedStorageQuota: 1048576
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 0
                    workstationBackups: 1
                    vmBackups: 0
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/backupResources/{resourceUid}':
    get:
      tags:
        - Resellers
      summary: Get Reseller Backup Resource
      description: Returns a resource representation of a reseller cloud backup resource with the specified UID.
      operationId: GetResellerSiteBackupResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: Cloud backup resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 8a13b272-6081-649a-a18e-0074a4e42f98
                  siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                  repositoryUid: 4a57a173-cdfa-4ec7-bfc5-6cdf853530c3
                  resourceFriendlyName: res repo 3
                  storageQuota: 2147483648
                  isStorageQuotaUnlimited: false
                  serversQuota: 2
                  isServersQuotaUnlimited: false
                  workstationsQuota: 2
                  isWorkstationsQuotaUnlimited: false
                  vmsQuota: 
                  isVmsQuotaUnlimited: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerSiteBackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Resellers
      summary: Modify Reseller Backup Resource
      description: Modifies a reseller cloud backup resource with the specified UID.
      operationId: PatchResellerSiteBackupResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: Cloud backup resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 2147483648
                path: /storageQuota
                op: replace
              - value: 2
                path: /serversQuota
                op: replace
              - value: 2
                path: /workstationsQuota
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 8a13b272-6081-649a-a18e-0074a4e42f98
                  siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  resellerUid: 58fd5d0c-6446-4fe0-ab38-0f20569c2be8
                  repositoryUid: 4a57a173-cdfa-4ec7-bfc5-6cdf853530c3
                  resourceFriendlyName: patched rest res repo
                  storageQuota: 2147483648
                  isStorageQuotaUnlimited: false
                  serversQuota: 2
                  isServersQuotaUnlimited: false
                  workstationsQuota: 2
                  isWorkstationsQuotaUnlimited: false
                  vmsQuota: 
                  isVmsQuotaUnlimited: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ResellerSiteBackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Resellers
      summary: Delete Reseller Backup Resource
      description: Deletes a reseller cloud backup resource with the specified UID.
      operationId: DeleteResellerSiteBackupResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: Cloud backup resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/sites/wanAcceleratorResources:
    get:
      tags:
        - Resellers
      summary: Get Cloud WAN Accelerator Resources of All Resellers
      description: Returns a collection resource representation of cloud WAN accelerator resources of all resellers.
      operationId: GetResellersSiteWanAcceleratorResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteWanAcceleratorResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 22a14f5e-21ea-607c-a913-bc4aebbc6ac2
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    wanAcceleratorUid: 00bdb123-c35a-43d6-ad03-7ba78e156ac4
                  - instanceUid: 57fb9596-ad1a-46de-ae9a-2a22ef29e3fc
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    wanAcceleratorUid: 94b797c3-058d-4829-83fa-2713fb02acea
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/wanAcceleratorResources':
    get:
      tags:
        - Resellers
      summary: Get All Cloud WAN Accelerator Resources Allocated to Reseller on Site
      description: Returns a collection resource representation of all cloud WAN accelerator resources allocated to a reseller on a site with the specified UID.
      operationId: GetResellerSiteWanAcceleratorResources
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteWanAcceleratorResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 22a14f5e-21ea-607c-a913-bc4aebbc6ac2
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    wanAcceleratorUid: 00bdb123-c35a-43d6-ad03-7ba78e156ac4
                  - instanceUid: 57fb9596-ad1a-46de-ae9a-2a22ef29e3fc
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    wanAcceleratorUid: 94b797c3-058d-4829-83fa-2713fb02acea
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Resellers
      summary: Create Reseller Cloud WAN Accelerator Resource
      description: Creates a reseller cloud WAN accelerator resource on a site with the specified UID.
      operationId: CreateResellerSiteWanAcceleratorResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResellerSiteWanAcceleratorResourceInput'
            example:
              wanAcceleratorUid: 00bdb123-c35a-43d6-ad03-7ca78e156ac4
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteWanAcceleratorResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 22a14f5e-21ea-607c-a913-ac4aebbc6ac2
                  siteUid: d83442bc-03fc-469b-be4e-d0761bfc9ddd
                  resellerUid: e6057ff9-99f7-47c8-9d9b-3220a29ab33a
                  wanAcceleratorUid: 00bdb123-c35a-43d6-ad03-7ca78e156ac4
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/wanAcceleratorResources/{resourceUid}':
    get:
      tags:
        - Resellers
      summary: Get Reseller Cloud WAN Accelerator Resource
      description: Returns a resource representation of a reseller cloud WAN accelerator resource with the specified UID.
      operationId: GetResellerSiteWanAcceleratorResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: Cloud WAN accelerator resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteWanAcceleratorResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 22a14f5e-21ea-607c-a913-bc4aebbc6ac2
                  siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                  wanAcceleratorUid: 00bdb123-c35a-43d6-ad03-7ba78e156ac4
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerSiteWanAcceleratorResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Resellers
      summary: Modify Reseller Cloud WAN Accelerator Resource
      description: Modifies a reseller cloud WAN accelerator resource with the specified UID.
      operationId: PatchResellerSiteWanAcceleratorResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: Cloud WAN accelerator resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 809a1670-4bbc-4da4-9da3-1066facbf99f
                path: /wanAcceleratorUid
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteWanAcceleratorResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 748f57e7-2280-65b6-9733-fee240863800
                  siteUid: 86238779-5bb3-4a2c-8578-466dedf635a3
                  resellerUid: 8bab25af-8cbd-4d14-a174-c8ca751f7331
                  wanAcceleratorUid: 809a1670-4bbc-4da4-9da3-1066facbf99f
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ResellerSiteWanAcceleratorResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Resellers
      summary: Delete Reseller Cloud WAN Accelerator Resource
      description: Deletes a reseller cloud WAN accelerator resource with the specified UID.
      operationId: DeleteResellerSiteWanAcceleratorResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: Cloud WAN accelerator resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/sites/replicationResources:
    get:
      tags:
        - Resellers
      summary: Get All Reseller Replication Resources
      description: Returns a collection resource representation of all reseller cloud replication resources.
      operationId: GetResellersSiteReplicationResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0c847bdd-9a71-687c-9284-5a8950a03802
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: 05466d17-8660-4490-81c9-62a3d15f97db
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    tenantsPerPlanQuota: 15
                    isWanAccelerationEnabled: true
                    wanAcceleratorUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                  - instanceUid: 0c847bdd-9a71-687c-9284-5a8950a03802
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    tenantsPerPlanQuota: 15
                    isWanAccelerationEnabled: true
                    wanAcceleratorUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                  - instanceUid: 115d9b12-e442-6866-8039-37c21efa32e3
                    siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    hardwarePlanUid: 982f7ef2-0b95-4b79-b0b9-b858ed3e6a75
                    tenantsPerPlanQuota: 20
                    isWanAccelerationEnabled: true
                    wanAcceleratorUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                  - instanceUid: f94a0ed9-61c9-61e3-94e6-b6da78ce8e13
                    siteUid: 0107365a-60f9-422a-832b-485db173d356
                    resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    hardwarePlanUid: 52c981c2-3937-4467-a27a-4122de927372
                    tenantsPerPlanQuota: 10
                    isWanAccelerationEnabled: false
                    wanAcceleratorUid: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources':
    get:
      tags:
        - Resellers
      summary: Get All Replication Resources Allocated to Reseller on Site
      description: Returns a collection resource representation of all cloud replication resources allocated to a reseller on a Veeam Cloud Connect site with the specified UID.
      operationId: GetResellerSiteReplicationResources
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0c847bdd-9a71-687c-9284-5a8950a03802
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    tenantsPerPlanQuota: 15
                    isWanAccelerationEnabled: true
                    wanAcceleratorUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                  - instanceUid: 0c847bdd-9a71-687c-9284-5a8950a03802
                    siteUid: 0107365a-60f9-422a-832b-485db173d356
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    tenantsPerPlanQuota: 15
                    isWanAccelerationEnabled: true
                    wanAcceleratorUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Resellers
      summary: Create Reseller Replication Resource on Site
      description: Creates a reseller replication resource on a Veeam Cloud Connect site with the specified UID.
      operationId: CreateResellerSiteReplicationResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResellerSiteReplicationResourceInput'
            example:
              hardwarePlanUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              tenantsPerPlanQuota: 100
              isWanAccelerationEnabled: true
              wanAcceleratorUid: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  siteUid: 6f213654-b538-4695-ac69-aa677e41862e
                  resellerUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  hardwarePlanUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  tenantsPerPlanQuota: 100
                  isWanAccelerationEnabled: false
                  wanAcceleratorUid: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/sites/replicationResources/usage:
    get:
      tags:
        - Resellers
      summary: Get Usage of All Reseller Replication Resources
      description: Returns a collection resource representation of Veeam Cloud Connect site replication resource usage by all resellers.
      operationId: GetResellersSiteReplicationResourcesUsages
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteReplicationResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - replicationResourceUid: 0c847bdd-9a71-687c-9284-5a8950a03802
                    resellerUid: 05466d17-8660-4490-81c9-62a3d15f97db
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    tenantsPerPlanUsage: 4
                  - replicationResourceUid: 0c847bdd-9a71-687c-9284-5a8950a03802
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    tenantsPerPlanUsage: 2
                  - replicationResourceUid: 115d9b12-e442-6866-8039-37c21efa32e3
                    resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    hardwarePlanUid: 982f7ef2-0b95-4b79-b0b9-b858ed3e6a75
                    tenantsPerPlanUsage: 1
                  - replicationResourceUid: f94a0ed9-61c9-61e3-94e6-b6da78ce8e13
                    resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    hardwarePlanUid: 52c981c2-3937-4467-a27a-4122de927372
                    tenantsPerPlanUsage: 1
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerSiteReplicationResourceUsage'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources/usage':
    get:
      tags:
        - Resellers
      summary: Get Usage of Replication Resources by Reseller on Site
      description: Returns a resource representation of cloud replication resource usage by a reseller on a Veeam Cloud Connect site with the specified UID.
      operationId: GetResellerSiteReplicationResourcesUsage
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteReplicationResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - replicationResourceUid: 0c847bdd-9a71-687c-9284-5a8950a03802
                    resellerUid: 05466d17-8660-4490-81c9-62a3d15f97db
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    tenantsPerPlanUsage: 12
                  - replicationResourceUid: 95c0a947-6425-49ba-b3b4-0c34dbdcaf87
                    resellerUid: 05466d17-8660-4490-81c9-62a3d15f97db
                    hardwarePlanUid: 5697ea0c-4dd3-4525-a1c6-e3b9aa3b86f2
                    tenantsPerPlanUsage: 8
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerSiteReplicationResourceUsage'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/replicationResources/{resourceUid}':
    get:
      tags:
        - Resellers
      summary: Get Reseller Replication Resource
      description: Returns a resource representation of a reseller cloud replication resource with the specified UID.
      operationId: GetResellerSiteReplicationResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: Cloud replication resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 0c847bdd-9a71-687c-9284-5a8950a03802
                  siteUid: 0107365a-60f9-422a-832b-485db173d356
                  resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                  hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                  tenantsPerPlanQuota: 15
                  isWanAccelerationEnabled: true
                  wanAcceleratorUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerSiteReplicationResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Resellers
      summary: Modify Reseller Replication Resource
      description: Modifies a reseller cloud replication resource with the specified UID.
      operationId: PatchResellerSiteReplicationResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: Cloud replication resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /isWanAccelerationEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  siteUid: 6f213654-b538-4695-ac69-aa677e41862e
                  resellerUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  hardwarePlanUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  tenantsPerPlanQuota: 100
                  isWanAccelerationEnabled: false
                  wanAcceleratorUid: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ResellerSiteReplicationResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Resellers
      summary: Delete Reseller Replication Resource
      description: Deletes a reseller cloud replication resource with the specified UID.
      operationId: DeleteResellerSiteReplicationResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: Cloud replication resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/sites/vcdReplicationResources:
    get:
      tags:
        - Resellers
      summary: Get All Reseller VMware Cloud Director Replication Resources
      description: Returns a collection resource representation of all reseller VMware Cloud Director replication resources.
      operationId: GetResellersSiteVcdReplicationResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteVcdReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 71c9f99d-68bd-6860-8cad-64dddce0e4ed
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    resellerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    vcdOrganizationUid: 7b97bd44-c932-4bdb-aaae-841cb453312a
                  - instanceUid: 4e1af4fd-751b-6339-949d-a0ee7e22ee7e
                    siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    vcdOrganizationUid: acfd8613-ddba-4b17-b176-7d1e87fdfc23
                  - instanceUid: 020103da-17b8-65e0-8a2e-67761ad5bfff
                    siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    vcdOrganizationUid: 2bd87f65-35ef-4109-8d27-537085bf1ad2
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/vcdReplicationResources':
    get:
      tags:
        - Resellers
      summary: Get All VMware Cloud Director Replication Resources Allocated to Reseller on Site
      description: Returns a collection resource representation of all VMware Cloud Director replication resources allocated to a reseller on a Veeam Cloud Connect site with the specified UID.
      operationId: GetResellerSiteVcdReplicationResources
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerSiteVcdReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 4e1af4fd-751b-6339-949d-a0ee7e22ee7e
                    siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    vcdOrganizationUid: acfd8613-ddba-4b17-b176-7d1e87fdfc23
                  - instanceUid: 020103da-17b8-65e0-8a2e-67761ad5bfff
                    siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    vcdOrganizationUid: 2bd87f65-35ef-4109-8d27-537085bf1ad2
                  - instanceUid: 13e5ca1f-0358-6e4b-85e4-3cab6ec3f4b9
                    siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    vcdOrganizationUid: ba5c51b7-66b3-4465-a3ba-f52aae245cca
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Resellers
      summary: Create Reseller VMware Cloud Director Replication Resource on Site
      description: Creates a VMware Cloud Director replication resource allocated to a reseller on a Veeam Cloud Connect site with the specified UID.
      operationId: CreateResellerSiteVcdReplicationResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResellerSiteVcdReplicationResourceInput'
            example:
              vcdOrganizationUid: ba5c51b7-66b3-4465-a3ba-b52aae245cca
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteVcdReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 13e5ca1f-0358-6e4b-85e4-6cab6ec3f4b9
                  siteUid: 56c7aef2-de29-4ab4-af54-1c29a34dcdb0
                  resellerUid: 4e66bccf-9c1e-4138-84ff-872c59a796cf
                  vcdOrganizationUid: ba5c51b7-66b3-4465-a3ba-b52aae245cca
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/resellers/{resellerUid}/sites/{siteUid}/vcdReplicationResources/{resourceUid}':
    get:
      tags:
        - Resellers
      summary: Get Reseller VMware Cloud Director Replication Resource
      description: Returns a resource representation of a reseller VMware Cloud Director replication resource with the specified UID.
      operationId: GetResellerSiteVcdReplicationResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: VMware Cloud Director replication resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ResellerSiteVcdReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 020103da-17b8-65e0-8a2e-67761ad5bfff
                  siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                  resellerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                  vcdOrganizationUid: 2bd87f65-35ef-4109-8d27-537085bf1ad2
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ResellerSiteVcdReplicationResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    delete:
      tags:
        - Resellers
      summary: Delete Reseller VMware Cloud Director Replication Resource
      description: Deletes a reseller VMware Cloud Director replication resource with the specified UID.
      operationId: DeleteResellerSiteVcdReplicationResource
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: resourceUid
          in: path
          description: VMware Cloud Director replication resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/resellers/usage:
    get:
      tags:
        - Resellers
      summary: Get Services Usage by All Resellers
      description: Returns a collection resource representation of services consumed by resellers.
      operationId: GetResellersAggregatedUsage
      parameters:
        - name: fromDate
          in: query
          description: Start timestamp of a searched time range.
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          description: End timestamp of a searched time range. Total time range must be less than or equal to 31 day.
          schema:
            type: string
            format: date
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerAggregatedUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - resellerUid: 34c25899-e0b1-4ad4-8bdb-91fb3c545ce8
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 0
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 2196
                        type: AgentCloudBackupDataTransferOut
                      - value: 27914
                        type: AgentCloudBackupDataTransferIn
                      - value: 0
                        type: VbrCloudBackupsDataTransferOut
                      - value: 0
                        type: VbrCloudBackupsDataTransferIn
                      - value: 0
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 0
                        type: VmCloudReplicaStorageUsage
                      - value: 0
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 0
                        type: ManagedServerAgents
                      - value: 1
                        type: ManagedWorkstationAgents
                      - value: 0
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 0
                        type: FileShareBackupSize
                      - value: 0
                        type: FileShareSourceSize
                      - value: 0
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 0
                        type: ManagedAgentsLinuxOS
                      - value: 1
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 0
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 1048576
                        type: CloudTotalUsage
                      - value: 1048576
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 0
                        type: ReplicatedVms
                      - value: 0
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 0
                        type: VbrBackupSize
                  - resellerUid: 3c05a5fd-9680-4e21-8515-3065f9d8f24d
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 0
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 0
                        type: AgentCloudBackupDataTransferOut
                      - value: 0
                        type: AgentCloudBackupDataTransferIn
                      - value: 0
                        type: VbrCloudBackupsDataTransferOut
                      - value: 0
                        type: VbrCloudBackupsDataTransferIn
                      - value: 0
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 0
                        type: VmCloudReplicaStorageUsage
                      - value: 0
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 0
                        type: ManagedServerAgents
                      - value: 0
                        type: ManagedWorkstationAgents
                      - value: 0
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 0
                        type: FileShareBackupSize
                      - value: 0
                        type: FileShareSourceSize
                      - value: 0
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 0
                        type: ManagedAgentsLinuxOS
                      - value: 0
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 0
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 0
                        type: CloudTotalUsage
                      - value: 0
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 0
                        type: ReplicatedVms
                      - value: 0
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 0
                        type: VbrBackupSize
                  - resellerUid: 48389f5a-06d4-4b26-b654-6179895e269b
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 0
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 0
                        type: AgentCloudBackupDataTransferOut
                      - value: 0
                        type: AgentCloudBackupDataTransferIn
                      - value: 0
                        type: VbrCloudBackupsDataTransferOut
                      - value: 0
                        type: VbrCloudBackupsDataTransferIn
                      - value: 0
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 0
                        type: VmCloudReplicaStorageUsage
                      - value: 0
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 0
                        type: ManagedServerAgents
                      - value: 1
                        type: ManagedWorkstationAgents
                      - value: 0
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 0
                        type: FileShareBackupSize
                      - value: 0
                        type: FileShareSourceSize
                      - value: 0
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 0
                        type: ManagedAgentsLinuxOS
                      - value: 1
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 0
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 0
                        type: CloudTotalUsage
                      - value: 0
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 0
                        type: ReplicatedVms
                      - value: 0
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 0
                        type: VbrBackupSize
                  - resellerUid: 934fac17-3923-4cd9-b33b-0b4514c842f3
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 0
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 0
                        type: AgentCloudBackupDataTransferOut
                      - value: 0
                        type: AgentCloudBackupDataTransferIn
                      - value: 0
                        type: VbrCloudBackupsDataTransferOut
                      - value: 0
                        type: VbrCloudBackupsDataTransferIn
                      - value: 0
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 0
                        type: VmCloudReplicaStorageUsage
                      - value: 0
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 0
                        type: ManagedServerAgents
                      - value: 0
                        type: ManagedWorkstationAgents
                      - value: 0
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 0
                        type: FileShareBackupSize
                      - value: 0
                        type: FileShareSourceSize
                      - value: 0
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 0
                        type: ManagedAgentsLinuxOS
                      - value: 0
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 0
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 0
                        type: CloudTotalUsage
                      - value: 0
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 0
                        type: ReplicatedVms
                      - value: 0
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 0
                        type: VbrBackupSize
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/resellers/{resellerUid}/usage':
    get:
      tags:
        - Resellers
      summary: Get Services Usage by Reseller
      description: Returns a collection resource representation of services consumed by a reseller with the specified UID.
      operationId: GetResellerAggregatedUsage
      parameters:
        - $ref: '#/components/parameters/resellerUid_path'
        - name: fromDate
          in: query
          description: Start timestamp of a searched time range.
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          description: End timestamp of a searched time range. Total time range must be less than or equal to 31 day.
          schema:
            type: string
            format: date
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResellerAggregatedUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - resellerUid: 34c25899-e0b1-4ad4-8bdb-91fb3c545ce8
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 0
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 2196
                        type: AgentCloudBackupDataTransferOut
                      - value: 27914
                        type: AgentCloudBackupDataTransferIn
                      - value: 0
                        type: VbrCloudBackupsDataTransferOut
                      - value: 0
                        type: VbrCloudBackupsDataTransferIn
                      - value: 0
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 0
                        type: VmCloudReplicaStorageUsage
                      - value: 0
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 0
                        type: ManagedServerAgents
                      - value: 1
                        type: ManagedWorkstationAgents
                      - value: 0
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 0
                        type: FileShareBackupSize
                      - value: 0
                        type: FileShareSourceSize
                      - value: 0
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 0
                        type: ManagedAgentsLinuxOS
                      - value: 1
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 0
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 1048576
                        type: CloudTotalUsage
                      - value: 1048576
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 0
                        type: ReplicatedVms
                      - value: 0
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 0
                        type: VbrBackupSize
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /organizations:
    get:
      tags:
        - Organizations
      summary: Get All Organizations
      description: 'Returns a collection resource representation of all organizations (service provider, resellers, companies).'
      operationId: GetOrganizations
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Organization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: ec1f3101-3703-4b6b-8d19-5b68b1fdf795
                    name: My Company
                    alias: mycompany
                    type: Company
                    taxId: '12345'
                    email: j.smith@mycompany.com
                    phone: 414-351-6025
                    country: 1
                    state: 49
                    countryName: USA
                    regionName: Midwest
                    city: Milwaukee
                    street: 3025 Johnny Lane
                    locationAdmin0Code: us
                    locationAdmin1Code: us-wi
                    locationAdmin2Code: 
                    notes: Company for test
                    zipCode: '53217'
                    website: www.mycompany.com
                    veeamTenantId: 
                  - instanceUid: 61a6c733-d6a9-4540-9698-1d4e3c6bdaab
                    name: Beta
                    alias: beta
                    type: Company
                    taxId: '09876'
                    email: m.lore@beta.com
                    phone: 503-254-0212
                    country: 1
                    state: 37
                    countryName: USA
                    regionName: West
                    city: Portland
                    street: 5006 Gateway Road
                    locationAdmin0Code: us
                    locationAdmin1Code: us-or
                    locationAdmin2Code: 
                    notes: ''
                    zipCode: '97220'
                    website: www.beta.com
                    veeamTenantId: '2'
                  - instanceUid: ece6d725-2fc2-48e6-af85-b78b3778b63c
                    name: Alpha
                    alias: alpha
                    type: Company
                    taxId: '65432'
                    email: t.barb@alpha.com
                    phone: 916-336-1534
                    country: 1
                    state: 5
                    countryName: USA
                    regionName: West
                    city: Sacramento
                    street: Awesome street
                    locationAdmin0Code: us
                    locationAdmin1Code: us-ca
                    locationAdmin2Code: 
                    notes: ''
                    zipCode: '95814'
                    website: www.alpha.com
                    veeamTenantId: '10'
                  - instanceUid: 24ea3be3-79cf-4334-bf35-6f1cf1171020
                    name: Gamma
                    alias: gamma
                    type: Reseller
                    taxId: '57228'
                    email: s.steel@gamma.com
                    phone: 416-988-1635
                    country: 2
                    state: 
                    countryName: Canada
                    regionName: Ontario
                    city: Toronto
                    street: 3920 Merton Street
                    locationAdmin0Code: ca
                    locationAdmin1Code: 
                    locationAdmin2Code: 
                    notes: Basic configuration
                    zipCode: M1L 3K7
                    website: www.gamma.com
                    veeamTenantId: '15'
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/organizations/{organizationUid}':
    get:
      tags:
        - Organizations
      summary: Get Organization
      description: Returns a resource representation of an organization with the specified UID.
      operationId: GetOrganization
      parameters:
        - name: organizationUid
          in: path
          description: Organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Organization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 30780260-6bed-47eb-b1ac-d12de2ce5b9d
                  name: My Company
                  alias: mycompany
                  type: Company
                  taxId: '12345'
                  email: s.smith@mycompany.com
                  phone: 414-351-6025
                  country: 1
                  state: 49
                  countryName: USA
                  regionName: Midwest
                  city: Milwaukee
                  street: 3025 Johnny Lane
                  locationAdmin0Code: us
                  locationAdmin1Code: us-wi
                  locationAdmin2Code: 
                  notes: ''
                  zipCode: '53217'
                  website: www.mycompany.com
                  veeamTenantId: ''
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/Organization'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Organizations
      summary: Modify Organization
      description: Modifies an organization with the specified UID.
      operationId: PatchOrganization
      parameters:
        - name: organizationUid
          in: path
          description: Organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: My Company
                path: /name
                op: replace
              - value: '97220'
                path: /taxid
                op: replace
              - value: m.lore@exon.com
                path: /email
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Organization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                  name: My Company
                  alias: mycompany
                  type: Provider
                  taxId: '12345'
                  email: m.lore@exon.com
                  phone: 503-254-0212
                  country: 1
                  state: 37
                  countryName: USA
                  regionName: West
                  city: Portland
                  street: 5006 Gateway Road
                  locationAdmin0Code: us
                  locationAdmin1Code: us-or
                  locationAdmin2Code: 
                  notes: ''
                  zipCode: '97220'
                  website: www.mycompany.com
                  veeamTenantId: '2'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/Organization'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/configuration/refreshsecuritytoken':
    post:
      tags:
        - Organizations
      summary: Refresh Organization Security Token
      description: Refreshes a security token issued to an organization with the specified UID.
      operationId: RefreshSecurityToken
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/organizations/{organizationUid}/users':
    get:
      tags:
        - Accounts
      summary: Get All Organization Users
      description: Returns a collection resource representation of all users created for a Veeam Service Provider Console organization with the specified UID.
      operationId: GetUsersByOrganization
      parameters:
        - name: organizationUid
          in: path
          description: Organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c37dac86-f273-4133-9bcd-3d5972ef7b40
                    organizationUid: ff98a69f-19dd-4a08-898e-a8a3562fe974
                    userName: administrator
                    status: Enabled
                    mfaPolicyStatus: Enabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanyAdministrator
                    profile:
                      firstName: John
                      lastName: Smith
                      title: Mr
                      email: j.smith@alpha.com
                      address: 
                      phone: 
                    credentials:
                      userName: administrator
                      password: 
                  - instanceUid: 1b4a5ccf-9f2e-4e05-94ff-6e6f2ca5cfd2
                    organizationUid: ff98a69f-19dd-4a08-898e-a8a3562fe974
                    userName: a.west
                    status: Enabled
                    mfaPolicyStatus: Disabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanySubtenant
                    profile:
                      firstName: Adam
                      lastName: West
                      title: Mr
                      email: a.west@alpha.com
                      address: 
                      phone: 410-510-2371
                    credentials:
                      userName: a.west
                      password: 
                  - instanceUid: cd592141-a9ef-448c-b121-5e1a3800e4c1
                    organizationUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    userName: auditor
                    status: Enabled
                    mfaPolicyStatus: Enabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanyInvoiceAuditor
                    profile:
                      firstName: Simon
                      lastName: Cold
                      title: Mr
                      email: s.cold@beta.com
                      address: 
                      phone: 410-510-2317
                    credentials:
                      userName: auditor
                      password: 
                  - instanceUid: c0d22609-861c-4e36-a47d-cd8d05594ffc
                    organizationUid: 5f6e5f1c-03f3-4ac2-98cb-b2937fd5cc3c
                    userName: atlanta
                    status: Enabled
                    mfaPolicyStatus: Enabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanyLocationUser
                    profile:
                      firstName: 
                      lastName: 
                      title: Unknown
                      email: atlanta@delta.com
                      address: 
                      phone: 
                    credentials:
                      userName: atlanta
                      password: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /organizations/provider:
    get:
      tags:
        - Provider
      summary: Get Service Provider
      description: Returns a resource representation of a service provider.
      operationId: GetProvider
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/ProviderExpand'
          x-veeam-expand: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Provider'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                  _embedded:
                    organization:
                      instanceUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                      name: Alpha
                      alias: alpha
                      type: Provider
                      taxId: '65432'
                      email: t.barb@alpha.com
                      phone: 916-336-1534
                      country: 1
                      state: 5
                      countryName: USA
                      regionName: West
                      city: Sacramento
                      street: 3211 Pearl Street
                      locationAdmin0Code: us
                      locationAdmin1Code: us-ca
                      locationAdmin2Code: 
                      notes: ''
                      zipCode: '95814'
                      website: www.alpha.com
                      veeamTenantId: ''
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/provider/companies:
    get:
      tags:
        - Provider
      summary: Get Companies Managed by Service Provider
      description: Returns a collection resource representation of all companies managed by a service provider.
      operationId: GetProviderCompanies
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/CompanyExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Company'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: ac542b05-0b27-4199-ad44-c8429fd70c91
                    name: Beta
                    status: Active
                    resellerUid: 
                    subscriptionPlanUid: 
                    isRestAccessEnabled: false
                    isAlarmDetectEnabled: false
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement:
                          workstationAgentsQuota: 
                          serverAgentsQuota: 
                        backupServersManagement: 
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: betauser
                      password: 
                    _embedded:
                      organization:
                        instanceUid: ac542b05-0b27-4199-ad44-c8429fd70c91
                        name: Beta
                        alias: beta
                        type: Company
                        taxId: '09876'
                        email: m.lore@beta.com
                        phone: 503-254-0212
                        country: 1
                        state: 37
                        countryName: USA
                        regionName: West
                        city: Portland
                        street: 5006 Gateway Road
                        locationAdmin0Code: us
                        locationAdmin1Code: us-or
                        locationAdmin2Code: 
                        notes: Company with network appliance
                        zipCode: '97220'
                        website: www.beta.com
                        veeamTenantId: '2'
                        companyId: 
                  - instanceUid: c3710a5b-2be3-45ba-bae3-5bf171ac6a8a
                    name: Alpha
                    status: Active
                    resellerUid: 
                    subscriptionPlanUid: 
                    isRestAccessEnabled: true
                    isAlarmDetectEnabled: false
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement: 
                        backupServersManagement: 
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: alphauser
                      password: 
                    _embedded:
                      organization:
                        instanceUid: c3710a5b-2be3-45ba-bae3-5bf171ac6a8a
                        name: Alpha
                        alias: alpha
                        type: Company
                        taxId: '65432'
                        email: t.barb@alpha.com
                        phone: 916-336-1534
                        country: 1
                        state: 5
                        countryName: USA
                        regionName: West
                        city: Sacramento
                        street: 3211 Pearl Street
                        locationAdmin0Code: us
                        locationAdmin1Code: us-ca
                        locationAdmin2Code: 
                        notes: Company with network appliance
                        zipCode: '95814'
                        website: alpha.com
                        veeamTenantId: '1'
                        companyId: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/companies:
    get:
      tags:
        - Companies
      summary: Get All Companies
      description: Returns a collection resource representation of all companies managed in Veeam Service Provider Console.
      operationId: GetCompanies
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/CompanyExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Company'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: eb866e8f-a0f5-41f4-9dd9-8cc59266ff25
                    name: Alpha
                    status: Active
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    subscriptionPlanUid: 615808c7-12ba-4cd4-a1c2-3ba78d95fbe9
                    isRestAccessEnabled: true
                    isAlarmDetectEnabled: true
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement:
                          workstationAgentsQuota: 20
                          serverAgentsQuota: 20
                        backupServersManagement:
                          backupServerQuota: 20
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: alphauser
                      password: 
                    _embedded:
                      organization: 
                  - instanceUid: 279595ca-2027-4110-abc8-63619d14e25a
                    name: Beta
                    status: Active
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    subscriptionPlanUid: 
                    isRestAccessEnabled: true
                    isAlarmDetectEnabled: false
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement:
                          workstationAgentsQuota: 20
                          serverAgentsQuota: 20
                        backupServersManagement:
                          backupServerQuota: 20
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: betauser
                      password: 
                    _embedded:
                      organization: 
                  - instanceUid: 7ca63e96-ec3d-49ca-ba94-92607960ae6f
                    name: Gamma
                    status: Active
                    resellerUid: 48389f5a-06d4-4b26-b654-6179895e269b
                    subscriptionPlanUid: 
                    isRestAccessEnabled: true
                    isAlarmDetectEnabled: false
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement:
                          workstationAgentsQuota: 20
                          serverAgentsQuota: 20
                        backupServersManagement:
                          backupServerQuota: 20
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: gammauser
                      password: 
                    _embedded:
                      organization: 
                  - instanceUid: 109b93fc-50f1-4f83-8cec-16652ef0e047
                    name: Delta
                    status: Active
                    resellerUid: af50079c-9485-4ca4-ac50-867ace76731c
                    subscriptionPlanUid: 
                    isRestAccessEnabled: true
                    isAlarmDetectEnabled: false
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement:
                          workstationAgentsQuota: 20
                          serverAgentsQuota: 20
                        backupServersManagement:
                          backupServerQuota: 20
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: deltauser
                      password: 
                    _embedded:
                      organization: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Companies
      summary: Create Company
      description: "Creates a new company managed in Veeam Service Provider Console.\n"
      operationId: CreateCompany
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Company properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyInput'
            example:
              resellerUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              organizationInput:
                name: Alpha
                alias: alpha
                taxId: 643-70-9745
                email: s.smith@alpha.com
                phone: 906-284-7082
                country: 1
                state: 22
                countryName: USA
                regionName: Midwest
                city: Marquette
                street: 4493 Railroad Street
                locationAdmin0Code: 
                locationAdmin1Code: 
                locationAdmin2Code: 
                notes: 
                zipCode: '49855'
                website: www.alpha.com
                veeamTenantId: 
                companyId: 
              subscriptionPlanUid: 
              isRestAccessEnabled: true
              isAlarmDetectEnabled: false
              companyServices:
                hostedServices:
                  isVbPublicCloudManagementEnabled: false
                remoteServices:
                  isBackupResourcesEnabled: true
                  backupAgentsManagement: 
                  backupServersManagement: 
                  vb365ServersManagement: 
                  isVbPublicCloudManagementEnabled: false
              ownerCredentials:
                userName: alphaowner
                password: Password1
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Company'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  name: Alpha
                  status: Active
                  resellerUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  subscriptionPlanUid: 
                  isRestAccessEnabled: true
                  isAlarmDetectEnabled: false
                  companyServices:
                    hostedServices:
                      isVbPublicCloudManagementEnabled: false
                    remoteServices:
                      isBackupResourcesEnabled: true
                      backupAgentsManagement: 
                      backupServersManagement: 
                      vb365ServersManagement: 
                      isVbPublicCloudManagementEnabled: false
                  loginUrl: 
                  ownerCredentials:
                    userName: alphaowner
                    password: 
                  _embedded:
                    organization: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/companies/{companyUid}':
    get:
      tags:
        - Companies
      summary: Get Company
      description: Returns a resource representation of a company with the specified UID.
      operationId: GetCompany
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Company'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 109b93fc-50f1-4f83-8cec-16652ef0e047
                  name: Delta
                  status: Active
                  resellerUid: af50079c-9485-4ca4-ac50-867ace76731c
                  subscriptionPlanUid: 
                  isRestAccessEnabled: true
                  isAlarmDetectEnabled: false
                  companyServices:
                    hostedServices:
                      isVbPublicCloudManagementEnabled: false
                    remoteServices:
                      isBackupResourcesEnabled: true
                      backupAgentsManagement:
                        workstationAgentsQuota: 20
                        serverAgentsQuota: 20
                      backupServersManagement:
                        backupServerQuota: 20
                      vb365ServersManagement: 
                      isVbPublicCloudManagementEnabled: false
                  loginUrl: 
                  ownerCredentials:
                    userName: deltauser
                    password: 
                  _embedded:
                    organization: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/Company'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Companies
      summary: Modify Company
      description: Modifies a company managed in Veeam Service Provider Console.
      operationId: PatchCompany
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Disabled
                path: /status
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Company'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  name: Alpha
                  status: Active
                  resellerUid: 6f213654-b538-4695-ac69-aa677e41862e
                  subscriptionPlanUid: 
                  isRestAccessEnabled: true
                  isAlarmDetectEnabled: false
                  companyServices:
                    hostedServices:
                      isVbPublicCloudManagementEnabled: false
                    remoteServices:
                      isBackupResourcesEnabled: true
                      backupAgentsManagement:
                        workstationAgentsQuota: 20
                        serverAgentsQuota: 20
                      backupServersManagement:
                        backupServerQuota: 20
                      vb365ServersManagement: 
                      isVbPublicCloudManagementEnabled: false
                  loginUrl: 
                  ownerCredentials:
                    userName: alphaowner
                    password: 
                  _embedded:
                    organization: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/Company'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    delete:
      tags:
        - Companies
      summary: Delete Company
      description: Deletes a company with the specified UID.
      operationId: DeleteCompany
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: removeAllAgents
          in: query
          description: Defines if all agents installed on the computers in the company infrastructure must be deleted.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /licensing/sites:
    get:
      tags:
        - Licensing
      summary: Get All Site Licenses
      description: Returns a collection resource representation of all licenses installed on the Veeam Cloud Connect sites.
      operationId: GetSiteLicenses
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SiteLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    autoUpdateEnabled: false
                    edition: Enterprise Plus
                    monitoring: 
                    packages:
                      - Backup
                    company: Alpha
                    email: j.smith@alpha.com
                    contactPerson: 
                    expirationDate: '2028-01-31T01:00:00.0000000+01:00'
                    supportExpirationDate: 
                    licenseIds:
                      - 11112222-1111-2222-3333-111122223333
                    supportIds:
                      - '12345678'
                    sectionTypes:
                      - Instance
                    status: Valid
                    cloudConnect: Yes
                    units: 1000
                    usedUnits: 0
                    unitType: Points
                    type: Rental
                  - siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    autoUpdateEnabled: false
                    edition: Enterprise Plus
                    monitoring: 
                    packages:
                      - Backup
                    company: Alpha
                    email: j.smith@alpha.com
                    contactPerson: 
                    expirationDate: '2028-01-31T01:00:00.0000000+01:00'
                    supportExpirationDate: 
                    licenseIds:
                      - 11112222-1111-2222-3333-111122223333
                    supportIds:
                      - '12345678'
                    sectionTypes:
                      - Instance
                    status: Valid
                    cloudConnect: Yes
                    units: 1000
                    usedUnits: 0
                    unitType: Points
                    type: Rental
                  - siteUid: 0107365a-60f9-422a-832b-485db173d356
                    autoUpdateEnabled: false
                    edition: Enterprise Plus
                    monitoring: 
                    packages:
                      - Backup
                    company: Alpha
                    email: j.smith@alpha.com
                    contactPerson: 
                    expirationDate: '2028-01-31T01:00:00.0000000+01:00'
                    supportExpirationDate: 
                    licenseIds:
                      - 11112222-1111-2222-3333-111122223333
                    supportIds:
                      - '12345678'
                    sectionTypes:
                      - Instance
                    status: Valid
                    cloudConnect: Yes
                    units: 1000
                    usedUnits: 0
                    unitType: Points
                    type: Rental
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
  '/licensing/sites/{siteUid}':
    get:
      tags:
        - Licensing
      summary: Get Site License
      description: Returns a resource representation of a license installed on the Veeam Cloud Connect site with the specified UID.
      operationId: GetSiteLicense
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SiteLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: 0107365a-60f9-422a-832b-485db173d356
                  autoUpdateEnabled: false
                  edition: Enterprise Plus
                  monitoring: 
                  packages:
                    - Backup
                  company: Alpha
                  email: j.smith@alpha.com
                  contactPerson: 
                  expirationDate: '2028-01-31T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseIds:
                    - 11112222-1111-2222-3333-111122223333
                  supportIds:
                    - '12345678'
                  sectionTypes:
                    - Instance
                  status: Valid
                  cloudConnect: Yes
                  units: 1000
                  usedUnits: 0
                  unitType: Points
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
    put:
      tags:
        - Licensing
      summary: Install Site License
      description: Installs a license on the Veeam Cloud Connect site with the specified UID.
      operationId: InstallSiteLicense
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - license
              properties:
                license:
                  type: string
                  description: License file.
                  format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SiteLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: 0107365a-60f9-422a-832b-485db173d356
                  autoUpdateEnabled: false
                  edition: Enterprise Plus
                  monitoring: 
                  packages:
                    - Backup
                  company: Alpha
                  email: j.smith@alpha.com
                  contactPerson: 
                  expirationDate: '2028-01-31T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseIds:
                    - 11112222-1111-2222-3333-111122223333
                  supportIds:
                    - '12345678'
                  sectionTypes:
                    - Instance
                  status: Valid
                  cloudConnect: Yes
                  units: 1000
                  usedUnits: 0
                  unitType: Points
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
    patch:
      tags:
        - Licensing
      summary: Modify Site License
      description: Modifies a license on a Veeam Cloud Connect site with the specified UID.
      operationId: PatchSiteLicense
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 'true'
                path: /autoUpdateEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SiteLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  autoUpdateEnabled: true
                  edition: Enterprise Plus
                  monitoring: 
                  packages:
                    - Backup
                  company: Alpha
                  email: j.smith@alpha.com
                  contactPerson: 
                  expirationDate: '2027-01-31T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseIds:
                    - d60543b8-9a53-473a-8e4c-cfdc374286cf
                  supportIds:
                    - '12345678'
                  sectionTypes:
                    - Instance
                  status: Valid
                  cloudConnect: Yes
                  units: 1000
                  usedUnits: 0
                  unitType: Points
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/SiteLicense'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
  '/licensing/sites/{siteUid}/update':
    post:
      tags:
        - Licensing
      summary: Update Site License
      description: Downloads a license from the Internet and installs it on the Veeam Cloud Connect site with the specified UID.
      operationId: UpdateSiteLicense
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SiteLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: 0107365a-60f9-422a-832b-485db173d356
                  autoUpdateEnabled: false
                  edition: Enterprise Plus
                  monitoring: 
                  packages:
                    - Backup
                  company: Alpha
                  email: j.smith@alpha.com
                  contactPerson: 
                  expirationDate: '2028-01-31T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseIds:
                    - 11112222-1111-2222-3333-111122223333
                  supportIds:
                    - '12345678'
                  sectionTypes:
                    - Instance
                  status: Valid
                  cloudConnect: Yes
                  units: 1000
                  usedUnits: 0
                  unitType: Points
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
  /licensing/reports:
    get:
      tags:
        - Licensing
      summary: Get All License Usage Reports
      description: Returns a collection resource representation of the Veeam license usage reports.
      operationId: GetLicensingReports
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SingleLicenseReport'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - reportStatus: ApprovalRequired
                    reportParameters:
                      reportId: 1
                      organizationName: My Company
                      organizationUid: 138f54fc-8bac-5603-85d3-a5be7b3386a6
                      licenseCompanyName: ''
                      generationDate: '2025-08-08T14:53:16.9530716+02:00'
                      reportInterval:
                        startOfInterval: '2025-07-01T02:00:00.0000000+02:00'
                        endOfInterval: '2025-07-31T02:00:00.0000000+02:00'
                    reportSummary:
                      totalPoints: 161
                      productsUsage:
                        - productType: BackupAndReplication
                          totalPoints: 143
                          licenseEdition: Enterprise Plus
                          workloadUsage:
                            - workloadType: Dynamic
                              description: NAS (250 GB)
                              initialCount: 1
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: VM
                              initialCount: 10
                              reportedCount: 10
                              newCount: 0
                              weight: 13
                              usedPoints: 130
                              workloadsByPlatform: [ ]
                        - productType: VSPC
                          totalPoints: 18
                          licenseEdition: Standard
                          workloadUsage:
                            - workloadType: Dynamic
                              description: Server agent
                              initialCount: 2
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: Workstation agent
                              initialCount: 1
                              reportedCount: 1
                              newCount: 1
                              weight: 5
                              usedPoints: 5
                              workloadsByPlatform: [ ]
                    organizationsUsage:
                      - organizationType: Reseller
                        organizationName: Beta
                        organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                        usedPoints: 161
                    notCollectedCloudServers: 
                    clonedCloudServers: 
                    unsupportedCloudServers: 
                    usageDetails:
                      - organizationName: Sigma
                        organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                        supportId: '00276360'
                        notCollectedClientServers: [ ]
                        clonedClientServers: 
                        unsupportedClientServers: 
                        usageByLicenseAndProduct:
                          - licenseId: 11112222-1111-2222-3333-111122223333
                            productType: BackupAndReplication
                            licenseEdition: Enterprise Plus
                            usedPoints: 143
                            workloadUsage:
                              - workloadType: Dynamic
                                description: NAS (250 GB)
                                initialCount: 1
                                reportedCount: 1
                                newCount: 0
                                weight: 13
                                usedPoints: 13
                                workloadsByPlatform: [ ]
                              - workloadType: Dynamic
                                description: VM
                                initialCount: 10
                                reportedCount: 10
                                newCount: 0
                                weight: 13
                                usedPoints: 130
                                workloadsByPlatform: [ ]
                    appendices:
                      - licenseCompanyName: Veeam Software AG
                        appendixSummary:
                          totalPoints: 30
                          productsUsage:
                            - productType: CloudConnect
                              totalPoints: 30
                              licenseEdition: Enterprise Plus
                              workloadUsage:
                                - workloadType: Dynamic
                                  description: VM Cloud Replica
                                  initialCount: 5
                                  reportedCount: 3
                                  newCount: 0
                                  weight: 10
                                  usedPoints: 30
                                  workloadsByPlatform: [ ]
                        organizationsUsage:
                          - organizationType: Reseller
                            organizationName: Beta
                            organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                            usedPoints: 30
                        notCollectedCloudServers:
                          - v3t1
                        clonedCloudServers: 
                        unsupportedCloudServers: 
                        usageDetails:
                          - organizationName: Sigma
                            organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                            supportId: '00276360'
                            notCollectedClientServers: [ ]
                            clonedClientServers: 
                            unsupportedClientServers: 
                            usageByLicenseAndProduct:
                              - licenseId: 11112222-1111-2222-3333-111122223333
                                productType: CloudConnect
                                licenseEdition: Enterprise Plus
                                usedPoints: 30
                                workloadUsage:
                                  - workloadType: Dynamic
                                    description: VM Cloud Replica
                                    initialCount: 5
                                    reportedCount: 3
                                    newCount: 0
                                    weight: 10
                                    usedPoints: 30
                                    workloadsByPlatform: [ ]
                  - reportStatus: ApprovalRequired
                    reportParameters:
                      reportId: 2
                      organizationName: Alpha
                      organizationUid: 138f54fc-8bac-5683-85d3-a5be7b3386a6
                      licenseCompanyName: Veeam Software Group GmbH
                      generationDate: '2025-08-08T14:53:16.9530716+02:00'
                      reportInterval:
                        startOfInterval: '2025-07-01T02:00:00.0000000+02:00'
                        endOfInterval: '2025-07-31T02:00:00.0000000+02:00'
                    reportSummary:
                      totalPoints: 161
                      productsUsage:
                        - productType: BackupAndReplication
                          totalPoints: 143
                          licenseEdition: Enterprise Plus
                          workloadUsage:
                            - workloadType: Dynamic
                              description: NAS (250 GB)
                              initialCount: 1
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: VM
                              initialCount: 10
                              reportedCount: 10
                              newCount: 0
                              weight: 13
                              usedPoints: 130
                              workloadsByPlatform: [ ]
                        - productType: VSPC
                          totalPoints: 18
                          licenseEdition: Standard
                          workloadUsage:
                            - workloadType: Dynamic
                              description: Server agent
                              initialCount: 2
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: Workstation agent
                              initialCount: 1
                              reportedCount: 1
                              newCount: 1
                              weight: 5
                              usedPoints: 5
                              workloadsByPlatform: [ ]
                    organizationsUsage:
                      - organizationType: Reseller
                        organizationName: Beta
                        organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                        usedPoints: 161
                    notCollectedCloudServers: 
                    clonedCloudServers: 
                    unsupportedCloudServers: 
                    usageDetails:
                      - organizationName: Sigma
                        organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                        supportId: '00276360'
                        notCollectedClientServers: [ ]
                        clonedClientServers: 
                        unsupportedClientServers: 
                        usageByLicenseAndProduct:
                          - licenseId: 11112222-1111-2222-3333-111122223333
                            productType: BackupAndReplication
                            licenseEdition: Enterprise Plus
                            usedPoints: 143
                            workloadUsage:
                              - workloadType: Dynamic
                                description: NAS (250 GB)
                                initialCount: 1
                                reportedCount: 1
                                newCount: 0
                                weight: 13
                                usedPoints: 13
                                workloadsByPlatform: [ ]
                              - workloadType: Dynamic
                                description: VM
                                initialCount: 10
                                reportedCount: 10
                                newCount: 0
                                weight: 13
                                usedPoints: 130
                                workloadsByPlatform: [ ]
                    appendices:
                      - licenseCompanyName: Veeam Software AG
                        appendixSummary:
                          totalPoints: 30
                          productsUsage:
                            - productType: CloudConnect
                              totalPoints: 30
                              licenseEdition: Enterprise Plus
                              workloadUsage:
                                - workloadType: Dynamic
                                  description: VM Cloud Replica
                                  initialCount: 5
                                  reportedCount: 3
                                  newCount: 0
                                  weight: 10
                                  usedPoints: 30
                                  workloadsByPlatform: [ ]
                        organizationsUsage:
                          - organizationType: Reseller
                            organizationName: Beta
                            organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                            usedPoints: 30
                        notCollectedCloudServers:
                          - restv3t1
                        clonedCloudServers: 
                        unsupportedCloudServers: 
                        usageDetails:
                          - organizationName: Sigma
                            organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                            supportId: '00276360'
                            notCollectedClientServers: [ ]
                            clonedClientServers: 
                            unsupportedClientServers: 
                            usageByLicenseAndProduct:
                              - licenseId: 11112222-1111-2222-3333-111122223333
                                productType: CloudConnect
                                licenseEdition: Enterprise Plus
                                usedPoints: 30
                                workloadUsage:
                                  - workloadType: Dynamic
                                    description: VM Cloud Replica
                                    initialCount: 5
                                    reportedCount: 3
                                    newCount: 0
                                    weight: 10
                                    usedPoints: 30
                                    workloadsByPlatform: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /licensing/reports/latest:
    get:
      tags:
        - Licensing
      summary: Get Latest License Usage Reports
      description: Returns a collection resource representation of the latest Veeam license usage reports.
      operationId: GetLatestLicensingReports
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SingleLicenseReport'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - reportStatus: ApprovalRequired
                    reportParameters:
                      reportId: 1
                      organizationName: My Company
                      organizationUid: 138f54fc-8bac-5603-85d3-a5be7b3386a6
                      licenseCompanyName: ''
                      generationDate: '2025-08-08T14:53:16.9530716+02:00'
                      reportInterval:
                        startOfInterval: '2025-07-01T02:00:00.0000000+02:00'
                        endOfInterval: '2025-07-31T02:00:00.0000000+02:00'
                    reportSummary:
                      totalPoints: 161
                      productsUsage:
                        - productType: BackupAndReplication
                          totalPoints: 143
                          licenseEdition: Enterprise Plus
                          workloadUsage:
                            - workloadType: Dynamic
                              description: NAS (250 GB)
                              initialCount: 1
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: VM
                              initialCount: 10
                              reportedCount: 10
                              newCount: 0
                              weight: 13
                              usedPoints: 130
                              workloadsByPlatform: [ ]
                        - productType: VSPC
                          totalPoints: 18
                          licenseEdition: Standard
                          workloadUsage:
                            - workloadType: Dynamic
                              description: Server agent
                              initialCount: 2
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: Workstation agent
                              initialCount: 1
                              reportedCount: 1
                              newCount: 1
                              weight: 5
                              usedPoints: 5
                              workloadsByPlatform: [ ]
                    organizationsUsage:
                      - organizationType: Reseller
                        organizationName: Beta
                        organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                        usedPoints: 161
                    notCollectedCloudServers: 
                    clonedCloudServers: 
                    unsupportedCloudServers: 
                    usageDetails:
                      - organizationName: Sigma
                        organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                        supportId: '00276360'
                        notCollectedClientServers: [ ]
                        clonedClientServers: 
                        unsupportedClientServers: 
                        usageByLicenseAndProduct:
                          - licenseId: 11112222-1111-2222-3333-111122223333
                            productType: BackupAndReplication
                            licenseEdition: Enterprise Plus
                            usedPoints: 143
                            workloadUsage:
                              - workloadType: Dynamic
                                description: NAS (250 GB)
                                initialCount: 1
                                reportedCount: 1
                                newCount: 0
                                weight: 13
                                usedPoints: 13
                                workloadsByPlatform: [ ]
                              - workloadType: Dynamic
                                description: VM
                                initialCount: 10
                                reportedCount: 10
                                newCount: 0
                                weight: 13
                                usedPoints: 130
                                workloadsByPlatform: [ ]
                    appendices:
                      - licenseCompanyName: Veeam Software AG
                        appendixSummary:
                          totalPoints: 30
                          productsUsage:
                            - productType: CloudConnect
                              totalPoints: 30
                              licenseEdition: Enterprise Plus
                              workloadUsage:
                                - workloadType: Dynamic
                                  description: VM Cloud Replica
                                  initialCount: 5
                                  reportedCount: 3
                                  newCount: 0
                                  weight: 10
                                  usedPoints: 30
                                  workloadsByPlatform: [ ]
                        organizationsUsage:
                          - organizationType: Reseller
                            organizationName: Beta
                            organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                            usedPoints: 30
                        notCollectedCloudServers:
                          - v3t1
                        clonedCloudServers: 
                        unsupportedCloudServers: 
                        usageDetails:
                          - organizationName: Sigma
                            organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                            supportId: '00276360'
                            notCollectedClientServers: [ ]
                            clonedClientServers: 
                            unsupportedClientServers: 
                            usageByLicenseAndProduct:
                              - licenseId: 11112222-1111-2222-3333-111122223333
                                productType: CloudConnect
                                licenseEdition: Enterprise Plus
                                usedPoints: 30
                                workloadUsage:
                                  - workloadType: Dynamic
                                    description: VM Cloud Replica
                                    initialCount: 5
                                    reportedCount: 3
                                    newCount: 0
                                    weight: 10
                                    usedPoints: 30
                                    workloadsByPlatform: [ ]
                  - reportStatus: ApprovalRequired
                    reportParameters:
                      reportId: 2
                      organizationName: Alpha
                      organizationUid: 138f54fc-8bac-5683-85d3-a5be7b3386a6
                      licenseCompanyName: Veeam Software Group GmbH
                      generationDate: '2025-08-08T14:53:16.9530716+02:00'
                      reportInterval:
                        startOfInterval: '2025-07-01T02:00:00.0000000+02:00'
                        endOfInterval: '2025-07-31T02:00:00.0000000+02:00'
                    reportSummary:
                      totalPoints: 161
                      productsUsage:
                        - productType: BackupAndReplication
                          totalPoints: 143
                          licenseEdition: Enterprise Plus
                          workloadUsage:
                            - workloadType: Dynamic
                              description: NAS (250 GB)
                              initialCount: 1
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: VM
                              initialCount: 10
                              reportedCount: 10
                              newCount: 0
                              weight: 13
                              usedPoints: 130
                              workloadsByPlatform: [ ]
                        - productType: VSPC
                          totalPoints: 18
                          licenseEdition: Standard
                          workloadUsage:
                            - workloadType: Dynamic
                              description: Server agent
                              initialCount: 2
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: Workstation agent
                              initialCount: 1
                              reportedCount: 1
                              newCount: 1
                              weight: 5
                              usedPoints: 5
                              workloadsByPlatform: [ ]
                    organizationsUsage:
                      - organizationType: Reseller
                        organizationName: Beta
                        organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                        usedPoints: 161
                    notCollectedCloudServers: 
                    clonedCloudServers: 
                    unsupportedCloudServers: 
                    usageDetails:
                      - organizationName: Sigma
                        organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                        supportId: '00276360'
                        notCollectedClientServers: [ ]
                        clonedClientServers: 
                        unsupportedClientServers: 
                        usageByLicenseAndProduct:
                          - licenseId: 11112222-1111-2222-3333-111122223333
                            productType: BackupAndReplication
                            licenseEdition: Enterprise Plus
                            usedPoints: 143
                            workloadUsage:
                              - workloadType: Dynamic
                                description: NAS (250 GB)
                                initialCount: 1
                                reportedCount: 1
                                newCount: 0
                                weight: 13
                                usedPoints: 13
                                workloadsByPlatform: [ ]
                              - workloadType: Dynamic
                                description: VM
                                initialCount: 10
                                reportedCount: 10
                                newCount: 0
                                weight: 13
                                usedPoints: 130
                                workloadsByPlatform: [ ]
                    appendices:
                      - licenseCompanyName: Veeam Software AG
                        appendixSummary:
                          totalPoints: 30
                          productsUsage:
                            - productType: CloudConnect
                              totalPoints: 30
                              licenseEdition: Enterprise Plus
                              workloadUsage:
                                - workloadType: Dynamic
                                  description: VM Cloud Replica
                                  initialCount: 5
                                  reportedCount: 3
                                  newCount: 0
                                  weight: 10
                                  usedPoints: 30
                                  workloadsByPlatform: [ ]
                        organizationsUsage:
                          - organizationType: Reseller
                            organizationName: Beta
                            organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                            usedPoints: 30
                        notCollectedCloudServers:
                          - restv3t1
                        clonedCloudServers: 
                        unsupportedCloudServers: 
                        usageDetails:
                          - organizationName: Sigma
                            organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                            supportId: '00276360'
                            notCollectedClientServers: [ ]
                            clonedClientServers: 
                            unsupportedClientServers: 
                            usageByLicenseAndProduct:
                              - licenseId: 11112222-1111-2222-3333-111122223333
                                productType: CloudConnect
                                licenseEdition: Enterprise Plus
                                usedPoints: 30
                                workloadUsage:
                                  - workloadType: Dynamic
                                    description: VM Cloud Replica
                                    initialCount: 5
                                    reportedCount: 3
                                    newCount: 0
                                    weight: 10
                                    usedPoints: 30
                                    workloadsByPlatform: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/licensing/reports/{id}/csv':
    get:
      tags:
        - Licensing
      summary: Download License Usage Report
      description: Returns a download link to a license usage report with the specified ID in the `CSV` format.
      operationId: DownloadLicensingReportCsv
      parameters:
        - name: id
          in: path
          description: License usage report ID.
          required: true
          schema:
            type: integer
            format: int32
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/csv:
              schema:
                type: string
                format: binary
        '520':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example: blob:https://vspc1.tech.local:1280/b1024826-78bb-4a35-aeaa-ee080087eab5
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/licensing/reports/{date}':
    get:
      tags:
        - Licensing
      summary: Get License Usage Reports for Date
      description: Returns a collection resource representation of the Veeam license usage reports with the specified generation date.
      operationId: GetLicensingReportsForDate
      parameters:
        - name: date
          in: path
          description: 'Month for which a report was generated, in the YYYY-MM format.'
          required: true
          schema:
            type: string
            format: date
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SingleLicenseReport'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - reportStatus: ApprovalRequired
                    reportParameters:
                      reportId: 1
                      organizationName: My Company
                      organizationUid: 138f54fc-8bac-5603-85d3-a5be7b3386a6
                      licenseCompanyName: ''
                      generationDate: '2025-08-08T14:53:16.9530716+02:00'
                      reportInterval:
                        startOfInterval: '2025-07-01T02:00:00.0000000+02:00'
                        endOfInterval: '2025-07-31T02:00:00.0000000+02:00'
                    reportSummary:
                      totalPoints: 161
                      productsUsage:
                        - productType: BackupAndReplication
                          totalPoints: 143
                          licenseEdition: Enterprise Plus
                          workloadUsage:
                            - workloadType: Dynamic
                              description: NAS (250 GB)
                              initialCount: 1
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: VM
                              initialCount: 10
                              reportedCount: 10
                              newCount: 0
                              weight: 13
                              usedPoints: 130
                              workloadsByPlatform: [ ]
                        - productType: VSPC
                          totalPoints: 18
                          licenseEdition: Standard
                          workloadUsage:
                            - workloadType: Dynamic
                              description: Server agent
                              initialCount: 2
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: Workstation agent
                              initialCount: 1
                              reportedCount: 1
                              newCount: 1
                              weight: 5
                              usedPoints: 5
                              workloadsByPlatform: [ ]
                    organizationsUsage:
                      - organizationType: Reseller
                        organizationName: Beta
                        organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                        usedPoints: 161
                    notCollectedCloudServers: 
                    clonedCloudServers: 
                    unsupportedCloudServers: 
                    usageDetails:
                      - organizationName: Sigma
                        organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                        supportId: '00276360'
                        notCollectedClientServers: [ ]
                        clonedClientServers: 
                        unsupportedClientServers: 
                        usageByLicenseAndProduct:
                          - licenseId: 11112222-1111-2222-3333-111122223333
                            productType: BackupAndReplication
                            licenseEdition: Enterprise Plus
                            usedPoints: 143
                            workloadUsage:
                              - workloadType: Dynamic
                                description: NAS (250 GB)
                                initialCount: 1
                                reportedCount: 1
                                newCount: 0
                                weight: 13
                                usedPoints: 13
                                workloadsByPlatform: [ ]
                              - workloadType: Dynamic
                                description: VM
                                initialCount: 10
                                reportedCount: 10
                                newCount: 0
                                weight: 13
                                usedPoints: 130
                                workloadsByPlatform: [ ]
                    appendices:
                      - licenseCompanyName: Veeam Software AG
                        appendixSummary:
                          totalPoints: 30
                          productsUsage:
                            - productType: CloudConnect
                              totalPoints: 30
                              licenseEdition: Enterprise Plus
                              workloadUsage:
                                - workloadType: Dynamic
                                  description: VM Cloud Replica
                                  initialCount: 5
                                  reportedCount: 3
                                  newCount: 0
                                  weight: 10
                                  usedPoints: 30
                                  workloadsByPlatform: [ ]
                        organizationsUsage:
                          - organizationType: Reseller
                            organizationName: Beta
                            organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                            usedPoints: 30
                        notCollectedCloudServers:
                          - v3t1
                        clonedCloudServers: 
                        unsupportedCloudServers: 
                        usageDetails:
                          - organizationName: Sigma
                            organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                            supportId: '00276360'
                            notCollectedClientServers: [ ]
                            clonedClientServers: 
                            unsupportedClientServers: 
                            usageByLicenseAndProduct:
                              - licenseId: 11112222-1111-2222-3333-111122223333
                                productType: CloudConnect
                                licenseEdition: Enterprise Plus
                                usedPoints: 30
                                workloadUsage:
                                  - workloadType: Dynamic
                                    description: VM Cloud Replica
                                    initialCount: 5
                                    reportedCount: 3
                                    newCount: 0
                                    weight: 10
                                    usedPoints: 30
                                    workloadsByPlatform: [ ]
                  - reportStatus: ApprovalRequired
                    reportParameters:
                      reportId: 2
                      organizationName: Alpha
                      organizationUid: 138f54fc-8bac-5683-85d3-a5be7b3386a6
                      licenseCompanyName: Veeam Software Group GmbH
                      generationDate: '2025-08-08T14:53:16.9530716+02:00'
                      reportInterval:
                        startOfInterval: '2025-07-01T02:00:00.0000000+02:00'
                        endOfInterval: '2025-07-31T02:00:00.0000000+02:00'
                    reportSummary:
                      totalPoints: 161
                      productsUsage:
                        - productType: BackupAndReplication
                          totalPoints: 143
                          licenseEdition: Enterprise Plus
                          workloadUsage:
                            - workloadType: Dynamic
                              description: NAS (250 GB)
                              initialCount: 1
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: VM
                              initialCount: 10
                              reportedCount: 10
                              newCount: 0
                              weight: 13
                              usedPoints: 130
                              workloadsByPlatform: [ ]
                        - productType: VSPC
                          totalPoints: 18
                          licenseEdition: Standard
                          workloadUsage:
                            - workloadType: Dynamic
                              description: Server agent
                              initialCount: 2
                              reportedCount: 1
                              newCount: 0
                              weight: 13
                              usedPoints: 13
                              workloadsByPlatform: [ ]
                            - workloadType: Dynamic
                              description: Workstation agent
                              initialCount: 1
                              reportedCount: 1
                              newCount: 1
                              weight: 5
                              usedPoints: 5
                              workloadsByPlatform: [ ]
                    organizationsUsage:
                      - organizationType: Reseller
                        organizationName: Beta
                        organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                        usedPoints: 161
                    notCollectedCloudServers: 
                    clonedCloudServers: 
                    unsupportedCloudServers: 
                    usageDetails:
                      - organizationName: Sigma
                        organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                        supportId: '00276360'
                        notCollectedClientServers: [ ]
                        clonedClientServers: 
                        unsupportedClientServers: 
                        usageByLicenseAndProduct:
                          - licenseId: 11112222-1111-2222-3333-111122223333
                            productType: BackupAndReplication
                            licenseEdition: Enterprise Plus
                            usedPoints: 143
                            workloadUsage:
                              - workloadType: Dynamic
                                description: NAS (250 GB)
                                initialCount: 1
                                reportedCount: 1
                                newCount: 0
                                weight: 13
                                usedPoints: 13
                                workloadsByPlatform: [ ]
                              - workloadType: Dynamic
                                description: VM
                                initialCount: 10
                                reportedCount: 10
                                newCount: 0
                                weight: 13
                                usedPoints: 130
                                workloadsByPlatform: [ ]
                    appendices:
                      - licenseCompanyName: Veeam Software AG
                        appendixSummary:
                          totalPoints: 30
                          productsUsage:
                            - productType: CloudConnect
                              totalPoints: 30
                              licenseEdition: Enterprise Plus
                              workloadUsage:
                                - workloadType: Dynamic
                                  description: VM Cloud Replica
                                  initialCount: 5
                                  reportedCount: 3
                                  newCount: 0
                                  weight: 10
                                  usedPoints: 30
                                  workloadsByPlatform: [ ]
                        organizationsUsage:
                          - organizationType: Reseller
                            organizationName: Beta
                            organizationUid: ac9d04a1-4a50-5890-8e82-1881bce59421
                            usedPoints: 30
                        notCollectedCloudServers:
                          - restv3t1
                        clonedCloudServers: 
                        unsupportedCloudServers: 
                        usageDetails:
                          - organizationName: Sigma
                            organizationUid: a69c7e6c-9dd3-4c3d-cdd2-a31353dd81ed
                            supportId: '00276360'
                            notCollectedClientServers: [ ]
                            clonedClientServers: 
                            unsupportedClientServers: 
                            usageByLicenseAndProduct:
                              - licenseId: 11112222-1111-2222-3333-111122223333
                                productType: CloudConnect
                                licenseEdition: Enterprise Plus
                                usedPoints: 30
                                workloadUsage:
                                  - workloadType: Dynamic
                                    description: VM Cloud Replica
                                    initialCount: 5
                                    reportedCount: 3
                                    newCount: 0
                                    weight: 10
                                    usedPoints: 30
                                    workloadsByPlatform: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /licensing/reports/finalization:
    post:
      tags:
        - Licensing
      summary: Finalize License Usage Reports
      description: Finalize the Veeam license usage reports.
      operationId: FinalizeLicensingReports
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LicenseReportFinalizationStatus'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  reportApprovalStatus: Finalization
                  message: Finalization
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /licensing/reports/settings:
    get:
      tags:
        - Licensing
      summary: Get License Usage Report Settings
      description: Returns a resource representation of license usage report settings.
      operationId: GetLicensingReportsSettings
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SingleLicenseReportSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  autoApprove: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/SingleLicenseReportSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Licensing
      summary: Modify License Usage Report Settings
      description: Modifies the Veeam licenses usage reports settings.
      operationId: PatchLicensingReportsSettings
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /AutoApprove
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SingleLicenseReportSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  autoApprove: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/SingleLicenseReportSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /licensing/backupServers:
    get:
      tags:
        - Licensing
      summary: Get All Veeam Backup & Replication Licenses
      description: Returns a collection resource representation of the licenses installed on all managed Veeam Backup & Replication servers.
      operationId: GetBackupServersLicenses
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - backupServerUid: e48b073a-cf2e-42d2-bf3d-3eb8d2c32429
                    autoUpdateEnabled: false
                    edition: Enterprise Plus
                    monitoring: 
                    packages:
                      - Backup
                    company: Beta
                    email: s.johns@beta.com
                    contactPerson: 
                    expirationDate: '2027-01-31T01:00:00.0000000+01:00'
                    supportExpirationDate: 
                    licenseIds:
                      - 11112222-1111-2222-3333-111122223333
                    supportIds:
                      - '12345678'
                    sectionTypes:
                      - Instance
                    status: Valid
                    cloudConnect: No
                    sockets: 0
                    usedSockets: 0
                    capacity: 
                    usedCapacity: 
                    units: 1000
                    usedUnits: 0
                    unitType: Points
                    type: Rental
                  - backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                    autoUpdateEnabled: false
                    edition: Enterprise Plus
                    monitoring: 
                    packages:
                      - Backup
                    company: Beta
                    email: s.johns@beta.com
                    contactPerson: 
                    expirationDate: '2027-01-31T01:00:00.0000000+01:00'
                    supportExpirationDate: 
                    licenseIds:
                      - e8bc6e2f-d91b-0916-9d6c-368369526fcc
                    supportIds:
                      - '87654321'
                    sectionTypes:
                      - Instance
                    status: Valid
                    cloudConnect: No
                    sockets: 0
                    usedSockets: 0
                    capacity: 
                    usedCapacity: 
                    units: 1000
                    usedUnits: 0
                    unitType: Points
                    type: Rental
                  - backupServerUid: a6305f3c-46be-4c06-9bc4-97f2449d881f
                    autoUpdateEnabled: false
                    edition: Enterprise Plus
                    monitoring: 
                    packages:
                      - Backup
                    company: Beta
                    email: s.johns@beta.com
                    contactPerson: 
                    expirationDate: '2027-01-31T01:00:00.0000000+01:00'
                    supportExpirationDate: 
                    licenseIds:
                      - e8c59d16-7202-4212-8d4e-7890205c5aa2
                    supportIds:
                      - '11112222'
                    sectionTypes:
                      - Instance
                    status: Valid
                    cloudConnect: No
                    sockets: 0
                    usedSockets: 0
                    capacity: 
                    usedCapacity: 
                    units: 1000
                    usedUnits: 0
                    unitType: Points
                    type: Rental
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/licensing/backupServers/{backupServerUid}':
    get:
      tags:
        - Licensing
      summary: Get Veeam Backup & Replication License
      description: Returns a resource representation of a license installed on a managed Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerLicense
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                  autoUpdateEnabled: false
                  edition: Enterprise Plus
                  monitoring: 
                  packages:
                    - Backup
                  company: Beta
                  email: s.johns@beta.com
                  contactPerson: 
                  expirationDate: '2027-01-31T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseIds:
                    - e8bc6e2f-d91b-0916-9d6c-368369526fcc
                  supportIds:
                    - '87654321'
                  sectionTypes:
                    - Instance
                  status: Valid
                  cloudConnect: No
                  sockets: 0
                  usedSockets: 0
                  capacity: 
                  usedCapacity: 
                  units: 1000
                  usedUnits: 0
                  unitType: Points
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    put:
      tags:
        - Licensing
      summary: Install Veeam Backup & Replication License
      description: Install a license on a managed Veeam Backup & Replication server with the specified UID.
      operationId: InstallBackupServerLicense
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - license
              properties:
                license:
                  type: string
                  description: License file.
                  format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                  autoUpdateEnabled: false
                  edition: Enterprise Plus
                  monitoring: 
                  packages:
                    - Backup
                  company: Beta
                  email: s.johns@beta.com
                  contactPerson: 
                  expirationDate: '2027-01-31T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseIds:
                    - e8bc6e2f-d91b-0916-9d6c-368369526fcc
                  supportIds:
                    - '87654321'
                  sectionTypes:
                    - Instance
                  status: Valid
                  cloudConnect: No
                  sockets: 0
                  usedSockets: 0
                  capacity: 
                  usedCapacity: 
                  units: 1000
                  usedUnits: 0
                  unitType: Points
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    delete:
      tags:
        - Licensing
      summary: Delete Veeam Backup & Replication License
      description: Deletes a license from a managed Veeam Backup & Replication server with the specified UID.
      operationId: DeleteBackupServerLicense
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: sectionForDelete
          in: query
          description: License section that must be deleted.
          required: true
          schema:
            enum:
              - Socket
              - Instance
              - All
            type: string
            default: All
          x-ms-enum:
            name: LicenseSectionTypeForDelete
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    patch:
      tags:
        - Licensing
      summary: Modify Veeam Backup & Replication License
      description: Modifies a license on a managed Veeam Backup & Replication server with the specified UID.
      operationId: PatchBackupServerLicense
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 'true'
                path: /autoUpdateEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupServerUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  autoUpdateEnabled: true
                  edition: Enterprise Plus
                  monitoring: 
                  packages:
                    - Backup
                  company: Beta
                  email: s.johns@beta.com
                  contactPerson: 
                  expirationDate: '2027-01-31T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseIds:
                    - d60543b8-9a53-473a-8e4c-cfdc374286cf
                  supportIds:
                    - '11112222'
                  sectionTypes:
                    - Instance
                  status: Valid
                  cloudConnect: No
                  sockets: 0
                  usedSockets: 0
                  capacity: 
                  usedCapacity: 
                  units: 1000
                  usedUnits: 0
                  unitType: Points
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BackupServerLicense'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/licensing/backupServers/{backupServerUid}/update':
    post:
      tags:
        - Licensing
      summary: Update Veeam Backup & Replication License
      description: Downloads a new license from the Internet and installs it on a Veeam Backup & Replication server.
      operationId: UpdateBackupServerLicense
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                  autoUpdateEnabled: false
                  edition: Enterprise Plus
                  monitoring: 
                  packages:
                    - Backup
                  company: Beta
                  email: s.johns@beta.com
                  contactPerson: 
                  expirationDate: '2027-01-31T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseIds:
                    - e8bc6e2f-d91b-0916-9d6c-368369526fcc
                  supportIds:
                    - '87654321'
                  sectionTypes:
                    - Instance
                  status: Valid
                  cloudConnect: No
                  sockets: 0
                  usedSockets: 0
                  capacity: 
                  usedCapacity: 
                  units: 1000
                  usedUnits: 0
                  unitType: Points
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /licensing/voneServers:
    get:
      tags:
        - Licensing
      summary: Get All Veeam One Licenses
      description: Returns a collection resource representation of the licenses installed on all managed Veeam One servers.
      operationId: GetVOneServersLicenses
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VOneServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - vOneServerUid: fbf6c357-50c6-4ad7-8f61-0fd71ad8fb4c
                    autoUpdateEnabled: true
                    company: Alpha
                    email: p.smith@alpha.com
                    expirationDate: '2024-01-01T09:00:00.0000000+01:00'
                    supportExpirationDate: 
                    licenseId: 687097ac-ba17-0098-94bf-264be7e81bab
                    supportId: '12345678'
                    status: Valid
                    statusMessage: Valid (347 days until expiration)
                    units: 10000
                    usedUnits: 18
                    unitType: Points
                    type: Rental
                  - vOneServerUid: 504ee941-5a10-4143-83c3-72bcf07daeca
                    autoUpdateEnabled: true
                    company: Alpha
                    email: p.smith@alpha.com
                    expirationDate: '2024-01-01T01:00:00.0000000+01:00'
                    supportExpirationDate: 
                    licenseId: 687097ac-ba17-0098-94bf-264be7e81bab
                    supportId: '12345678'
                    status: Valid
                    statusMessage: Valid (347 days until expiration)
                    units: 10000
                    usedUnits: 
                    unitType: Unknown
                    type: Rental
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/licensing/voneServers/{vOneServerUid}':
    get:
      tags:
        - Licensing
      summary: Get Veeam One License
      description: Returns a resource representation of a license installed on a managed Veeam One server with the specified UID.
      operationId: GetVOneServerLicense
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam One server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VOneServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  vOneServerUid: 504ee941-5a10-4143-83c3-72bcf07daeca
                  autoUpdateEnabled: true
                  company: Alpha
                  email: p.smith@alpha.com
                  expirationDate: '2024-01-01T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseId: 687097ac-ba17-0098-94bf-264be7e81bab
                  supportId: '12345678'
                  status: Valid
                  statusMessage: Valid (347 days until expiration)
                  units: 10000
                  usedUnits: 
                  unitType: Unknown
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    put:
      tags:
        - Licensing
      summary: Install Veeam One License
      description: Install a license on a managed Veeam One server with the specified UID.
      operationId: InstallVOneServerLicense
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam One server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - license
              properties:
                license:
                  type: string
                  description: License file.
                  format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VOneServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  vOneServerUid: 504ee941-5a10-4143-83c3-72bcf07daeca
                  autoUpdateEnabled: true
                  company: Alpha
                  email: j.smith@alpha.com
                  expirationDate: '2024-01-01T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseId: 687097ac-ba17-0098-94bf-264be7e81bab
                  supportId: '12345678'
                  status: Valid
                  statusMessage: Valid (347 days until expiration)
                  units: 10000
                  usedUnits: 
                  unitType: Unknown
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    delete:
      tags:
        - Licensing
      summary: Delete Veeam One License
      description: Deletes a license from a managed Veeam One server with the specified UID.
      operationId: DeleteVOneServerLicense
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam One server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    patch:
      tags:
        - Licensing
      summary: Modify Veeam One License
      description: Modifies a license on a managed Veeam One server with the specified UID.
      operationId: PatchVOneServerLicense
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam One server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 'true'
                path: /autoUpdateEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VOneServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  vOneServerUid: 504ee941-5a10-4143-83c3-72bcf07daeca
                  autoUpdateEnabled: true
                  company: Alpha
                  email: j.smith@alpha.com
                  expirationDate: '2024-01-01T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseId: 687097ac-ba17-0098-94bf-264be7e81bab
                  supportId: '12345678'
                  status: Valid
                  statusMessage: Valid (347 days until expiration)
                  units: 10000
                  usedUnits: 
                  unitType: Unknown
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/VOneServerLicense'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/licensing/voneServers/{vOneServerUid}/update':
    post:
      tags:
        - Licensing
      summary: Update Veeam One License
      description: Downloads a new license from the Internet and installs it on a Veeam One server.
      operationId: UpdateVOneServerLicense
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam One server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VOneServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  vOneServerUid: 504ee941-5a10-4143-83c3-72bcf07daeca
                  autoUpdateEnabled: true
                  company: Alpha
                  email: j.smith@alpha.com
                  expirationDate: '2024-01-01T01:00:00.0000000+01:00'
                  supportExpirationDate: 
                  licenseId: 687097ac-ba17-0098-94bf-264be7e81bab
                  supportId: '12345678'
                  status: Valid
                  statusMessage: Valid (347 days until expiration)
                  units: 10000
                  usedUnits: 
                  unitType: Unknown
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /licensing/vb365Servers:
    get:
      tags:
        - Licensing
      summary: Get All Veeam Backup for Microsoft 365 Licenses
      description: Returns a collection resource representation of the licenses installed on all managed Veeam Backup for Microsoft 365 servers.
      operationId: GetVb365ServersLicenses
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365ServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                    autoUpdateEnabled: false
                    company: Beta
                    email: s.wilson@beta.com
                    expirationDate: '2023-04-01T02:00:00.0000000+02:00'
                    supportExpirationDate: 
                    licenseId: 6f9619ff-8b86-d011-b42d-00cf4fc964ff
                    supportId: '12345678'
                    status: Valid
                    licensedUsers: 9999
                    protectedUsers: 7
                    type: Rental
                  - vb365ServerUid: d178d909-ff24-42b1-97be-16255178250e
                    autoUpdateEnabled: false
                    company: Beta
                    email: s.wilson@beta.com
                    expirationDate: '2023-04-01T02:00:00.0000000+02:00'
                    supportExpirationDate: 
                    licenseId: 6f9619ff-8b86-d011-b42d-00cf4fc964ff
                    supportId: '12345678'
                    status: Valid
                    licensedUsers: 9999
                    protectedUsers: 0
                    type: Rental
                  - vb365ServerUid: 099a3f2b-0c40-4e22-995b-22c2931bd72f
                    autoUpdateEnabled: false
                    company: Beta
                    email: s.wilson@beta.com
                    expirationDate: '2023-04-01T02:00:00.0000000+02:00'
                    supportExpirationDate: 
                    licenseId: 6f9619ff-8b86-d011-b42d-00cf4fc964ff
                    supportId: '12345678'
                    status: Valid
                    licensedUsers: 9999
                    protectedUsers: 0
                    type: Rental
                  - vb365ServerUid: 2820441e-7705-4ccf-8cac-74d5d5b6f9d8
                    autoUpdateEnabled: false
                    company: 
                    email: 
                    expirationDate: 
                    supportExpirationDate: 
                    licenseId: 
                    supportId: 
                    status: Unlicensed
                    licensedUsers: 10
                    protectedUsers: 0
                    type: Community
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/licensing/vb365Servers/{vb365ServerUid}':
    get:
      tags:
        - Licensing
      summary: Get Veeam Backup for Microsoft 365 License
      description: Returns a resource representation of a license installed on a managed Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: GetVb365ServerLicense
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365ServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  vb365ServerUid: 2820441e-7705-4ccf-8cac-74d5d5b6f9d8
                  autoUpdateEnabled: false
                  company: 
                  email: 
                  expirationDate: 
                  supportExpirationDate: 
                  licenseId: 
                  supportId: 
                  status: Unlicensed
                  licensedUsers: 10
                  protectedUsers: 0
                  type: Community
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    put:
      tags:
        - Licensing
      summary: Install Veeam Backup for Microsoft 365 License
      description: Install a license on a managed Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: InstallVb365ServerLicense
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - license
              properties:
                license:
                  type: string
                  description: License file.
                  format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365ServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                  autoUpdateEnabled: false
                  company: Beta
                  email: s.wilson@beta.com
                  expirationDate: '2023-04-01T02:00:00.0000000+02:00'
                  supportExpirationDate: 
                  licenseId: 6f9619ff-8b86-d011-b42d-00cf4fc964ff
                  supportId: '12345678'
                  status: Valid
                  licensedUsers: 9999
                  protectedUsers: 7
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    patch:
      tags:
        - Licensing
      summary: Modify Veeam Backup for Microsoft 365 License
      description: Modifies a license on a managed Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: PatchVb365ServerLicense
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 'true'
                path: /autoUpdateEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365ServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                  autoUpdateEnabled: true
                  company: Beta
                  email: s.wilson@beta.com
                  expirationDate: '2023-04-01T02:00:00.0000000+02:00'
                  supportExpirationDate: 
                  licenseId: 6f9619ff-8b86-d011-b42d-00cf4fc964ff
                  supportId: '12345678'
                  status: Valid
                  licensedUsers: 9999
                  protectedUsers: 7
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/Vb365ServerLicense'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/licensing/vb365Servers/{vb365ServerUid}/update':
    post:
      tags:
        - Licensing
      summary: Update Veeam Backup for Microsoft 365 License
      description: Downloads a new license from the Internet and installs it on a Veeam Backup for Microsoft 365 server.
      operationId: UpdateVb365ServerLicense
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365ServerLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                  autoUpdateEnabled: false
                  company: Beta
                  email: s.wilson@beta.com
                  expirationDate: '2023-04-01T02:00:00.0000000+02:00'
                  supportExpirationDate: 
                  licenseId: 6f9619ff-8b86-d011-b42d-00cf4fc964ff
                  supportId: '12345678'
                  status: Valid
                  licensedUsers: 9999
                  protectedUsers: 7
                  type: Rental
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /licensing/console:
    get:
      tags:
        - Licensing
      summary: Get Veeam Service Provider Console License
      description: Returns resource representation of the currently installed Veeam Service Provider Console license.
      operationId: GetConsoleLicenseInformation
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ConsoleLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  licenseId: d688a7d8-fc04-5cad-37fa-e7774c4d5c34
                  edition: Enterprise Plus
                  package: Backup
                  licenseeCompany: My Company
                  licenseeEmail: s.smith@mycompany.com
                  licenseeAdministratorEmail: admin@mycompany.com
                  contactPerson: 
                  expirationDate: '2026-04-04T09:00:00.0000000+02:00'
                  supportExpirationDate: 
                  supportId: '02436535'
                  status: Valid
                  statusMessage: Valid (1171 days until expiration)
                  cloudConnect: Yes
                  instances: 824
                  type: Rental
                  lastUpdateDate: '2023-11-19T12:01:34.4700523+01:00'
                  lastUpdateMessage: License file has been successfully updated.
                  lastUpdateStatus: Success
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    put:
      tags:
        - Licensing
      summary: Install Veeam Service Provider Console License
      description: Installs Veeam Service Provider Console license.
      operationId: InstallConsoleLicense
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          multipart/form-data:
            schema:
              required:
                - license
              properties:
                license:
                  type: string
                  description: License file.
                  format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ConsoleLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  licenseId: d688a7d8-fc04-5cad-37fa-e7774c4d5c34
                  edition: Enterprise Plus
                  package: Backup
                  licenseeCompany: Alpha
                  licenseeEmail: j.smith@alpha.com
                  licenseeAdministratorEmail: 
                  contactPerson: 
                  expirationDate: '2026-03-28T08:00:00.0000000+01:00'
                  supportExpirationDate: 
                  supportId: '02486525'
                  status: Valid
                  statusMessage: Valid (1164 days until expiration)
                  cloudConnect: Yes
                  instances: 824
                  type: Rental
                  lastUpdateDate: '2023-11-19T04:00:51.4384465+01:00'
                  lastUpdateMessage: 
                  lastUpdateStatus: Success
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /licensing/console/update:
    post:
      tags:
        - Licensing
      summary: Update Veeam Service Provider Console License
      description: Downloads a new Veeam Service Provider Console license from the Internet and installs it.
      operationId: UpdateConsoleLicense
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ConsoleLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  licenseId: d688a7d8-fc04-5cad-37fa-e7774c4d5c34
                  edition: Enterprise Plus
                  package: Backup
                  licenseeCompany: Alpha
                  licenseeEmail: j.smith@alpha.com
                  licenseeAdministratorEmail: 
                  contactPerson: 
                  expirationDate: '2026-04-04T09:00:00.0000000+02:00'
                  supportExpirationDate: 
                  supportId: '02436535'
                  status: Valid
                  statusMessage: Valid (1171 days until expiration)
                  cloudConnect: Yes
                  instances: 824
                  type: Rental
                  lastUpdateDate: '2023-11-19T12:01:34.4700523+01:00'
                  lastUpdateMessage: License file has been successfully updated.
                  lastUpdateStatus: Success
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /licensing/console/settings:
    get:
      tags:
        - Licensing
      summary: Get Veeam Service Provider Console License Settings
      description: Returns a resource representation of the currently installed Veeam Service Provider Console license settings.
      operationId: GetConsoleLicenseSettings
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LicenseSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  isAutoUpdateEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /licensing/usage/organizations:
    get:
      tags:
        - Licensing
      summary: Get License Usage by All Organizations
      description: Returns a collection resource representation of license usage by all organizations.
      operationId: GetOrganizationsLicenseUsage
      parameters:
        - name: organizationUid
          in: query
          description: Organization UID.
          schema:
            type: string
            format: uuid
            nullable: true
        - name: organizationType
          in: query
          description: Organization type.
          schema:
            enum:
              - Unknown
              - Company
              - Provider
              - Reseller
            type: string
            nullable: true
            x-extensible-enum: true
            x-ms-enum:
              name: LicenseUsageOrganizationType
        - name: providerUid
          in: query
          description: UID of an organization that manages license.
          schema:
            type: string
            format: uuid
            nullable: true
        - name: serverUid
          in: query
          description: Server UID.
          schema:
            type: string
            format: uuid
            nullable: true
        - name: serverType
          in: query
          description: Server type.
          schema:
            enum:
              - Unknown
              - BackupAndReplication
              - CloudConnect
              - VSPC
              - VONE
              - VB365
            type: string
            nullable: true
            x-extensible-enum: true
            x-ms-enum:
              name: LicenseUsageProductType
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrganizationCurrentLicenseUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - organizationUid: 30780260-6bed-47eb-b1ac-d12de2ce5b9d
                    organizationType: Company
                    providerUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                    servers:
                      - serverUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                        serverType: BackupAndReplication
                        workloads:
                          - id: dd79949a-2fc8-4673-a466-c184ccf8d0b9
                            description: VM
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 33
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 3
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VBR-VM-VSPHERE
                                description: VMware vSphere
                                weight: 11
                                rentalUnits: 0
                                newUnits: 33
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 3
                                usedCount: 0
                          - id: a4e11b25-9808-4c0e-a896-d8d895d8ff5e
                            description: Server
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 11
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 1
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VBR-SERVER-WINDOWS
                                description: Microsoft Windows
                                weight: 11
                                rentalUnits: 0
                                newUnits: 11
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 1
                                usedCount: 0
                      - serverUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                        serverType: CloudConnect
                        workloads:
                          - id: 97e257f5-b50b-4844-90dd-f8bb6f9ecc20
                            description: Cloud Backup (VM)
                            unitType: Points
                            rentalUnits: 5
                            newUnits: 0
                            usedUnits: 0
                            rentalCount: 1
                            newCount: 0
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VCC-VM-BACKUP
                                description: VM
                                weight: 5
                                rentalUnits: 5
                                newUnits: 0
                                usedUnits: 0
                                rentalCount: 1
                                newCount: 0
                                usedCount: 0
                          - id: dd20bce2-fedc-451b-8399-6ba6eaada4a0
                            description: Cloud Replica (VM)
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 10
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 1
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VCC-VM-REPLICA
                                description: VM
                                weight: 10
                                rentalUnits: 0
                                newUnits: 10
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 1
                                usedCount: 0
                      - serverUid: 0c9d40a9-17a1-4c09-8f57-853a688ca8b1
                        serverType: VSPC
                        workloads:
                          - id: 3cd1c49e-6ccd-42ee-8892-5d027efca157
                            description: Workstation
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 4
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 1
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VSPC-WORKSTATION-WINDOWS
                                description: Microsoft Windows
                                weight: 4
                                rentalUnits: 0
                                newUnits: 4
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 1
                                usedCount: 0
                          - id: 15dd8880-4379-40b9-adbb-08ac396823cb
                            description: Server
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 55
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 5
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VSPC-SERVER-LINUX
                                description: Linux
                                weight: 11
                                rentalUnits: 0
                                newUnits: 33
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 3
                                usedCount: 0
                              - typeId: VSPC-SERVER-WINDOWS
                                description: Microsoft Windows
                                weight: 11
                                rentalUnits: 0
                                newUnits: 22
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 2
                                usedCount: 0
                  - organizationUid: ff98a69f-19dd-4a08-898e-a8a3562fe974
                    organizationType: Company
                    providerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    servers:
                      - serverUid: a6305f3c-46be-4c06-9bc4-97f2449d881f
                        serverType: BackupAndReplication
                        workloads:
                          - id: dd79949a-2fc8-4673-a466-c184ccf8d0b9
                            description: VM
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 11
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 1
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VBR-VM-VSPHERE
                                description: VMware vSphere
                                weight: 11
                                rentalUnits: 0
                                newUnits: 11
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 1
                                usedCount: 0
                      - serverUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                        serverType: CloudConnect
                        workloads:
                          - id: 44204712-d6d1-466b-93d0-ac32f02b5a75
                            description: Cloud Backup (Server)
                            unitType: Points
                            rentalUnits: 7
                            newUnits: 0
                            usedUnits: 0
                            rentalCount: 1
                            newCount: 0
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VCC-SERVER-BACKUP
                                description: Server
                                weight: 7
                                rentalUnits: 7
                                newUnits: 0
                                usedUnits: 0
                                rentalCount: 1
                                newCount: 0
                                usedCount: 0
                      - serverUid: 0c9d40a9-17a1-4c09-8f57-853a688ca8b1
                        serverType: VSPC
                        workloads:
                          - id: 15dd8880-4379-40b9-adbb-08ac396823cb
                            description: Server
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 11
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 1
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VSPC-SERVER-WINDOWS
                                description: Microsoft Windows
                                weight: 11
                                rentalUnits: 0
                                newUnits: 11
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 1
                                usedCount: 0
                  - organizationUid: 0a093973-274b-4df8-83e2-1316dee0c9a9
                    organizationType: Company
                    providerUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    servers:
                      - serverUid: e48b073a-cf2e-42d2-bf3d-3eb8d2c32429
                        serverType: BackupAndReplication
                        workloads:
                          - id: dd79949a-2fc8-4673-a466-c184ccf8d0b9
                            description: VM
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 22
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 2
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VBR-VM-VSPHERE
                                description: VMware vSphere
                                weight: 11
                                rentalUnits: 0
                                newUnits: 22
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 2
                                usedCount: 0
                          - id: 7d5e9198-8972-4c44-8074-60be5212b9d4
                            description: Cloud VM
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 22
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 2
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VBR-VM-CLOUD
                                description: Cloud VM
                                weight: 11
                                rentalUnits: 0
                                newUnits: 22
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 2
                                usedCount: 0
                      - serverUid: 0107365a-60f9-422a-832b-485db173d356
                        serverType: CloudConnect
                        workloads:
                          - id: dd20bce2-fedc-451b-8399-6ba6eaada4a0
                            description: Cloud Replica (VM)
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 10
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 1
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VCC-VM-REPLICA
                                description: VM
                                weight: 10
                                rentalUnits: 0
                                newUnits: 10
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 1
                                usedCount: 0
                  - organizationUid: ada1a61e-caaf-4352-85ef-fae903037163
                    organizationType: Company
                    providerUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    servers:
                      - serverUid: 0c9d40a9-17a1-4c09-8f57-853a688ca8b1
                        serverType: VSPC
                        workloads:
                          - id: 3cd1c49e-6ccd-42ee-8892-5d027efca157
                            description: Workstation
                            unitType: Points
                            rentalUnits: 0
                            newUnits: 8
                            usedUnits: 0
                            rentalCount: 0
                            newCount: 2
                            usedCount: 0
                            workloadsByPlatform:
                              - typeId: VSPC-WORKSTATION-WINDOWS
                                description: Microsoft Windows
                                weight: 4
                                rentalUnits: 0
                                newUnits: 8
                                usedUnits: 0
                                rentalCount: 0
                                newCount: 2
                                usedCount: 0
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/companies/{companyUid}/welcomeEmail':
    post:
      tags:
        - Companies
      summary: Send Welcome Email to Company
      description: Sends a welcome email to a company with the specified UID.
      operationId: SendWelcomeEmailToCompany
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        description: Password for the account.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WelcomeEmailOptions'
            example:
              password: Password1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/companies/{companyUid}/siteResources':
    get:
      tags:
        - Companies
      summary: Get All Cloud Tenants Assigned to Company
      description: Returns a collection resource representation of all cloud tenants assigned to a company with the specified UID.
      operationId: GetCompanySiteResources
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                    siteUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                    siteName: cc-sa
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: '2025-08-05T21:04:00.0000000+02:00'
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: t1
                      password: 
                    description: Created by CC-SA\Administrator at 8/4/2025 12:12 PM.
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: StandaloneGateways
                    gatewayPoolsUids: [ ]
                    isGatewayFailoverEnabled: false
                    name: t1
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: true
                    isNativeReplicationResourcesEnabled: false
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                  - instanceUid: cdd60d1c-ad8f-4d22-8b5f-e2c9a6da5bc6
                    siteUid: 7cff66d7-4d1e-4c5d-9faa-ec913fb77cfe
                    siteName: cc-sa
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: 
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: t2
                      password: 
                    description: Created by CC-SA\Administrator at 8/4/2025 12:14 PM.
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: StandaloneGateways
                    gatewayPoolsUids: [ ]
                    isGatewayFailoverEnabled: false
                    name: t2
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: false
                    isNativeReplicationResourcesEnabled: false
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /organizations/companies/hostedResources/vb365:
    get:
      tags:
        - Companies
      summary: Get All Company Veeam Backup for Microsoft 356 Resources
      description: Returns a collection resource representation of Veeam Backup for Microsoft 365 resources allocated to all companies.
      operationId: GetCompaniesVb365Resources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                    vb365ServerUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                    friendlyName: VB3
                    companyUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                  - instanceUid: cdd60d1c-ad8f-4d22-8b5f-e2c9a6da5bc6
                    vb365ServerUid: 7cff66d7-4d1e-4c5d-9faa-ec913fb77cfe
                    friendlyName: VB4
                    companyUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                  - instanceUid: 149a26a3-9956-438e-8343-f59c9f1efee5
                    vb365ServerUid: 988f3845-46ba-44b2-98ed-a26e27c0b758
                    friendlyName: VB5
                    companyUid: 63948972-5e9c-43ad-adc6-0cdc89300605
                  - instanceUid: f81610d8-4304-4ad9-ac43-6c1eed802eb2
                    vb365ServerUid: 2e1b4e76-bc25-4571-87b7-f89220ca4efb
                    friendlyName: VB6
                    companyUid: 505ad273-b821-4f3b-9ea1-fd94226fb319
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/organizations/companies/{companyUid}/hostedResources/vb365':
    get:
      tags:
        - Companies
      summary: Get All Veeam Backup for Microsoft 365 Resources of Company
      description: Returns a collection resource representation of Veeam Backup for Microsoft 365 resources allocated to a company with the specified UID.
      operationId: GetCompanyVb365Resources
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                    vb365ServerUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                    friendlyName: VB3
                    companyUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                  - instanceUid: cdd60d1c-ad8f-4d22-8b5f-e2c9a6da5bc6
                    vb365ServerUid: 7cff66d7-4d1e-4c5d-9faa-ec913fb77cfe
                    friendlyName: VB4
                    companyUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Companies
      summary: Create Company Veeam Backup for Microsoft 365 Resource
      description: Allocates a Veeam Backup for Microsoft 365 resource to a company with the specified UID.
      operationId: CreateCompanyVb365Resource
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Company Veeam Backup for Microsoft 365 resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyVb365ResourceInput'
            example:
              vb365ServerUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              friendlyName: Alpha 365 Resource
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  vb365ServerUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  friendlyName: Alpha 365 Resource
                  companyUid: 6f213654-b538-4695-ac69-aa677e41862e
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}':
    get:
      tags:
        - Companies
      summary: Get Company Veeam Backup for Microsoft 365 Resource
      description: Returns a resource representation of company Veeam Backup for Microsoft 365 resource with the specified UID.
      operationId: GetCompanyVb365Resource
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: vb365ResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: e6f92a5b-468d-4d93-b955-6e55b93bc035
                  vb365ServerUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                  friendlyName: VB3
                  companyUid: 0ec4d2ac-5493-48cd-98d6-3c36d299103a
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/CompanyVb365Resource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Companies
      summary: Modify Company Veeam Backup for Microsoft 365 Resource
      description: Modifies a company Veeam Backup for Microsoft 365 resource with the specified UID.
      operationId: PatchCompanyVb365Resource
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: vb365ResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Alpha 365 Resource
                path: /friendlyName
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyVb365Resource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  vb365ServerUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  friendlyName: Alpha 365 Resource
                  companyUid: 6f213654-b538-4695-ac69-aa677e41862e
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/CompanyVb365Resource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    delete:
      tags:
        - Companies
      summary: Delete Company Veeam Backup for Microsoft 365 Resource
      description: Deletes a company Veeam Backup for Microsoft 365 resource with the specified UID.
      operationId: DeleteCompanyVb365Resource
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: vb365ResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /organizations/companies/hostedResources/vb365/backupResources:
    get:
      tags:
        - Companies
      summary: Get All Company Veeam Backup for Microsoft 365 Backup Resources
      description: Returns a collection resource representation of all company Veeam Backup for Microsoft 365 backup resources.
      operationId: GetCompaniesVb365BackupResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyVb365BackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e0a84efc-838c-4e2e-9137-53da2c857d1e
                    companyUid: 6e9e63ca-fe31-4d09-85c0-b60d8912a0f7
                    vb365ResourceUid: 5de90220-856b-4875-83e1-37a9e4e1203a
                    repositoryUid: 81aff470-39f7-4890-9503-0b05c4e67eb6
                    proxyUid: 170813a4-681d-4dd7-86a2-f070c644a259
                    proxyPoolUid: 
                    usersQuota: 
                    isUsersQuotaUnlimited: true
                    storageQuota: 
                    isStorageQuotaUnlimited: true
                  - instanceUid: e3b0059f-b79d-49a2-970c-41bc7ee18565
                    companyUid: 4d2e1cce-61b0-425a-960b-d03b6834f984
                    vb365ResourceUid: fb401142-8661-431b-bf78-e7ed6fcfba75
                    repositoryUid: abfcbe51-cbf9-4756-8964-29c3b0087e0a
                    proxyUid: 1bde4d90-5980-46cc-a658-9353721e3ce8
                    proxyPoolUid: 
                    usersQuota: 
                    isUsersQuotaUnlimited: true
                    storageQuota: 
                    isStorageQuotaUnlimited: true
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/organizations/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}/backupResources':
    get:
      tags:
        - Companies
      summary: Get All Veeam Backup for Microsoft 365 Backup Resources of Company
      description: Returns a collection resource representation of all backup resources allocated to a company on a Veeam Backup for Microsoft 365 resource with the specified UID.
      operationId: GetCompanyVb365BackupResources
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: vb365ResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyVb365BackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e0a84efc-838c-4e2e-9137-53da2c857d1e
                    companyUid: 6e9e63ca-fe31-4d09-85c0-b60d8912a0f7
                    vb365ResourceUid: 5de90220-856b-4875-83e1-37a9e4e1203a
                    repositoryUid: 81aff470-39f7-4890-9503-0b05c4e67eb6
                    proxyUid: 170813a4-681d-4dd7-86a2-f070c644a259
                    proxyPoolUid: 
                    usersQuota: 
                    isUsersQuotaUnlimited: true
                    storageQuota: 
                    isStorageQuotaUnlimited: true
                  - instanceUid: e3b0059f-b79d-49a2-970c-41bc7ee18565
                    companyUid: 6e9e63ca-fe31-4d09-85c0-b60d8912a0f7
                    vb365ResourceUid: fb401142-8661-431b-bf78-e7ed6fcfba75
                    repositoryUid: abfcbe51-cbf9-4756-8964-29c3b0087e0a
                    proxyUid: 1bde4d90-5980-46cc-a658-9353721e3ce8
                    proxyPoolUid: 
                    usersQuota: 
                    isUsersQuotaUnlimited: true
                    storageQuota: 
                    isStorageQuotaUnlimited: true
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Companies
      summary: Create Company Veeam Backup for Microsoft 365 Backup Resource
      description: Allocates a new backup resource to a company on a Veeam Backup for Microsoft 365 resource with the specified UID.
      operationId: CreateCompanyVb365BackupResource
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: vb365ResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Veeam Backup for Microsoft 365 backup resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyVb365BackupResourceInput'
            example:
              repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              proxyUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
              proxyPoolUid: 
              usersQuota: 
              isUsersQuotaUnlimited: true
              storageQuota: 214748
              isStorageQuotaUnlimited: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyVb365BackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 6f213654-b538-4695-ac69-aa677e41862e
                  companyUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  vb365ResourceUid: b2fb8f33-9675-46d9-a114-6664e1044860
                  repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  proxyUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  proxyPoolUid: 
                  usersQuota: 
                  isUsersQuotaUnlimited: true
                  storageQuota: 214748
                  isStorageQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/companies/{companyUid}/hostedResources/vb365/{vb365ResourceUid}/backupResources/{vb365BackupResourceUid}':
    get:
      tags:
        - Companies
      summary: Get Company Veeam Backup for Microsoft 365 Backup Resource
      description: Returns a resource representation of a company Veeam Backup for Microsoft 365 backup resource with the specified UID.
      operationId: GetCompanyVb365BackupResource
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: vb365ResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365BackupResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 backup resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyVb365BackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: e3b0059f-b79d-49a2-970c-41bc7ee18565
                  companyUid: 6e9e63ca-fe31-4d09-85c0-b60d8912a0f7
                  vb365ResourceUid: fb401142-8661-431b-bf78-e7ed6fcfba75
                  repositoryUid: abfcbe51-cbf9-4756-8964-29c3b0087e0a
                  proxyUid: 1bde4d90-5980-46cc-a658-9353721e3ce8
                  proxyPoolUid: 
                  usersQuota: 
                  isUsersQuotaUnlimited: true
                  storageQuota: 
                  isStorageQuotaUnlimited: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/CompanyVb365BackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Companies
      summary: Modify Company Veeam Backup for Microsoft 365 Backup Resource
      description: Modifies a company Veeam Backup for Microsoft 365 backup resource with the specified UID.
      operationId: PatchCompanyVb365BackupResource
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: vb365ResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365BackupResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 backup resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 'false'
                path: /isUsersQuotaUnlimited
                op: replace
              - value: '150'
                path: /usersQuota
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyVb365BackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 6f213654-b538-4695-ac69-aa677e41862e
                  companyUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  vb365ResourceUid: b2fb8f33-9675-46d9-a114-6664e1044860
                  repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  proxyUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  proxyPoolUid: 
                  usersQuota: 150
                  isUsersQuotaUnlimited: false
                  storageQuota: 
                  isStorageQuotaUnlimited: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/CompanyVb365BackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    delete:
      tags:
        - Companies
      summary: Delete Company Veeam Backup for Microsoft 365 Backup Resource
      description: Deletes a company Veeam Backup for Microsoft 365 backup resource with the specified UID.
      operationId: DeleteCompanyVb365BackupResource
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: vb365ResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365BackupResourceUid
          in: path
          description: Veeam Backup for Microsoft 365 backup resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /organizations/companies/hostedResources/vbr:
    get:
      tags:
        - Companies
      summary: Get All Company Hosted Server Resources
      description: Returns a collection resource representation of hosted Veeam Backup & Replication server resources allocated to all companies.
      operationId: GetCompaniesHostedVbrResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyHostedVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c3f58f76-85b3-4c45-8352-a3c91ea4d52d
                    serverUid: c84b01f1-466d-473a-ab61-e40dbb2823d6
                    friendlyName: vbrRes1
                    companyUid: 0de4f6a2-22df-46bb-9c85-e3225f142229
                  - instanceUid: 962a26c8-a14f-4b02-8781-246e899a6978
                    serverUid: c717377c-ed83-4f19-93a9-38d3c22d617e
                    friendlyName: vbrRes2
                    companyUid: 23f2908d-b946-4e94-8e62-43a0c2ac31f4
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/organizations/companies/{companyUid}/hostedResources/vbr':
    get:
      tags:
        - Companies
      summary: Get All Hosted Server Resources of Company
      description: Returns a collection resource representation of hosted Veeam Backup & Replication server resources allocated to a company with the specified UID.
      operationId: GetCompanyHostedVbrResources
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyHostedVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c3f58f76-85b3-4c45-8352-a3c91ea4d52d
                    serverUid: c84b01f1-466d-473a-ab61-e40dbb2823d6
                    friendlyName: vbrRes1
                    companyUid: 0de4f6a2-22df-46bb-9c85-e3225f142229
                  - instanceUid: 962a26c8-a14f-4b02-8781-246e899a6978
                    serverUid: c717377c-ed83-4f19-93a9-38d3c22d617e
                    friendlyName: vbrRes2
                    companyUid: 0de4f6a2-22df-46bb-9c85-e3225f142229
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Companies
      summary: Create Company Hosted Server Resource
      description: Allocates a hosted Veeam Backup & Replication server resource to a company with the specified UID.
      operationId: CreateCompanyHostedVbrResource
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Company hosted Veeam Backup & Replication server resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyHostedVbrResourceInput'
            example:
              serverUid: 6f213654-b538-4695-ac69-aa677e41862e
              friendlyName: Alpha VBR 2
              isJobSchedulingEnabled: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyHostedVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  serverUid: 6f213654-b538-4695-ac69-aa677e41862e
                  friendlyName: Alpha VBR 2
                  companyUid: b2fb8f33-9675-46d9-a114-6664e1044860
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}':
    get:
      tags:
        - Companies
      summary: Get Company Hosted Server Resource
      description: Returns a resource representation of a company hosted Veeam Backup & Replication server resource with the specified UID.
      operationId: GetCompanyHostedVbrResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyHostedVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: c3f58f76-85b3-4c45-8352-a3c91ea4d52d
                  serverUid: c84b01f1-466d-473a-ab61-e40dbb2823d6
                  friendlyName: vbrRes1
                  companyUid: 0de4f6a2-22df-46bb-9c85-e3225f142229
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/CompanyHostedVbrResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Companies
      summary: Modify Company Hosted Server Resource
      description: Modifies a company hosted Veeam Backup & Replication server resource with the specified UID.
      operationId: PatchCompanyHostedVbrResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Alpha VBR 2
                path: /FriendlyName
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyHostedVbrResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  serverUid: 6f213654-b538-4695-ac69-aa677e41862e
                  friendlyName: Alpha VBR 2
                  companyUid: b2fb8f33-9675-46d9-a114-6664e1044860
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/CompanyHostedVbrResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Companies
      summary: Delete Company Hosted Server Resource
      description: Deletes a company hosted Veeam Backup & Replication server resource with the specified UID.
      operationId: DeleteCompanyHostedVbrResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    parameters:
      - $ref: '#/components/parameters/companyUid_path'
      - name: vbrHostedResourceUid
        in: path
        description: Hosted Veeam Backup & Replication server resource UID.
        required: true
        schema:
          type: string
          format: uuid
  /organizations/companies/hostedResources/vbr/backupResources:
    get:
      tags:
        - Companies
      summary: Get All Company Hosted Repository Resources
      description: Returns a collection resource representation of hosted Veeam Backup & Replication repository resources allocated to all companies.
      operationId: GetCompaniesHostedVbrBackupResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyHostedVbrBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c3f58f76-85b3-4c45-8352-a3c91ea4d52d
                    companyUid: c84b01f1-466d-473a-ab61-e40dbb2823d6
                    hostedResourceUid: 0de4f6a2-22df-46bb-9c85-e3225f142229
                    repositoryUid: 962a26c8-a14f-4b02-8781-246e899a6978
                    storageQuota: 100
                    isStorageQuotaUnlimited: false
                  - instanceUid: c717377c-ed83-4f19-93a9-38d3c22d617e
                    companyUid: 23f2908d-b946-4e94-8e62-43a0c2ac31f4
                    hostedResourceUid: 11a16d5d-6563-4dd3-ab02-9a339ef9608c
                    repositoryUid: bf66193f-599a-4008-8d41-49c81abcc1a9
                    storageQuota: 100
                    isStorageQuotaUnlimited: false
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/organizations/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/backupResources':
    get:
      tags:
        - Companies
      summary: Get All Hosted Repository Resources of Company
      description: Returns a collection resource representation of all Veeam Backup & Replication repository resources allocated to a company on a hosted Veeam Backup & Replication server resource with the specified UID.
      operationId: GetCompanyHostedVbrBackupResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyHostedVbrBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c3f58f76-85b3-4c45-8352-a3c91ea4d52d
                    companyUid: c84b01f1-466d-473a-ab61-e40dbb2823d6
                    hostedResourceUid: 0de4f6a2-22df-46bb-9c85-e3225f142229
                    repositoryUid: 962a26c8-a14f-4b02-8781-246e899a6978
                    storageQuota: 100
                    isStorageQuotaUnlimited: false
                  - instanceUid: c717377c-ed83-4f19-93a9-38d3c22d617e
                    companyUid: c84b01f1-466d-473a-ab61-e40dbb2823d6
                    hostedResourceUid: 11a16d5d-6563-4dd3-ab02-9a339ef9608c
                    repositoryUid: bf66193f-599a-4008-8d41-49c81abcc1a9
                    storageQuota: 100
                    isStorageQuotaUnlimited: false
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Companies
      summary: Create Company Hosted Repository Resource
      description: Allocates a new Veeam Backup & Replication repository resource to a company on a hosted Veeam Backup & Replication server resource with the specified UID.
      operationId: CreateCompanyHostedVbrBackupResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Hosted Veeam Backup & Replication repository resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyHostedVbrBackupResource'
            example:
              repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              storageQuota: 214748
              isStorageQuotaUnlimited: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyHostedVbrBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  companyUid: 6f213654-b538-4695-ac69-aa677e41862e
                  hostedResourceUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  storageQuota: 214748
                  isStorageQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/companyUid_path'
      - name: vbrHostedResourceUid
        in: path
        description: Hosted Veeam Backup & Replication server resource UID.
        required: true
        schema:
          type: string
          format: uuid
  '/organizations/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/backupResources/{hostedVbrBackupResourceUid}':
    get:
      tags:
        - Companies
      summary: Get Company Hosted Repository Resource
      description: Returns a resource representation of a company hosted Veeam Backup & Replication repository resource with the specified UID.
      operationId: GetCompanyHostedVbrBackupResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyHostedVbrBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: c717377c-ed83-4f19-93a9-38d3c22d617e
                  companyUid: c84b01f1-466d-473a-ab61-e40dbb2823d6
                  hostedResourceUid: 11a16d5d-6563-4dd3-ab02-9a339ef9608c
                  repositoryUid: bf66193f-599a-4008-8d41-49c81abcc1a9
                  storageQuota: 100
                  isStorageQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/CompanyHostedVbrBackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Companies
      summary: Modify Company Hosted Repository Resource
      description: Modifies a company hosted Veeam Backup & Replication repository resource with the specified UID.
      operationId: PatchCompanyHostedVbrBackupResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: ae61e533-82c7-4cb6-a030-78ae589cf49d
                path: /repositoryUid
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyHostedVbrBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  companyUid: 6f213654-b538-4695-ac69-aa677e41862e
                  hostedResourceUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  storageQuota: 214748
                  isStorageQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/CompanyHostedVbrBackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Companies
      summary: Delete Company Hosted Repository Resource
      description: Deletes a company hosted Veeam Backup & Replication repository resource with the specified UID.
      operationId: DeleteCompanyHostedVbrBackupResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
    parameters:
      - $ref: '#/components/parameters/companyUid_path'
      - name: vbrHostedResourceUid
        in: path
        description: Hosted Veeam Backup & Replication server resource UID.
        required: true
        schema:
          type: string
          format: uuid
      - name: hostedVbrBackupResourceUid
        in: path
        description: Hosted Veeam Backup & Replication repository resource UID.
        required: true
        schema:
          type: string
          format: uuid
  '/organizations/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/tagResources':
    get:
      tags:
        - Companies
      summary: Get All Tag Resources on Company Hosted Server Resource
      description: Returns a collection resource representation of all tag resources allocated to a company on a hosted Veeam Backup & Replication server resource with the specified UID.
      operationId: GetCompanyHostedVbrTagResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyHostedVbrTagResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0e766772-fc80-47a0-a4ed-ceafc0485d4f
                    companyUid: b9e5b413-17f2-43c4-a1c7-937f25a4f0b4
                    hostedResourceUid: 687a8524-aead-44ec-9c20-27d4faadcaf2
                    tagUrn: urn:vmomi:InventoryServiceTag:37211bc2-bcbe-4aa8-a4eb-53eaa4913ccc:GLOBAL
                    tagName: lis-tag2
                    virtualCenterUid: ad59b704-1f1f-4a72-94c0-e8055f5a3433
                  - instanceUid: 020ff779-88bf-4c8d-8000-4f18978d7471
                    companyUid: b9e5b413-17f2-43c4-a1c7-937f25a4f0b4
                    hostedResourceUid: 502309b4-c5e4-4edf-801a-62825e0e1367
                    tagUrn: urn:vmomi:InventoryServiceTag:5ce7c3bf-7173-4b29-8559-6601d605b08b:GLOBAL
                    tagName: lis-tag3
                    virtualCenterUid: ad59b704-1f1f-4a72-94c0-e8055f5a3433
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    post:
      tags:
        - Companies
      summary: Create Tag Resource on Company Hosted Server Resource
      description: Allocates a new tag resource to a company on a hosted Veeam Backup & Replication server resource with the specified UID.
      operationId: CreateCompanyHostedVbrTagResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Tag resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CompanyHostedVbrTagResourceInput'
            example:
              virtualCenterUid: 23c54529-5c14-4ebf-aa2c-64f3503a1070
              virtualServerTag:
                urn: urn:vmomi:InventoryServiceTag:88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                name: VSPC
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyHostedVbrTagResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 954ad297-9759-46f0-9ae8-8de7f24a23c8
                  companyUid: 43692cab-43df-4198-a965-0b41c53b1664
                  hostedResourceUid: 915791ec-6995-499b-bda2-ca5a7363e032
                  tagUrn: urn:vmomi:InventoryServiceTag:88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                  tagName: VSPC
                  virtualCenterUid: 23c54529-5c14-4ebf-aa2c-64f3503a1070
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/companyUid_path'
      - name: vbrHostedResourceUid
        in: path
        description: Hosted Veeam Backup & Replication server resource UID.
        required: true
        schema:
          type: string
          format: uuid
  '/organizations/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/tagResources/{hostedTagResourceUid}':
    get:
      tags:
        - Companies
      summary: Get Company Tag Resource
      description: Returns a resource representation of a company tag resource with the specified UID.
      operationId: GetCompanyHostedVbrTagResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CompanyHostedVbrTagResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 0e766772-fc80-47a0-a4ed-ceafc0485d4f
                  companyUid: b9e5b413-17f2-43c4-a1c7-937f25a4f0b4
                  hostedResourceUid: 687a8524-aead-44ec-9c20-27d4faadcaf2
                  tagUrn: urn:vmomi:InventoryServiceTag:37211bc2-bcbe-4aa8-a4eb-53eaa4913ccc:GLOBAL
                  tagName: lis-tag2
                  virtualCenterUid: ad59b704-1f1f-4a72-94c0-e8055f5a3433
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/CompanyHostedVbrTagResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Companies
      summary: Delete Company Tag Resource
      description: Deletes a company tag resource with the specified UID.
      operationId: DeleteCompanyHostedVbrTagResource
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/companyUid_path'
      - name: vbrHostedResourceUid
        in: path
        description: Hosted Veeam Backup & Replication resource UID.
        required: true
        schema:
          type: string
          format: uuid
      - name: hostedTagResourceUid
        in: path
        description: Tag resource UID.
        required: true
        schema:
          type: string
          format: uuid
  /organizations/companies/hostedResources/vbr/tagResources:
    get:
      tags:
        - Companies
      summary: Get All Company Tag Resources
      description: Returns a collection resource representation of all company tag resources.
      operationId: GetCompaniesHostedVbrTagResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CompanyHostedVbrTagResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0e766772-fc80-47a0-a4ed-ceafc0485d4f
                    companyUid: b9e5b413-17f2-43c4-a1c7-937f25a4f0b4
                    hostedResourceUid: 687a8524-aead-44ec-9c20-27d4faadcaf2
                    tagUrn: urn:vmomi:InventoryServiceTag:37211bc2-bcbe-4aa8-a4eb-53eaa4913ccc:GLOBAL
                    tagName: lis-tag2
                    virtualCenterUid: ad59b704-1f1f-4a72-94c0-e8055f5a3433
                  - instanceUid: 020ff779-88bf-4c8d-8000-4f18978d7471
                    companyUid: bbc0c9e4-47bc-41d3-9127-c563d55ec2dd
                    hostedResourceUid: 502309b4-c5e4-4edf-801a-62825e0e1367
                    tagUrn: urn:vmomi:InventoryServiceTag:5ce7c3bf-7173-4b29-8559-6601d605b08b:GLOBAL
                    tagName: lis-tag3
                    virtualCenterUid: 87d8ec35-7b65-4771-9363-caf94bcd2209
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/organizations/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/mappedVcdOrganizations':
    get:
      tags:
        - Companies
      summary: Get All Mappings of VMware Cloud Director Organizations to Company with Assigned Hosted Resource
      description: Returns a collection resource representation of all mappings of VMware Cloud Director organizations to a company with an assigned hosted resource with the specified UID.
      operationId: GetCompanyHostedVbrVcdOrganizationMappings
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationToCompanyMapping'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 9058eaa9-32b0-4043-a12e-4b736f02a075
                    companyUid: b9e5b413-17f2-43c4-a1c7-937f25a4f0b4
                    hostedResourceUid: 687a8524-aead-44ec-9c20-27d4faadcaf2
                    vcdOrganizationUid: ace1eb17-b55c-4ec5-836d-2b3022c20ed7
                    vcdOrganizationName: Alpha
                    backupServerUid: 91d5797e-c80b-48e5-bb97-b9df5707f14f
                    backupServerName: vbr1
                  - instanceUid: 3c3ccb9e-e148-4641-8ad9-9493907d2157
                    companyUid: b9e5b413-17f2-43c4-a1c7-937f25a4f0b4
                    hostedResourceUid: 687a8524-aead-44ec-9c20-27d4faadcaf2
                    vcdOrganizationUid: a202c5db-f62c-48c4-a6f4-c926d0d5bbc3
                    vcdOrganizationName: Beta
                    backupServerUid: 91d5797e-c80b-48e5-bb97-b9df5707f14f
                    backupServerName: vbr1
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    post:
      tags:
        - Companies
      summary: Create Mapping of VMware Cloud Director Organization to Company with Assigned Hosted Resource
      description: Maps a VMware Cloud Director organization to a company with an assigned hosted resource with the specified UID.
      operationId: CreateCompanyHostedVbrVcdOrganizationMapping
      parameters:
        - name: vcdOrganizationUid
          in: query
          description: VMware Cloud Director organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VcdOrganizationToCompanyMapping'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 9058eaa9-32b0-4043-a12e-4b736f02a075
                  companyUid: b9e5b413-17f2-43c4-a1c7-937f25a4f0b4
                  hostedResourceUid: 687a8524-aead-44ec-9c20-27d4faadcaf2
                  vcdOrganizationUid: ace1eb17-b55c-4ec5-836d-2b3022c20ed7
                  vcdOrganizationName: Alpha
                  backupServerUid: 91d5797e-c80b-48e5-bb97-b9df5707f14f
                  backupServerName: vbr1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/companyUid_path'
      - name: vbrHostedResourceUid
        in: path
        description: Hosted Veeam Backup & Replication resource UID.
        required: true
        schema:
          type: string
          format: uuid
  '/organizations/companies/{companyUid}/hostedResources/vbr/{vbrHostedResourceUid}/mappedVcdOrganizations/{mappingUid}':
    get:
      tags:
        - Companies
      summary: Get VMware Cloud Director Organization to Company Mapping
      description: Returns a resource representation of a VMware Cloud Director organization to company mapping with the specified UID.
      operationId: GetCompanyHostedVbrVcdOrganizationMapping
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VcdOrganizationToCompanyMapping'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 9058eaa9-32b0-4043-a12e-4b736f02a075
                  companyUid: b9e5b413-17f2-43c4-a1c7-937f25a4f0b4
                  hostedResourceUid: 687a8524-aead-44ec-9c20-27d4faadcaf2
                  vcdOrganizationUid: ace1eb17-b55c-4ec5-836d-2b3022c20ed7
                  vcdOrganizationName: Alpha
                  backupServerUid: 91d5797e-c80b-48e5-bb97-b9df5707f14f
                  backupServerName: vbr1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/VcdOrganizationToCompanyMapping'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Companies
      summary: Delete VMware Cloud Director Organization to Company Mapping
      description: Deletes a VMware Cloud Director organization to company mapping with the specified UID.
      operationId: DeleteCompanyHostedVbrVcdOrganizationMapping
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/companyUid_path'
      - name: vbrHostedResourceUid
        in: path
        description: Hosted Veeam Backup & Replication server resource UID.
        required: true
        schema:
          type: string
          format: uuid
      - name: mappingUid
        in: path
        description: VMware Cloud Director organization to company mapping UID.
        required: true
        schema:
          type: string
          format: uuid
  /organizations/companies/hostedResources/vbr/mappedVcdOrganizations:
    get:
      tags:
        - Companies
      summary: Get Mappings of VMware Cloud Director Organizations to All Companies with Assigned Hosted Resources
      description: Returns a collection resource representation of mappings of VMware Cloud Director organizations to all companies with assigned hosted resources.
      operationId: GetCompaniesHostedVbrVcdOrganizationMappings
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationToCompanyMapping'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 9058eaa9-32b0-4043-a12e-4b736f02a075
                    companyUid: b9e5b413-17f2-43c4-a1c7-937f25a4f0b4
                    hostedResourceUid: 687a8524-aead-44ec-9c20-27d4faadcaf2
                    vcdOrganizationUid: ace1eb17-b55c-4ec5-836d-2b3022c20ed7
                    vcdOrganizationName: Alpha
                    backupServerUid: 91d5797e-c80b-48e5-bb97-b9df5707f14f
                    backupServerName: vbr1
                  - instanceUid: 3c3ccb9e-e148-4641-8ad9-9493907d2157
                    companyUid: ed79f34b-a2c0-43e8-ae27-a1ec0b8beb1b
                    hostedResourceUid: 3b78f937-9a05-4ee7-bd2b-9e785ebad786
                    vcdOrganizationUid: a202c5db-f62c-48c4-a6f4-c926d0d5bbc3
                    vcdOrganizationName: Beta
                    backupServerUid: f0472241-3685-4032-99c9-8877666bd7bb
                    backupServerName: vbr2
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /organizations/companies/usage:
    get:
      tags:
        - Companies
      summary: Get Services Usage by All Companies
      description: Returns a collection resource representation of services consumed by companies.
      operationId: GetCompaniesAggregatedUsage
      parameters:
        - name: fromDate
          in: query
          description: Start timestamp of a searched time range.
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          description: End timestamp of a searched time range. Total time range must be less than or equal to 31 day.
          schema:
            type: string
            format: date
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LocationAggregatedUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - companyUid: 279595ca-2027-4110-abc8-63619d14e25a
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    locationUid: 90a29218-7760-47e0-8407-628c06b98415
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 0
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 0
                        type: AgentCloudBackupDataTransferOut
                      - value: 0
                        type: AgentCloudBackupDataTransferIn
                      - value: 0
                        type: VbrCloudBackupsDataTransferOut
                      - value: 0
                        type: VbrCloudBackupsDataTransferIn
                      - value: 0
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 6442450944
                        type: VmCloudReplicaStorageUsage
                      - value: 0
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 0
                        type: ManagedServerAgents
                      - value: 0
                        type: ManagedWorkstationAgents
                      - value: 0
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 0
                        type: FileShareBackupSize
                      - value: 0
                        type: FileShareSourceSize
                      - value: 0
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 0
                        type: ManagedAgentsLinuxOS
                      - value: 0
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 0
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 0
                        type: CloudTotalUsage
                      - value: 0
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 0
                        type: ReplicatedVms
                      - value: 0
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 0
                        type: VbrBackupSize
                  - companyUid: d0e0957b-4a25-48ad-af5b-bba50195c6f1
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    locationUid: c5f820dd-92fa-40d2-b7e9-18dd44b7563e
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 0
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 0
                        type: AgentCloudBackupDataTransferOut
                      - value: 0
                        type: AgentCloudBackupDataTransferIn
                      - value: 0
                        type: VbrCloudBackupsDataTransferOut
                      - value: 0
                        type: VbrCloudBackupsDataTransferIn
                      - value: 0
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 0
                        type: VmCloudReplicaStorageUsage
                      - value: 0
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 0
                        type: ManagedServerAgents
                      - value: 0
                        type: ManagedWorkstationAgents
                      - value: 0
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 0
                        type: FileShareBackupSize
                      - value: 0
                        type: FileShareSourceSize
                      - value: 0
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 0
                        type: ManagedAgentsLinuxOS
                      - value: 0
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 0
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 0
                        type: CloudTotalUsage
                      - value: 0
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 0
                        type: ReplicatedVms
                      - value: 0
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 0
                        type: VbrBackupSize
                  - companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 1
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 0
                        type: AgentCloudBackupDataTransferOut
                      - value: 0
                        type: AgentCloudBackupDataTransferIn
                      - value: 446641
                        type: VbrCloudBackupsDataTransferOut
                      - value: 16162023327
                        type: VbrCloudBackupsDataTransferIn
                      - value: 1
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 24296592320
                        type: VmCloudReplicaStorageUsage
                      - value: 3145728
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 6
                        type: ManagedServerAgents
                      - value: 1
                        type: ManagedWorkstationAgents
                      - value: 3
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 71764356
                        type: FileShareBackupSize
                      - value: 15395056
                        type: FileShareSourceSize
                      - value: 1
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 3
                        type: ManagedAgentsLinuxOS
                      - value: 2
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 2
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 3145728
                        type: CloudTotalUsage
                      - value: 3145728
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 3
                        type: ReplicatedVms
                      - value: 6
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 244593416
                        type: VbrBackupSize
                  - companyUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                    resellerUid: f372850e-920c-486a-99d3-ad67de54d614
                    locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 0
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 405848
                        type: AgentCloudBackupDataTransferOut
                      - value: 16968755500
                        type: AgentCloudBackupDataTransferIn
                      - value: 0
                        type: VbrCloudBackupsDataTransferOut
                      - value: 0
                        type: VbrCloudBackupsDataTransferIn
                      - value: 0
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 0
                        type: VmCloudReplicaStorageUsage
                      - value: 0
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 1
                        type: ManagedServerAgents
                      - value: 0
                        type: ManagedWorkstationAgents
                      - value: 1
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 71769059
                        type: FileShareBackupSize
                      - value: 15423644
                        type: FileShareSourceSize
                      - value: 1
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 0
                        type: ManagedAgentsLinuxOS
                      - value: 0
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 1
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 17683185664
                        type: CloudTotalUsage
                      - value: 17683185664
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 3
                        type: ReplicatedVms
                      - value: 3
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 146773958
                        type: VbrBackupSize
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/organizations/companies/{companyUid}/usage':
    get:
      tags:
        - Companies
      summary: Get Services Usage by Company
      description: Returns a collection resource representation of services consumed by a company with the specified UID.
      operationId: GetCompanyAggregatedUsage
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: fromDate
          in: query
          description: Start timestamp of a searched time range.
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          description: End timestamp of a searched time range. Total time range must be less than or equal to 31 day.
          schema:
            type: string
            format: date
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LocationAggregatedUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - companyUid: d0e0957b-4a25-48ad-af5b-bba50195c6f1
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    locationUid: c5f820dd-92fa-40d2-b7e9-18dd44b7563e
                    date: '2024-07-18T02:00:00.0000000+02:00'
                    counters:
                      - value: 0
                        type: VmCloudBackups
                      - value: 0
                        type: ServerCloudBackups
                      - value: 0
                        type: WorkstationCloudBackups
                      - value: 0
                        type: AgentCloudBackupDataTransferOut
                      - value: 0
                        type: AgentCloudBackupDataTransferIn
                      - value: 0
                        type: VbrCloudBackupsDataTransferOut
                      - value: 0
                        type: VbrCloudBackupsDataTransferIn
                      - value: 0
                        type: VmCloudReplicas
                      - value: 0
                        type: VmCloudReplicaComputeTime
                      - value: 0
                        type: VbrCloudReplicaDataTransferOut
                      - value: 0
                        type: VbrCloudReplicaDataTransferIn
                      - value: 0
                        type: VmCloudReplicaStorageUsage
                      - value: 0
                        type: CloudRepositoryUsageByVm
                      - value: 0
                        type: CloudRepositoryUsageByServerAgent
                      - value: 0
                        type: CloudRepositoryUsageByWorkstationAgent
                      - value: 0
                        type: ManagedServerAgents
                      - value: 0
                        type: ManagedWorkstationAgents
                      - value: 0
                        type: ManagedVms
                      - value: 0
                        type: ManagedCloudVms
                      - value: 0
                        type: FileShareArchiveSize
                      - value: 0
                        type: FileShareBackupSize
                      - value: 0
                        type: FileShareSourceSize
                      - value: 0
                        type: ProtectedFileShares
                      - value: 0
                        type: ObjectStorageArchiveSize
                      - value: 0
                        type: ObjectStorageBackupSize
                      - value: 0
                        type: ObjectStorageSourceSize
                      - value: 0
                        type: ProtectedObjectStorages
                      - value: 0
                        type: ManagedAgentsMacOS
                      - value: 0
                        type: ManagedAgentsLinuxOS
                      - value: 0
                        type: ManagedAgentsWindowsDesktopOS
                      - value: 0
                        type: ManagedAgentsWindowsServerOS
                      - value: 0
                        type: CloudInsiderProtectionBackupSize
                      - value: 0
                        type: CloudCapacityTierBackupSize
                      - value: 0
                        type: CloudPerformanceTierBackupSize
                      - value: 0
                        type: CloudArchiveTierBackupSize
                      - value: 0
                        type: CloudTotalUsage
                      - value: 0
                        type: CloudRegularStorageUsage
                      - value: 0
                        type: CloudObjectStorageUsage
                      - value: 0
                        type: ManagedUsers
                      - value: 0
                        type: ReplicatedVms
                      - value: 0
                        type: BackedupVms
                      - value: 0
                        type: Vb365ArchiveSize
                      - value: 0
                        type: Vb365BackupSize
                      - value: 0
                        type: Vb365ProtectedGroups
                      - value: 0
                        type: Vb365ProtectedSites
                      - value: 0
                        type: Vb365ProtectedTeams
                      - value: 0
                        type: Vb365ProtectedUsers
                      - value: 0
                        type: VbrBackupSize
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /organizations/locations:
    get:
      tags:
        - Locations
      summary: Get All Locations
      description: Returns a collection resource representation of all organization locations.
      operationId: GetLocations
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrganizationLocation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c5f820dd-92fa-40d2-b7e9-18dd44b7563e
                    organizationUid: d0e0957b-4a25-48ad-af5b-bba50195c6f1
                    name: Remote
                    quotaGb: 2
                    type: Default
                  - instanceUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                    organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                    name: Europe1
                    quotaGb: 50
                    type: Default
                  - instanceUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                    organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    name: Default location
                    quotaGb: 0
                    type: Default
                  - instanceUid: fd44f0eb-1dad-498f-b04c-ec1c2ce84fbb
                    organizationUid: 92bc321a-21b8-4a84-86ff-e4637b53a751
                    name: Europe2
                    quotaGb: 50
                    type: Default
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Locations
      summary: Create Location
      description: Creates a new organization location.
      operationId: CreateLocation
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Location model.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrganizationLocationInput'
            example:
              organizationUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              name: Company Administrator Location
              quotaGb: 172740
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/OrganizationLocation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  organizationUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  name: Company Administrator Location
                  quotaGb: 172740
                  type: Custom
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  '/organizations/{organizationUid}/locations':
    get:
      tags:
        - Locations
      summary: Get All Organization Locations
      description: Returns a collection resource representation of all locations of an organization with the specified UID.
      operationId: GetLocationsByOrganization
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/OrganizationLocation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c5f820dd-92fa-40d2-b7e9-18dd44b7563e
                    organizationUid: d0e0957b-4a25-48ad-af5b-bba50195c6f1
                    name: Remote
                    quotaGb: 2
                    type: Default
                  - instanceUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                    organizationUid: d0e0957b-4a25-48ad-af5b-bba50195c6f1
                    name: Europe1
                    quotaGb: 50
                    type: Default
                  - instanceUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                    organizationUid: d0e0957b-4a25-48ad-af5b-bba50195c6f1
                    name: Default location
                    quotaGb: 0
                    type: Default
                  - instanceUid: fd44f0eb-1dad-498f-b04c-ec1c2ce84fbb
                    organizationUid: d0e0957b-4a25-48ad-af5b-bba50195c6f1
                    name: Europe2
                    quotaGb: 50
                    type: Default
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/organizations/locations/{locationUid}':
    get:
      tags:
        - Locations
      summary: Get Location
      description: Returns a resource representation of a organization location with the specified UID.
      operationId: GetLocation
      parameters:
        - name: locationUid
          in: path
          description: Location UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/OrganizationLocation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: fd44f0eb-1dad-498f-b04c-ec1c2ce84fbb
                  organizationUid: d0e0957b-4a25-48ad-af5b-bba50195c6f1
                  name: Europe2
                  quotaGb: 50
                  type: Default
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/OrganizationLocation'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Locations
      summary: Modify Location
      description: Modifies an organization location.
      operationId: PatchLocation
      parameters:
        - name: locationUid
          in: path
          description: Location UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Company Administrator Location
                path: /Name
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/OrganizationLocation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  organizationUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  name: Company Administrator Location
                  quotaGb: 172740
                  type: Custom
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/OrganizationLocation'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
    delete:
      tags:
        - Locations
      summary: Delete Location
      description: Deletes an organization location with the specified UID.
      operationId: DeleteLocation
      parameters:
        - name: locationUid
          in: path
          description: Location UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  '/organizations/locations/{locationUid}/users':
    get:
      tags:
        - Accounts
      summary: Get All Location Users
      description: Returns a collection resource representation of all users that are assigned to a location with the specified UID.
      operationId: GetUsersByLocation
      parameters:
        - name: locationUid
          in: path
          description: Location UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/User'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c37dac86-f273-4133-9bcd-3d5972ef7b40
                    organizationUid: ff98a69f-19dd-4a08-898e-a8a3562fe974
                    userName: administrator
                    status: Enabled
                    mfaPolicyStatus: Enabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanyAdministrator
                    profile:
                      firstName: John
                      lastName: Smith
                      title: Mr
                      email: j.smith@alpha.com
                      address: 
                      phone: 
                    credentials:
                      userName: administrator
                      password: 
                  - instanceUid: 1b4a5ccf-9f2e-4e05-94ff-6e6f2ca5cfd2
                    organizationUid: ff98a69f-19dd-4a08-898e-a8a3562fe974
                    userName: a.west
                    status: Enabled
                    mfaPolicyStatus: Disabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanySubtenant
                    profile:
                      firstName: Adam
                      lastName: West
                      title: Mr
                      email: a.west@alpha.com
                      address: 
                      phone: 410-510-2371
                    credentials:
                      userName: a.west
                      password: 
                  - instanceUid: cd592141-a9ef-448c-b121-5e1a3800e4c1
                    organizationUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                    userName: auditor
                    status: Enabled
                    mfaPolicyStatus: Enabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanyInvoiceAuditor
                    profile:
                      firstName: Simon
                      lastName: Cold
                      title: Mr
                      email: s.cold@beta.com
                      address: 
                      phone: 410-510-2317
                    credentials:
                      userName: auditor
                      password: 
                  - instanceUid: c0d22609-861c-4e36-a47d-cd8d05594ffc
                    organizationUid: 5f6e5f1c-03f3-4ac2-98cb-b2937fd5cc3c
                    userName: atlanta
                    status: Enabled
                    mfaPolicyStatus: Enabled
                    mfaPolicyConfigurationStatus: NotConfigured
                    role: CompanyLocationUser
                    profile:
                      firstName: 
                      lastName: 
                      title: Unknown
                      email: atlanta@delta.com
                      address: 
                      phone: 
                    credentials:
                      userName: atlanta
                      password: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/organizations/companies/{companyUid}/subscriptionPlan':
    get:
      tags:
        - Subscription Plans
      summary: Get Subscription Plan Assigned to Company
      description: Returns a resource representation of a subscription plan assigned to a company with the specified UID. If there is no subscription plan assigned the response will be empty.
      operationId: GetAssignedToCompanySubscriptionPlan
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SubscriptionPlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 94019fe2-b9cf-4c87-9b84-771b099c04ff
                  name: Philadelphia subscription plan
                  organizationUid: 78b927a7-746a-4642-973a-1d659845517e
                  type: Provider
                  description: Subscription plan for premium clients
                  currency: USD
                  taxType: VAT
                  taxPercent: 9
                  discountPercent: 10
                  managedBackup:
                    managedServicePrice: 20
                    monitoredServicePrice: 0
                    remoteManagedVmPrice: 0
                    remoteManagedCdpVmPrice: 0
                    remoteManagedWorkstationPrice: 0
                    remoteManagedServerAgentPrice: 0
                    remoteFreeManagedVms: 0
                    remoteFreeManagedCdpVms: 0
                    remoteFreeManagedWorkstations: 0
                    remoteFreeManagedServerAgents: 0
                    remoteWindowsServerOsPrice: 0
                    remoteWindowsClientOsPrice: 0
                    remoteLinuxOsPrice: 0
                    remoteMacOsPrice: 0
                    remoteBackupUsedSpacePrice: 0
                    remoteBackupUsedSpaceUnits: GB
                    remoteFreeBackupUsedSpace: 
                    remoteFreeBackupUsedSpaceUnits: GB
                    remoteRepositorySpaceUsageAlgorithm: Consumed
                    remoteRepositoryAllocatedSpacePrice: 0
                    remoteRepositoryAllocatedSpaceUnits: GB
                    remoteRoundUpBackupUsedSpace: false
                    remoteBackupUsedSpaceChunkSize: 1
                    hostedManagedVmPrice: 0
                    hostedManagedCdpVmPrice: 0
                    hostedManagedWorkstationPrice: 0
                    hostedManagedServerAgentPrice: 0
                    hostedFreeManagedVms: 0
                    hostedFreeManagedCdpVms: 0
                    hostedFreeManagedWorkstations: 0
                    hostedFreeManagedServerAgents: 0
                    hostedWindowsServerOsPrice: 0
                    hostedWindowsClientOsPrice: 0
                    hostedLinuxOsPrice: 0
                    hostedMacOsPrice: 0
                    hostedBackupUsedSpacePrice: 0
                    hostedBackupUsedSpaceUnits: GB
                    hostedFreeBackupUsedSpace: 
                    hostedFreeBackupUsedSpaceUnits: GB
                    hostedRepositorySpaceUsageAlgorithm: Consumed
                    hostedRepositoryAllocatedSpacePrice: 0
                    hostedRepositoryAllocatedSpaceUnits: GB
                    hostedRoundUpBackupUsedSpace: false
                    hostedBackupUsedSpaceChunkSize: 1
                  publicCloud:
                    remoteCloudVmPrice: 0
                    remoteFreeCloudVms: 0
                    remoteCloudFileSharePrice: 0
                    remoteFreeCloudFileShares: 0
                    remoteCloudDatabasePrice: 0
                    remoteFreeCloudDatabases: 0
                    remoteCloudNetworkPrice: 0
                    remoteBackupUsedSpacePrice: 0
                    remoteBackupUsedSpaceUnits: GB
                    remoteFreeBackupUsedSpace: 
                    remoteFreeBackupUsedSpaceUnits: GB
                    remoteArchiveUsedSpacePrice: 0
                    remoteArchiveUsedSpaceUnits: GB
                    remoteFreeArchiveUsedSpace: 
                    remoteFreeArchiveUsedSpaceUnits: GB
                    hostedCloudVmPrice: 0
                    hostedFreeCloudVms: 0
                    hostedCloudFileSharePrice: 0
                    hostedFreeCloudFileShares: 0
                    hostedCloudDatabasePrice: 0
                    hostedFreeCloudDatabases: 0
                    hostedCloudNetworkPrice: 0
                    hostedBackupUsedSpacePrice: 0
                    hostedBackupUsedSpaceUnits: GB
                    hostedFreeBackupUsedSpace: 
                    hostedFreeBackupUsedSpaceUnits: GB
                    hostedArchiveUsedSpacePrice: 0
                    hostedArchiveUsedSpaceUnits: GB
                    hostedFreeArchiveUsedSpace: 
                    hostedFreeArchiveUsedSpaceUnits: GB
                  vb365:
                    remoteSubscriptionUserPrice: 0
                    remoteFreeSubscriptionUsers: 0
                    remoteEducationalUserPrice: 0
                    remoteFreeEducationalUsers: 0
                    remoteRoundUpUsedSpace: false
                    remoteStandardStorageUsedSpacePrice: 0
                    remoteStandardStorageUsedSpaceChunkSize: 1
                    remoteStandardStorageUsedSpaceUnits: GB
                    remoteFreeStandardStorageUsedSpace: 
                    remoteFreeStandardStorageUsedSpaceUnits: GB
                    remoteArchiveStorageUsedSpacePrice: 0
                    remoteArchiveStorageUsedSpaceChunkSize: 1
                    remoteArchiveStorageUsedSpaceUnits: GB
                    remoteFreeArchiveStorageUsedSpace: 
                    remoteFreeArchiveStorageUsedSpaceUnits: GB
                    remoteRepositorySpaceUsageAlgorithm: Consumed
                    remoteRepositoryAllocatedSpacePrice: 0
                    remoteRepositoryAllocatedSpaceUnits: GB
                    hostedSubscriptionUserPrice: 0
                    hostedFreeSubscriptionUsers: 0
                    hostedEducationalUserPrice: 0
                    hostedFreeEducationalUsers: 0
                    hostedRoundUpUsedSpace: false
                    hostedStandardStorageUsedSpacePrice: 0
                    hostedStandardStorageUsedSpaceChunkSize: 1
                    hostedStandardStorageUsedSpaceUnits: GB
                    hostedFreeStandardStorageUsedSpace: 
                    hostedFreeStandardStorageUsedSpaceUnits: GB
                    hostedArchiveStorageUsedSpacePrice: 0
                    hostedArchiveStorageUsedSpaceChunkSize: 1
                    hostedArchiveStorageUsedSpaceUnits: GB
                    hostedFreeArchiveStorageUsedSpace: 
                    hostedFreeArchiveStorageUsedSpaceUnits: GB
                    hostedRepositorySpaceUsageAlgorithm: Consumed
                    hostedRepositoryAllocatedSpacePrice: 0
                    hostedRepositoryAllocatedSpaceUnits: GB
                  cloudReplication:
                    replicatedVmPrice: 10
                    cloudStorageConsumedSpacePrice: 9
                    cloudStorageConsumedSpaceUnits: TB
                    freeCloudStorageConsumedSpace: 
                    freeCloudStorageConsumedSpaceUnits: GB
                    computeResourcesPrice: 0
                    computeResourcesUnits: Hours
                    freeComputeResources: 1
                    freeComputeResourcesUnits: Days
                    replicationDataTransferOutPrice: 0
                    replicationDataTransferOutUnits: GB
                  fileShareBackup:
                    fileShareRemoteBackupUsedSpacePrice: 0
                    fileShareRemoteBackupUsedSpaceUnits: GB
                    freeFileShareRemoteBackupUsedSpace: 
                    freeFileShareRemoteBackupUsedSpaceUnits: GB
                    fileShareRemoteArchiveUsedSpacePrice: 0
                    fileShareRemoteArchiveUsedSpaceUnits: GB
                    freeFileShareRemoteArchiveUsedSpace: 
                    freeFileShareRemoteArchiveUsedSpaceUnits: GB
                    sourceRemoteAmountOfDataPrice: 0
                    sourceRemoteAmountOfDataUnits: GB
                    freeSourceRemoteAmountOfData: 
                    freeSourceRemoteAmountOfDataUnits: GB
                    fileShareHostedBackupUsedSpacePrice: 0
                    fileShareHostedBackupUsedSpaceUnits: GB
                    freeFileShareHostedBackupUsedSpace: 
                    freeFileShareHostedBackupUsedSpaceUnits: GB
                    fileShareHostedArchiveUsedSpacePrice: 0
                    fileShareHostedArchiveUsedSpaceUnits: GB
                    freeFileShareHostedArchiveUsedSpace: 
                    freeFileShareHostedArchiveUsedSpaceUnits: GB
                    sourceHostedAmountOfDataPrice: 0
                    sourceHostedAmountOfDataUnits: GB
                    freeSourceHostedAmountOfData: 
                    freeSourceHostedAmountOfDataUnits: GB
                  cloudBackup:
                    roundUpUsedSpace: false
                    vmCloudBackupsPrice: 5
                    serverCloudBackupsPrice: 6
                    workstationCloudBackupsPrice: 7
                    cloudRepositorySpaceUsageAlgorithm: Consumed
                    cloudRepositoryAllocatedSpacePrice: 11
                    cloudRepositoryAllocatedSpaceUnits: TB
                    cloudRepositoryConsumedSpacePrice: 15
                    cloudRepositoryConsumedSpaceChunkSize: 1
                    cloudRepositoryConsumedSpaceUnits: TB
                    freeCloudRepositoryConsumedSpace: 
                    freeCloudRepositoryConsumedSpaceUnits: GB
                    backupDataTransferOutPrice: 8
                    backupDataTransferOutUnits: GB
                    insiderProtectionUsedSpacePrice: 0
                    insiderProtectionUsedSpaceUnits: GB
                    performanceTierUsedSpacePrice: 0
                    performanceTierUsedSpaceChunkSize: 1
                    performanceTierUsedSpaceUnits: GB
                    capacityTierUsedSpacePrice: 0
                    capacityTierUsedSpaceChunkSize: 1
                    capacityTierUsedSpaceUnits: GB
                    archiveTierUsedSpacePrice: 0
                    archiveTierUsedSpaceChunkSize: 1
                    archiveTierUsedSpaceUnits: GB
                  licenses:
                    vspcLicenses:
                      workstationPrice: 0
                      serverPrice: 0
                    backupAndReplicationStandardEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    backupAndReplicationEnterpriseEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    backupAndReplicationEnterprisePlusEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpFoundationPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpAdvancedPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpPremiumPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    cloudConnectLicenses:
                      vmBackupPrice: 0
                      vmReplicaPrice: 0
                      workstationBackupPrice: 0
                      serverBackupPrice: 0
                    vb365Licenses:
                      userPrice: 0
                    veeamOneLicenses:
                      monitoredObjectPrice: 0
                  externalPlugins: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /organizations/companies/billing/settings/:
    get:
      tags:
        - Billing
      summary: Get Company Billing Settings
      description: Returns a collection resource representation of billing settings configured for all companies.
      operationId: GetBillingSettings
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BillingSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - organizationUid: 582c04dc-b7d0-4a4e-ba70-3bde7ba48f9a
                    includeDetails: false
                  - organizationUid: 1d3fe4d4-f478-4305-8fac-6d377b04bc12
                    includeDetails: false
                  - organizationUid: 1eb4ae30-1d6e-45c5-910d-7df2624c3bbe
                    includeDetails: false
                  - organizationUid: bec74a3c-acc3-4ed8-af32-000f10c32bf6
                    includeDetails: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/organizations/companies/{companyUid}/billing/settings/':
    get:
      tags:
        - Billing
      summary: Get Billing Settings of Company
      description: Returns a resource representation of billing settings configured for a company with the specified UID.
      operationId: GetBillingSettingsByCompany
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BillingSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  organizationUid: 582c04dc-b7d0-4a4e-ba70-3bde7ba48f9a
                  includeDetails: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/BillingSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
    patch:
      tags:
        - Billing
      summary: Modify Billing Settings of Company
      description: Modifies billing settings for a company wth the specified UID.
      operationId: PatchBillingSettings
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 'true'
                path: /includeDetails
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BillingSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  organizationUid: 582c04dc-b7d0-4a4e-ba70-3bde7ba48f9a
                  includeDetails: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BillingSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
  /organizations/companies/billing/invoices/:
    get:
      tags:
        - Billing
      summary: Get All Company Invoices
      description: Returns a collection resource representation of invoices generated for all companies.
      operationId: GetInvoices
      parameters:
        - name: fromDate
          in: query
          description: Start timestamp of a searched time range.
          required: true
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          description: End timestamp of a searched time range. Total time range must be less than or equal to 1 year.
          required: true
          schema:
            type: string
            format: date
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invoice'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - name: Invoice_Quota_Usage_July_12_2025
                    organizationUid: 94019fe2-b9cf-4c87-9b84-771b099c04ff
                    instanceUid: e9324d8b-06d4-475b-9cd5-05d43ab5a13e
                    amount: 84.26
                    currencyCode: USD
                    subscriptionPlanUid: ac601d49-c7c0-4e3e-95dc-5ca17e6617f3
                    creationDate: '2025-07-12T14:58:18.7470000+02:00'
                    paidDate: 
                    dueDate: '2025-07-12T14:58:18.7600000+02:00'
                    status: Unpaid
                    type: Invoice
                    data:
                      period:
                        fromDate: '2025-07-01T14:00:00.0000000+02:00'
                        toDate: '2025-07-12T14:00:00.0000000+02:00'
                      charges:
                        - category: ManagedRemoteVm
                          measure: Units
                          quantity: 13
                          net: 64.79
                          gross: 65
                          discount: 7.15
                          tax: 6.94
                        - category: RemoteShortTermBackup
                          measure: TB
                          quantity: 0.008
                          net: 0.06
                          gross: 0.06
                          discount: 0.01
                          tax: 0.01
                        - category: RemoteSourceAmountOfData
                          measure: TB
                          quantity: 0.008
                          net: 0.06
                          gross: 0.06
                          discount: 0.01
                          tax: 0.01
                        - category: Vb365User
                          measure: Units
                          quantity: 1
                          net: 12.96
                          gross: 13
                          discount: 1.43
                          tax: 1.39
                        - category: Vb365BackupSize
                          measure: TB
                          quantity: 0.079
                          net: 1.74
                          gross: 1.74
                          discount: 0.19
                          tax: 0.19
                        - category: Vb365ArchiveSize
                          measure: TB
                          quantity: 0.079
                          net: 3.55
                          gross: 3.56
                          discount: 0.39
                          tax: 0.38
                        - category: ManagedRemoteServices
                          measure: Months
                          quantity: 0.367
                          net: 0.37
                          gross: 0.37
                          discount: 0.04
                          tax: 0.04
                        - category: MonitoredRemoteServices
                          measure: Months
                          quantity: 0.367
                          net: 0.73
                          gross: 0.73
                          discount: 0.08
                          tax: 0.08
                      totalNet: 84.26
                      totalGross: 84.52
                      totalDiscount: 9.3
                      totalTax: 9.04
                  - name: Invoice_Quota_Usage_July_12_2025
                    organizationUid: 9e235def-0a77-4f71-baf8-288d6f485c19
                    instanceUid: 10842e7e-62e4-48a8-824d-38396ec6423e
                    amount: 0.2
                    currencyCode: USD
                    subscriptionPlanUid: 3ad175ee-5417-4668-80bf-75f354fb85ad
                    creationDate: '2025-07-12T18:51:54.6270000+02:00'
                    paidDate: 
                    dueDate: '2025-07-12T18:51:54.6270000+02:00'
                    status: Unpaid
                    type: Invoice
                    data:
                      period:
                        fromDate: '2025-07-10T14:00:00.0000000+02:00'
                        toDate: '2025-07-12T14:00:00.0000000+02:00'
                      charges:
                        - category: ManagedRemoteServices
                          measure: Months
                          quantity: 0.067
                          net: 0.07
                          gross: 0.07
                          discount: 0.01
                          tax: 0.01
                        - category: MonitoredRemoteServices
                          measure: Months
                          quantity: 0.067
                          net: 0.13
                          gross: 0.13
                          discount: 0.01
                          tax: 0.01
                      totalNet: 0.2
                      totalGross: 0.2
                      totalDiscount: 0.02
                      totalTax: 0.02
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - CompanyInvoiceAuditor
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
  '/organizations/companies/{companyUid}/billing/invoices':
    get:
      tags:
        - Billing
      summary: Get All Invoices for Company
      description: Returns a resource representation of all invoices generated for a company with the specified UID.
      operationId: GetInvoicesByCompany
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: fromDate
          in: query
          description: Start timestamp of a searched time range.
          required: true
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          description: End timestamp of a searched time range. Total time range must be less than or equal to 1 year.
          required: true
          schema:
            type: string
            format: date
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Invoice'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - name: Invoice_Quota_Usage_June_12_2025
                    organizationUid: 94019fe2-b9cf-4c87-9b84-771b099c04ff
                    instanceUid: e9324d8b-06d4-475b-9cd5-05d43ab5a13e
                    amount: 84.26
                    currencyCode: USD
                    subscriptionPlanUid: ac601d49-c7c0-4e3e-95dc-5ca17e6617f3
                    creationDate: '2025-06-12T14:58:18.7470000+02:00'
                    paidDate: 
                    dueDate: '2025-06-12T14:58:18.7600000+02:00'
                    status: Unpaid
                    type: Invoice
                    data:
                      period:
                        fromDate: '2025-06-01T14:00:00.0000000+02:00'
                        toDate: '2025-06-12T14:00:00.0000000+02:00'
                      charges:
                        - category: ManagedRemoteVm
                          measure: Units
                          quantity: 13
                          net: 64.79
                          gross: 65
                          discount: 7.15
                          tax: 6.94
                        - category: RemoteShortTermBackup
                          measure: TB
                          quantity: 0.008
                          net: 0.06
                          gross: 0.06
                          discount: 0.01
                          tax: 0.01
                        - category: RemoteSourceAmountOfData
                          measure: TB
                          quantity: 0.008
                          net: 0.06
                          gross: 0.06
                          discount: 0.01
                          tax: 0.01
                        - category: Vb365User
                          measure: Units
                          quantity: 1
                          net: 12.96
                          gross: 13
                          discount: 1.43
                          tax: 1.39
                        - category: Vb365BackupSize
                          measure: TB
                          quantity: 0.079
                          net: 1.74
                          gross: 1.74
                          discount: 0.19
                          tax: 0.19
                        - category: Vb365ArchiveSize
                          measure: TB
                          quantity: 0.079
                          net: 3.55
                          gross: 3.56
                          discount: 0.39
                          tax: 0.38
                        - category: ManagedRemoteServices
                          measure: Months
                          quantity: 0.367
                          net: 0.37
                          gross: 0.37
                          discount: 0.04
                          tax: 0.04
                        - category: MonitoredRemoteServices
                          measure: Months
                          quantity: 0.367
                          net: 0.73
                          gross: 0.73
                          discount: 0.08
                          tax: 0.08
                      totalNet: 84.26
                      totalGross: 84.52
                      totalDiscount: 9.3
                      totalTax: 9.04
                  - name: Invoice_Quota_Usage_July_12_2025
                    organizationUid: 94019fe2-b9cf-4c87-9b84-771b099c04ff
                    instanceUid: 10842e7e-62e4-48a8-824d-38396ec6423e
                    amount: 0.2
                    currencyCode: USD
                    subscriptionPlanUid: 3ad175ee-5417-4668-80bf-75f354fb85ad
                    creationDate: '2025-07-12T18:51:54.6270000+02:00'
                    paidDate: 
                    dueDate: '2025-07-12T18:51:54.6270000+02:00'
                    status: Unpaid
                    type: Invoice
                    data:
                      period:
                        fromDate: '2025-07-10T14:00:00.0000000+02:00'
                        toDate: '2025-07-12T14:00:00.0000000+02:00'
                      charges:
                        - category: ManagedRemoteServices
                          measure: Months
                          quantity: 0.067
                          net: 0.07
                          gross: 0.07
                          discount: 0.01
                          tax: 0.01
                        - category: MonitoredRemoteServices
                          measure: Months
                          quantity: 0.067
                          net: 0.13
                          gross: 0.13
                          discount: 0.01
                          tax: 0.01
                      totalNet: 0.2
                      totalGross: 0.2
                      totalDiscount: 0.02
                      totalTax: 0.02
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - CompanyInvoiceAuditor
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
  '/organizations/companies/{companyUid}/billing/generateInvoices':
    post:
      tags:
        - Billing
      summary: Generate Invoice for Company
      description: Initiates invoice generation for a company with the specified UID.
      operationId: GenerateInvoice
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/companies/{companyUid}/billing/generateQuotaUsageReport':
    post:
      tags:
        - Billing
      summary: Generate Quota Usage Report for Company
      description: Initiates quota usage report for a company with the specified UID.
      operationId: GenerateQuotaUsageReport
      parameters:
        - $ref: '#/components/parameters/companyUid_path'
        - name: fromDate
          in: query
          description: Start timestamp of a searched time range.
          required: true
          schema:
            type: string
            format: date
        - name: toDate
          in: query
          description: End timestamp of a searched time range.
          required: true
          schema:
            type: string
            format: date
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/companies/billing/invoices/{invoiceUid}':
    get:
      tags:
        - Billing
      summary: Get Invoice
      description: Returns a resource representation of an invoice with the specified UID.
      operationId: GetInvoice
      parameters:
        - name: invoiceUid
          in: path
          description: Invoice UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Invoice'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: Invoice_Quota_Usage_July_12_2025
                  organizationUid: 94019fe2-b9cf-4c87-9b84-771b099c04ff
                  instanceUid: e9324d8b-06d4-475b-9cd5-05d43ab5a13e
                  amount: 84.26
                  currencyCode: USD
                  subscriptionPlanUid: ac601d49-c7c0-4e3e-95dc-5ca17e6617f3
                  creationDate: '2025-07-12T14:58:18.7470000+02:00'
                  paidDate: 
                  dueDate: '2025-07-12T14:58:18.7600000+02:00'
                  status: Unpaid
                  type: Invoice
                  data:
                    period:
                      fromDate: '2025-07-01T14:00:00.0000000+02:00'
                      toDate: '2025-07-12T14:00:00.0000000+02:00'
                    charges:
                      - category: ManagedRemoteVm
                        measure: Units
                        quantity: 13
                        net: 64.79
                        gross: 65
                        discount: 7.15
                        tax: 6.94
                      - category: RemoteShortTermBackup
                        measure: TB
                        quantity: 0.008
                        net: 0.06
                        gross: 0.06
                        discount: 0.01
                        tax: 0.01
                      - category: RemoteSourceAmountOfData
                        measure: TB
                        quantity: 0.008
                        net: 0.06
                        gross: 0.06
                        discount: 0.01
                        tax: 0.01
                      - category: Vb365User
                        measure: Units
                        quantity: 1
                        net: 12.96
                        gross: 13
                        discount: 1.43
                        tax: 1.39
                      - category: Vb365BackupSize
                        measure: TB
                        quantity: 0.079
                        net: 1.74
                        gross: 1.74
                        discount: 0.19
                        tax: 0.19
                      - category: Vb365ArchiveSize
                        measure: TB
                        quantity: 0.079
                        net: 3.55
                        gross: 3.56
                        discount: 0.39
                        tax: 0.38
                      - category: ManagedRemoteServices
                        measure: Months
                        quantity: 0.367
                        net: 0.37
                        gross: 0.37
                        discount: 0.04
                        tax: 0.04
                      - category: MonitoredRemoteServices
                        measure: Months
                        quantity: 0.367
                        net: 0.73
                        gross: 0.73
                        discount: 0.08
                        tax: 0.08
                    totalNet: 84.26
                    totalGross: 84.52
                    totalDiscount: 9.3
                    totalTax: 9.04
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - CompanyInvoiceAuditor
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
    delete:
      tags:
        - Billing
      summary: Delete Invoice.
      description: Deletes an invoice with the specified UID.
      operationId: DeleteInvoice
      parameters:
        - name: invoiceUid
          in: path
          description: Invoice UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/companies/billing/invoices/{invoiceUid}/pdf':
    get:
      tags:
        - Billing
      summary: Download Invoice
      description: Returns a download link to an invoice with the specified UID in the `PDF` format.
      operationId: DownloadInvoicePdf
      parameters:
        - name: invoiceUid
          in: path
          description: Invoice UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '520':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example: blob:https://vspc01.tech.local:1280/ddb406fa-39a9-4995-adfa-e14f627e0fce
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - CompanyInvoiceAuditor
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
  '/organizations/companies/billing/invoices/{invoiceUid}/changePaidState':
    post:
      tags:
        - Billing
      summary: Change Invoice Payment Status
      description: Changes payment status of an invoice with the specified UID.
      operationId: ChangeInvoicePaidState
      parameters:
        - name: invoiceUid
          in: path
          description: Invoice UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: status
          in: query
          description: Payment status.
          required: true
          schema:
            enum:
              - Paid
              - Unpaid
            type: string
          x-ms-enum:
            name: InvoicePaidStatus
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/companies/billing/invoices/{invoiceUid}/send':
    post:
      tags:
        - Billing
      summary: Send Invoice
      description: Sends an invoice with the specified UID.
      operationId: SendInvoice
      parameters:
        - name: invoiceUid
          in: path
          description: Invoice UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/organizations/{organizationUid}/keys':
    get:
      tags:
        - Accounts
      summary: Get Organization Keys
      description: Returns a collection resource representation of all RSA and API keys issued to users of an organization with the specified UID.
      operationId: GetOrganizationApiKeys
      parameters:
        - $ref: '#/components/parameters/organizationUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UserLogin'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: 28
                    userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                    userName: VSPC1\Administrator
                    companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    companyName: My Company
                    identityProviderName: Zeta
                    description: r3_key
                    isReadAccessOnly: false
                    scopes:
                      - rest
                      - ui
                    status: enabled
                    parameters: <RSAKeyValue><Modulus>MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDzjSnvNm3o5mCCXo+l/+WhggwuUTAsZOcl8xUePlxVYXwBbG268Ljkny5Pv2sn/votf4a6zEAY4r7l+7pIi8zyKRunyaJ52mkhlVTJgMtm9lMqcLUSwJuF9U77wG8F0KYsWQ84sjzAmJw9htJy+pI6ATKI+NPJekPuJbvj9Pb/nwIDAQAB</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
                    identifierInProvider: RSA::202C4715D9B6870E016A2E9348B3B56D
                    creationDate: '2023-11-19T07:09:23.3643798+01:00'
                  - id: 35
                    userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                    userName: VSPC1\Administrator
                    companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    companyName: My Company
                    identityProviderName: Zeta
                    description: VSPC1 Admin Key
                    isReadAccessOnly: false
                    scopes:
                      - rest
                      - ui
                    status: enabled
                    parameters: <RSAKeyValue><Modulus>MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAlKahNsGDR2VyKx6HbLwsEz9cOO/ILVdqYqjDEplNCjtl35l8WvCDr5WyATQoh1HBciQYbsDv5bc0OikBgJgHvOw4WC7w4a7SvDQMrBJQzVAiu+db3C+C77Nev74tXIMYEsNpLGBJyHtpKcTUYvbxyDGWFOm0VGGdEldmAnUv4+WQFAsnFSAiOZlt0kKQY6W8zKn2VMzrgBrHbpALn9z52g0LhYnuD6/RRt053F5nPPKI2PgwkJs1MwkFluvkz+ztWvl82VGWRuM96OR/EnyIWooMmHm8bsz7aiyvsGAXuU4J0iElOl5A6XgfhpTvE0gQix2geKJ3wPYBeYnL5ncLsQIDAQAB</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
                    identifierInProvider: RSA::8DF00096789D82AD5EE5A9BDC6BCA58D
                    creationDate: '2023-11-19T07:20:26.1829573+01:00'
                  - id: 36
                    userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                    userName: VSPC1\Administrator
                    companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    companyName: My Company
                    identityProviderName: Zeta
                    description: ''
                    isReadAccessOnly: false
                    scopes:
                      - rest
                      - ui
                    status: enabled
                    parameters: <RSAKeyValue><Modulus>MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAkp636VWB4Gbtd+sD2g6WUWmobZaDoUGEDX9XZ01aAktWdDmLEhzSpipT4b3atg2nfK2xdCUqQinwM8+rZbbQMY9mvudwrjjmAqK3JLRhVl0qrl6+8pBc1DK7x1Xaghgn9tpf7r3UsJQ0XGAAmlqGlZSTrh/Zx2d/C8piw9PbR18sl5cpcU+DDH1UAf1UQTsU72O0Y1mu8BBEk23S3KuYJmlQOLJb3E3l8prr8S5Z7UUN8zzi/x2R6tIx7EyZg8YqSR4r+2qGa5pS8Zj+R3/8MHzREH/7VIpqWejhWiR9Tya7ldWT8Evt740/9bAjPDAIbwrV6TSwSyLalyIwcEdgxQIDAQAB</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
                    identifierInProvider: RSA::DBCFA0676E5D04E8F358B51B0D0623CB
                    creationDate: '2023-11-19T07:20:26.2454797+01:00'
                  - id: 37
                    userUid: 1664927a-da62-4434-9f50-2c1b099948f2
                    userName: VSPC1\Administrator
                    companyId: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    companyName: My Company
                    identityProviderName: Zeta
                    description: ''
                    isReadAccessOnly: false
                    scopes:
                      - rest
                      - ui
                    status: enabled
                    parameters: <RSAKeyValue><Modulus>MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIBigKCAYEAl7ERCQz43JEF+aVrLIi7IaXFRYU0wT+dwh52KMd6GrbTbikmeSYTiZTc6D9jwi6L6X9es1VHA/alOQB60kcetmykf8Th/QWB+R7GIBb9GQZMHq86kcwXr9EVzvJFZv7Fzu1LCHqh2kesShm8BdMkMzOn55X+uZwnzMOBtLl4Iv767dfD/IAadIzvPivD/kO3KdrQ65dKPzP27P+MsQNwgljPgFmdFbqL2P3RXXexxtKOpqDrOu+CIOG9cGWFJeRCN4tOTbz3z13A9pPC70kJSkMQbsHuVs1COrKD2J2TARIFl+yndAj5gqPXg6hUgDptnhCn4oLaoNvXIxaWKmIssltB/CfmA/Bz4Gi9pjkqZ0n0r7Awc6h+Vpo/ZVc6Z8yRKwA/9V7mhqBkLLzJ+jHS/pkpJZFJy7LCOkIgsaGL09iLuSqO4yOd8CaaIJ8LJ2kG2wXIiGvQcU+F7PVGRY8Nm28aZvlvpb9zfQktd88/70bRLK2Awxng1NrX62UL5B1ZAgMBAAE=</Modulus><Exponent>AQAB</Exponent></RSAKeyValue>
                    identifierInProvider: RSA::FB7C8694B28A378E08BF587EE84A79A0
                    creationDate: '2023-11-19T07:20:26.3235887+01:00'
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /subscriptionPlans:
    get:
      tags:
        - Subscription Plans
      summary: Get All Subscription Plans
      description: Returns a collection resource representation of all subscription plans.
      operationId: GetSubscriptionPlans
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SubscriptionPlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 94019fe2-b9cf-4c87-9b84-771b099c04ff
                    name: Default subscription plan
                    organizationUid: e9324d8b-06d4-475b-9cd5-05d43ab5a13e
                    type: Predefined
                    description: This plan does not include any price for provided services and can be used for trialing purposes.
                    currency: USD
                    taxType: VAT
                    taxPercent: 0
                    discountPercent: 0
                    managedBackup:
                      managedServicePrice: 0
                      monitoredServicePrice: 0
                      remoteManagedVmPrice: 0
                      remoteManagedCdpVmPrice: 0
                      remoteManagedWorkstationPrice: 0
                      remoteManagedServerAgentPrice: 0
                      remoteFreeManagedVms: 0
                      remoteFreeManagedCdpVms: 0
                      remoteFreeManagedWorkstations: 0
                      remoteFreeManagedServerAgents: 0
                      remoteWindowsServerOsPrice: 0
                      remoteWindowsClientOsPrice: 0
                      remoteLinuxOsPrice: 0
                      remoteMacOsPrice: 0
                      remoteBackupUsedSpacePrice: 0
                      remoteBackupUsedSpaceUnits: TB
                      remoteFreeBackupUsedSpace: 
                      remoteFreeBackupUsedSpaceUnits: GB
                      remoteRepositorySpaceUsageAlgorithm: Allocated
                      remoteRepositoryAllocatedSpacePrice: 0
                      remoteRepositoryAllocatedSpaceUnits: TB
                      remoteRoundUpBackupUsedSpace: false
                      remoteBackupUsedSpaceChunkSize: 1
                      hostedManagedVmPrice: 0
                      hostedManagedCdpVmPrice: 0
                      hostedManagedWorkstationPrice: 0
                      hostedManagedServerAgentPrice: 0
                      hostedFreeManagedVms: 0
                      hostedFreeManagedCdpVms: 0
                      hostedFreeManagedWorkstations: 0
                      hostedFreeManagedServerAgents: 0
                      hostedWindowsServerOsPrice: 0
                      hostedWindowsClientOsPrice: 0
                      hostedLinuxOsPrice: 0
                      hostedMacOsPrice: 0
                      hostedBackupUsedSpacePrice: 0
                      hostedBackupUsedSpaceUnits: TB
                      hostedFreeBackupUsedSpace: 
                      hostedFreeBackupUsedSpaceUnits: GB
                      hostedRepositorySpaceUsageAlgorithm: Allocated
                      hostedRepositoryAllocatedSpacePrice: 0
                      hostedRepositoryAllocatedSpaceUnits: TB
                      hostedRoundUpBackupUsedSpace: false
                      hostedBackupUsedSpaceChunkSize: 1
                    publicCloud:
                      remoteCloudVmPrice: 0
                      remoteFreeCloudVms: 0
                      remoteCloudFileSharePrice: 0
                      remoteFreeCloudFileShares: 0
                      remoteCloudDatabasePrice: 0
                      remoteFreeCloudDatabases: 0
                      remoteCloudNetworkPrice: 0
                      remoteBackupUsedSpacePrice: 0
                      remoteBackupUsedSpaceUnits: TB
                      remoteFreeBackupUsedSpace: 
                      remoteFreeBackupUsedSpaceUnits: GB
                      remoteArchiveUsedSpacePrice: 0
                      remoteArchiveUsedSpaceUnits: TB
                      remoteFreeArchiveUsedSpace: 
                      remoteFreeArchiveUsedSpaceUnits: GB
                      hostedCloudVmPrice: 0
                      hostedFreeCloudVms: 0
                      hostedCloudFileSharePrice: 0
                      hostedFreeCloudFileShares: 0
                      hostedCloudDatabasePrice: 0
                      hostedFreeCloudDatabases: 0
                      hostedCloudNetworkPrice: 0
                      hostedBackupUsedSpacePrice: 0
                      hostedBackupUsedSpaceUnits: TB
                      hostedFreeBackupUsedSpace: 
                      hostedFreeBackupUsedSpaceUnits: GB
                      hostedArchiveUsedSpacePrice: 0
                      hostedArchiveUsedSpaceUnits: TB
                      hostedFreeArchiveUsedSpace: 
                      hostedFreeArchiveUsedSpaceUnits: GB
                    vb365:
                      remoteSubscriptionUserPrice: 0
                      remoteFreeSubscriptionUsers: 0
                      remoteEducationalUserPrice: 0
                      remoteFreeEducationalUsers: 0
                      remoteRoundUpUsedSpace: false
                      remoteStandardStorageUsedSpacePrice: 0
                      remoteStandardStorageUsedSpaceChunkSize: 1
                      remoteStandardStorageUsedSpaceUnits: TB
                      remoteFreeStandardStorageUsedSpace: 
                      remoteFreeStandardStorageUsedSpaceUnits: GB
                      remoteArchiveStorageUsedSpacePrice: 0
                      remoteArchiveStorageUsedSpaceChunkSize: 1
                      remoteArchiveStorageUsedSpaceUnits: TB
                      remoteFreeArchiveStorageUsedSpace: 
                      remoteFreeArchiveStorageUsedSpaceUnits: GB
                      remoteRepositorySpaceUsageAlgorithm: Allocated
                      remoteRepositoryAllocatedSpacePrice: 0
                      remoteRepositoryAllocatedSpaceUnits: TB
                      hostedSubscriptionUserPrice: 0
                      hostedFreeSubscriptionUsers: 0
                      hostedEducationalUserPrice: 0
                      hostedFreeEducationalUsers: 0
                      hostedRoundUpUsedSpace: false
                      hostedStandardStorageUsedSpacePrice: 0
                      hostedStandardStorageUsedSpaceChunkSize: 1
                      hostedStandardStorageUsedSpaceUnits: TB
                      hostedFreeStandardStorageUsedSpace: 
                      hostedFreeStandardStorageUsedSpaceUnits: GB
                      hostedArchiveStorageUsedSpacePrice: 0
                      hostedArchiveStorageUsedSpaceChunkSize: 1
                      hostedArchiveStorageUsedSpaceUnits: TB
                      hostedFreeArchiveStorageUsedSpace: 
                      hostedFreeArchiveStorageUsedSpaceUnits: GB
                      hostedRepositorySpaceUsageAlgorithm: Allocated
                      hostedRepositoryAllocatedSpacePrice: 0
                      hostedRepositoryAllocatedSpaceUnits: TB
                    cloudReplication:
                      replicatedVmPrice: 0
                      cloudStorageConsumedSpacePrice: 0
                      cloudStorageConsumedSpaceUnits: TB
                      freeCloudStorageConsumedSpace: 
                      freeCloudStorageConsumedSpaceUnits: GB
                      computeResourcesPrice: 0
                      computeResourcesUnits: Hours
                      freeComputeResources: 0
                      freeComputeResourcesUnits: Minutes
                      replicationDataTransferOutPrice: 0
                      replicationDataTransferOutUnits: GB
                    fileShareBackup:
                      fileShareRemoteBackupUsedSpacePrice: 0
                      fileShareRemoteBackupUsedSpaceUnits: TB
                      freeFileShareRemoteBackupUsedSpace: 
                      freeFileShareRemoteBackupUsedSpaceUnits: GB
                      fileShareRemoteArchiveUsedSpacePrice: 0
                      fileShareRemoteArchiveUsedSpaceUnits: TB
                      freeFileShareRemoteArchiveUsedSpace: 
                      freeFileShareRemoteArchiveUsedSpaceUnits: GB
                      sourceRemoteAmountOfDataPrice: 0
                      sourceRemoteAmountOfDataUnits: TB
                      freeSourceRemoteAmountOfData: 
                      freeSourceRemoteAmountOfDataUnits: GB
                      fileShareHostedBackupUsedSpacePrice: 0
                      fileShareHostedBackupUsedSpaceUnits: TB
                      freeFileShareHostedBackupUsedSpace: 
                      freeFileShareHostedBackupUsedSpaceUnits: GB
                      fileShareHostedArchiveUsedSpacePrice: 0
                      fileShareHostedArchiveUsedSpaceUnits: TB
                      freeFileShareHostedArchiveUsedSpace: 
                      freeFileShareHostedArchiveUsedSpaceUnits: GB
                      sourceHostedAmountOfDataPrice: 0
                      sourceHostedAmountOfDataUnits: TB
                      freeSourceHostedAmountOfData: 
                      freeSourceHostedAmountOfDataUnits: GB
                    cloudBackup:
                      roundUpUsedSpace: false
                      vmCloudBackupsPrice: 0
                      serverCloudBackupsPrice: 0
                      workstationCloudBackupsPrice: 0
                      cloudRepositorySpaceUsageAlgorithm: Allocated
                      cloudRepositoryAllocatedSpacePrice: 0
                      cloudRepositoryAllocatedSpaceUnits: TB
                      cloudRepositoryConsumedSpacePrice: 0
                      cloudRepositoryConsumedSpaceChunkSize: 1
                      cloudRepositoryConsumedSpaceUnits: TB
                      freeCloudRepositoryConsumedSpace: 
                      freeCloudRepositoryConsumedSpaceUnits: GB
                      backupDataTransferOutPrice: 0
                      backupDataTransferOutUnits: GB
                      insiderProtectionUsedSpacePrice: 0
                      insiderProtectionUsedSpaceUnits: TB
                      performanceTierUsedSpacePrice: 0
                      performanceTierUsedSpaceChunkSize: 1
                      performanceTierUsedSpaceUnits: TB
                      capacityTierUsedSpacePrice: 0
                      capacityTierUsedSpaceChunkSize: 1
                      capacityTierUsedSpaceUnits: TB
                      archiveTierUsedSpacePrice: 0
                      archiveTierUsedSpaceChunkSize: 1
                      archiveTierUsedSpaceUnits: TB
                    licenses:
                      vspcLicenses:
                        workstationPrice: 0
                        serverPrice: 0
                      backupAndReplicationStandardEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      backupAndReplicationEnterpriseEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      backupAndReplicationEnterprisePlusEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpFoundationPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpAdvancedPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpPremiumPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      cloudConnectLicenses:
                        vmBackupPrice: 0
                        vmReplicaPrice: 0
                        workstationBackupPrice: 0
                        serverBackupPrice: 0
                      vb365Licenses:
                        userPrice: 0
                      veeamOneLicenses:
                        monitoredObjectPrice: 0
                    externalPlugins: [ ]
                  - instanceUid: ac601d49-c7c0-4e3e-95dc-5ca17e6617f3
                    name: Pittsburgh subscription plan
                    organizationUid: 9e235def-0a77-4f71-baf8-288d6f485c19
                    type: Reseller
                    description: Subscription plan for Pittsburgh clients
                    currency: USD
                    taxType: VAT
                    taxPercent: 10
                    discountPercent: 12
                    managedBackup:
                      managedServicePrice: 21
                      monitoredServicePrice: 0
                      remoteManagedVmPrice: 0
                      remoteManagedCdpVmPrice: 0
                      remoteManagedWorkstationPrice: 0
                      remoteManagedServerAgentPrice: 0
                      remoteFreeManagedVms: 0
                      remoteFreeManagedCdpVms: 0
                      remoteFreeManagedWorkstations: 0
                      remoteFreeManagedServerAgents: 0
                      remoteWindowsServerOsPrice: 0
                      remoteWindowsClientOsPrice: 0
                      remoteLinuxOsPrice: 0
                      remoteMacOsPrice: 0
                      remoteBackupUsedSpacePrice: 0
                      remoteBackupUsedSpaceUnits: GB
                      remoteFreeBackupUsedSpace: 
                      remoteFreeBackupUsedSpaceUnits: GB
                      remoteRepositorySpaceUsageAlgorithm: Consumed
                      remoteRepositoryAllocatedSpacePrice: 0
                      remoteRepositoryAllocatedSpaceUnits: GB
                      remoteRoundUpBackupUsedSpace: false
                      remoteBackupUsedSpaceChunkSize: 1
                      hostedManagedVmPrice: 0
                      hostedManagedCdpVmPrice: 0
                      hostedManagedWorkstationPrice: 0
                      hostedManagedServerAgentPrice: 0
                      hostedFreeManagedVms: 0
                      hostedFreeManagedCdpVms: 0
                      hostedFreeManagedWorkstations: 0
                      hostedFreeManagedServerAgents: 0
                      hostedWindowsServerOsPrice: 0
                      hostedWindowsClientOsPrice: 0
                      hostedLinuxOsPrice: 0
                      hostedMacOsPrice: 0
                      hostedBackupUsedSpacePrice: 0
                      hostedBackupUsedSpaceUnits: GB
                      hostedFreeBackupUsedSpace: 
                      hostedFreeBackupUsedSpaceUnits: GB
                      hostedRepositorySpaceUsageAlgorithm: Consumed
                      hostedRepositoryAllocatedSpacePrice: 0
                      hostedRepositoryAllocatedSpaceUnits: GB
                      hostedRoundUpBackupUsedSpace: false
                      hostedBackupUsedSpaceChunkSize: 1
                    publicCloud:
                      remoteCloudVmPrice: 0
                      remoteFreeCloudVms: 0
                      remoteCloudFileSharePrice: 0
                      remoteFreeCloudFileShares: 0
                      remoteCloudDatabasePrice: 0
                      remoteFreeCloudDatabases: 0
                      remoteCloudNetworkPrice: 0
                      remoteBackupUsedSpacePrice: 0
                      remoteBackupUsedSpaceUnits: GB
                      remoteFreeBackupUsedSpace: 
                      remoteFreeBackupUsedSpaceUnits: GB
                      remoteArchiveUsedSpacePrice: 0
                      remoteArchiveUsedSpaceUnits: GB
                      remoteFreeArchiveUsedSpace: 
                      remoteFreeArchiveUsedSpaceUnits: GB
                      hostedCloudVmPrice: 0
                      hostedFreeCloudVms: 0
                      hostedCloudFileSharePrice: 0
                      hostedFreeCloudFileShares: 0
                      hostedCloudDatabasePrice: 0
                      hostedFreeCloudDatabases: 0
                      hostedCloudNetworkPrice: 0
                      hostedBackupUsedSpacePrice: 0
                      hostedBackupUsedSpaceUnits: GB
                      hostedFreeBackupUsedSpace: 
                      hostedFreeBackupUsedSpaceUnits: GB
                      hostedArchiveUsedSpacePrice: 0
                      hostedArchiveUsedSpaceUnits: GB
                      hostedFreeArchiveUsedSpace: 
                      hostedFreeArchiveUsedSpaceUnits: GB
                    vb365:
                      remoteSubscriptionUserPrice: 0
                      remoteFreeSubscriptionUsers: 0
                      remoteEducationalUserPrice: 0
                      remoteFreeEducationalUsers: 0
                      remoteRoundUpUsedSpace: false
                      remoteStandardStorageUsedSpacePrice: 0
                      remoteStandardStorageUsedSpaceChunkSize: 1
                      remoteStandardStorageUsedSpaceUnits: GB
                      remoteFreeStandardStorageUsedSpace: 
                      remoteFreeStandardStorageUsedSpaceUnits: GB
                      remoteArchiveStorageUsedSpacePrice: 0
                      remoteArchiveStorageUsedSpaceChunkSize: 1
                      remoteArchiveStorageUsedSpaceUnits: GB
                      remoteFreeArchiveStorageUsedSpace: 
                      remoteFreeArchiveStorageUsedSpaceUnits: GB
                      remoteRepositorySpaceUsageAlgorithm: Consumed
                      remoteRepositoryAllocatedSpacePrice: 0
                      remoteRepositoryAllocatedSpaceUnits: GB
                      hostedSubscriptionUserPrice: 0
                      hostedFreeSubscriptionUsers: 0
                      hostedEducationalUserPrice: 0
                      hostedFreeEducationalUsers: 0
                      hostedRoundUpUsedSpace: false
                      hostedStandardStorageUsedSpacePrice: 0
                      hostedStandardStorageUsedSpaceChunkSize: 1
                      hostedStandardStorageUsedSpaceUnits: GB
                      hostedFreeStandardStorageUsedSpace: 
                      hostedFreeStandardStorageUsedSpaceUnits: GB
                      hostedArchiveStorageUsedSpacePrice: 0
                      hostedArchiveStorageUsedSpaceChunkSize: 1
                      hostedArchiveStorageUsedSpaceUnits: GB
                      hostedFreeArchiveStorageUsedSpace: 
                      hostedFreeArchiveStorageUsedSpaceUnits: GB
                      hostedRepositorySpaceUsageAlgorithm: Consumed
                      hostedRepositoryAllocatedSpacePrice: 0
                      hostedRepositoryAllocatedSpaceUnits: GB
                    cloudReplication:
                      replicatedVmPrice: 10
                      cloudStorageConsumedSpacePrice: 10
                      cloudStorageConsumedSpaceUnits: TB
                      freeCloudStorageConsumedSpace: 
                      freeCloudStorageConsumedSpaceUnits: GB
                      computeResourcesPrice: 0
                      computeResourcesUnits: Hours
                      freeComputeResources: 1
                      freeComputeResourcesUnits: Hours
                      replicationDataTransferOutPrice: 0
                      replicationDataTransferOutUnits: GB
                    fileShareBackup:
                      fileShareRemoteBackupUsedSpacePrice: 0
                      fileShareRemoteBackupUsedSpaceUnits: GB
                      freeFileShareRemoteBackupUsedSpace: 
                      freeFileShareRemoteBackupUsedSpaceUnits: GB
                      fileShareRemoteArchiveUsedSpacePrice: 0
                      fileShareRemoteArchiveUsedSpaceUnits: GB
                      freeFileShareRemoteArchiveUsedSpace: 
                      freeFileShareRemoteArchiveUsedSpaceUnits: GB
                      sourceRemoteAmountOfDataPrice: 0
                      sourceRemoteAmountOfDataUnits: GB
                      freeSourceRemoteAmountOfData: 
                      freeSourceRemoteAmountOfDataUnits: GB
                      fileShareHostedBackupUsedSpacePrice: 0
                      fileShareHostedBackupUsedSpaceUnits: GB
                      freeFileShareHostedBackupUsedSpace: 
                      freeFileShareHostedBackupUsedSpaceUnits: GB
                      fileShareHostedArchiveUsedSpacePrice: 0
                      fileShareHostedArchiveUsedSpaceUnits: GB
                      freeFileShareHostedArchiveUsedSpace: 
                      freeFileShareHostedArchiveUsedSpaceUnits: GB
                      sourceHostedAmountOfDataPrice: 0
                      sourceHostedAmountOfDataUnits: GB
                      freeSourceHostedAmountOfData: 
                      freeSourceHostedAmountOfDataUnits: GB
                    cloudBackup:
                      roundUpUsedSpace: false
                      vmCloudBackupsPrice: 5
                      serverCloudBackupsPrice: 6
                      workstationCloudBackupsPrice: 7
                      cloudRepositorySpaceUsageAlgorithm: Consumed
                      cloudRepositoryAllocatedSpacePrice: 0
                      cloudRepositoryAllocatedSpaceUnits: GB
                      cloudRepositoryConsumedSpacePrice: 15
                      cloudRepositoryConsumedSpaceChunkSize: 1
                      cloudRepositoryConsumedSpaceUnits: TB
                      freeCloudRepositoryConsumedSpace: 
                      freeCloudRepositoryConsumedSpaceUnits: GB
                      backupDataTransferOutPrice: 8
                      backupDataTransferOutUnits: GB
                      insiderProtectionUsedSpacePrice: 0
                      insiderProtectionUsedSpaceUnits: GB
                      performanceTierUsedSpacePrice: 0
                      performanceTierUsedSpaceChunkSize: 1
                      performanceTierUsedSpaceUnits: GB
                      capacityTierUsedSpacePrice: 0
                      capacityTierUsedSpaceChunkSize: 1
                      capacityTierUsedSpaceUnits: GB
                      archiveTierUsedSpacePrice: 0
                      archiveTierUsedSpaceChunkSize: 1
                      archiveTierUsedSpaceUnits: GB
                    licenses:
                      vspcLicenses:
                        workstationPrice: 0
                        serverPrice: 0
                      backupAndReplicationStandardEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      backupAndReplicationEnterpriseEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      backupAndReplicationEnterprisePlusEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpFoundationPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpAdvancedPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpPremiumPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      cloudConnectLicenses:
                        vmBackupPrice: 0
                        vmReplicaPrice: 0
                        workstationBackupPrice: 0
                        serverBackupPrice: 0
                      vb365Licenses:
                        userPrice: 0
                      veeamOneLicenses:
                        monitoredObjectPrice: 0
                    externalPlugins: [ ]
                  - instanceUid: 05c7fa74-0818-42f1-a1e5-d214eaac09f2
                    name: Philadelphia subscription plan
                    organizationUid: 9d3fbd57-b7cc-49c8-82a3-14a058594baf
                    type: Provider
                    description: Subscription plan for premium clients
                    currency: USD
                    taxType: VAT
                    taxPercent: 9
                    discountPercent: 10
                    managedBackup:
                      managedServicePrice: 20
                      monitoredServicePrice: 0
                      remoteManagedVmPrice: 0
                      remoteManagedCdpVmPrice: 0
                      remoteManagedWorkstationPrice: 0
                      remoteManagedServerAgentPrice: 0
                      remoteFreeManagedVms: 0
                      remoteFreeManagedCdpVms: 0
                      remoteFreeManagedWorkstations: 0
                      remoteFreeManagedServerAgents: 0
                      remoteWindowsServerOsPrice: 0
                      remoteWindowsClientOsPrice: 0
                      remoteLinuxOsPrice: 0
                      remoteMacOsPrice: 0
                      remoteBackupUsedSpacePrice: 0
                      remoteBackupUsedSpaceUnits: GB
                      remoteFreeBackupUsedSpace: 
                      remoteFreeBackupUsedSpaceUnits: GB
                      remoteRepositorySpaceUsageAlgorithm: Consumed
                      remoteRepositoryAllocatedSpacePrice: 0
                      remoteRepositoryAllocatedSpaceUnits: GB
                      remoteRoundUpBackupUsedSpace: false
                      remoteBackupUsedSpaceChunkSize: 1
                      hostedManagedVmPrice: 0
                      hostedManagedCdpVmPrice: 0
                      hostedManagedWorkstationPrice: 0
                      hostedManagedServerAgentPrice: 0
                      hostedFreeManagedVms: 0
                      hostedFreeManagedCdpVms: 0
                      hostedFreeManagedWorkstations: 0
                      hostedFreeManagedServerAgents: 0
                      hostedWindowsServerOsPrice: 0
                      hostedWindowsClientOsPrice: 0
                      hostedLinuxOsPrice: 0
                      hostedMacOsPrice: 0
                      hostedBackupUsedSpacePrice: 0
                      hostedBackupUsedSpaceUnits: GB
                      hostedFreeBackupUsedSpace: 
                      hostedFreeBackupUsedSpaceUnits: GB
                      hostedRepositorySpaceUsageAlgorithm: Consumed
                      hostedRepositoryAllocatedSpacePrice: 0
                      hostedRepositoryAllocatedSpaceUnits: GB
                      hostedRoundUpBackupUsedSpace: false
                      hostedBackupUsedSpaceChunkSize: 1
                    publicCloud:
                      remoteCloudVmPrice: 0
                      remoteFreeCloudVms: 0
                      remoteCloudFileSharePrice: 0
                      remoteFreeCloudFileShares: 0
                      remoteCloudDatabasePrice: 0
                      remoteFreeCloudDatabases: 0
                      remoteCloudNetworkPrice: 0
                      remoteBackupUsedSpacePrice: 0
                      remoteBackupUsedSpaceUnits: GB
                      remoteFreeBackupUsedSpace: 
                      remoteFreeBackupUsedSpaceUnits: GB
                      remoteArchiveUsedSpacePrice: 0
                      remoteArchiveUsedSpaceUnits: GB
                      remoteFreeArchiveUsedSpace: 
                      remoteFreeArchiveUsedSpaceUnits: GB
                      hostedCloudVmPrice: 0
                      hostedFreeCloudVms: 0
                      hostedCloudFileSharePrice: 0
                      hostedFreeCloudFileShares: 0
                      hostedCloudDatabasePrice: 0
                      hostedFreeCloudDatabases: 0
                      hostedCloudNetworkPrice: 0
                      hostedBackupUsedSpacePrice: 0
                      hostedBackupUsedSpaceUnits: GB
                      hostedFreeBackupUsedSpace: 
                      hostedFreeBackupUsedSpaceUnits: GB
                      hostedArchiveUsedSpacePrice: 0
                      hostedArchiveUsedSpaceUnits: GB
                      hostedFreeArchiveUsedSpace: 
                      hostedFreeArchiveUsedSpaceUnits: GB
                    vb365:
                      remoteSubscriptionUserPrice: 0
                      remoteFreeSubscriptionUsers: 0
                      remoteEducationalUserPrice: 0
                      remoteFreeEducationalUsers: 0
                      remoteRoundUpUsedSpace: false
                      remoteStandardStorageUsedSpacePrice: 0
                      remoteStandardStorageUsedSpaceChunkSize: 1
                      remoteStandardStorageUsedSpaceUnits: GB
                      remoteFreeStandardStorageUsedSpace: 
                      remoteFreeStandardStorageUsedSpaceUnits: GB
                      remoteArchiveStorageUsedSpacePrice: 0
                      remoteArchiveStorageUsedSpaceChunkSize: 1
                      remoteArchiveStorageUsedSpaceUnits: GB
                      remoteFreeArchiveStorageUsedSpace: 
                      remoteFreeArchiveStorageUsedSpaceUnits: GB
                      remoteRepositorySpaceUsageAlgorithm: Consumed
                      remoteRepositoryAllocatedSpacePrice: 0
                      remoteRepositoryAllocatedSpaceUnits: GB
                      hostedSubscriptionUserPrice: 0
                      hostedFreeSubscriptionUsers: 0
                      hostedEducationalUserPrice: 0
                      hostedFreeEducationalUsers: 0
                      hostedRoundUpUsedSpace: false
                      hostedStandardStorageUsedSpacePrice: 0
                      hostedStandardStorageUsedSpaceChunkSize: 1
                      hostedStandardStorageUsedSpaceUnits: GB
                      hostedFreeStandardStorageUsedSpace: 
                      hostedFreeStandardStorageUsedSpaceUnits: GB
                      hostedArchiveStorageUsedSpacePrice: 0
                      hostedArchiveStorageUsedSpaceChunkSize: 1
                      hostedArchiveStorageUsedSpaceUnits: GB
                      hostedFreeArchiveStorageUsedSpace: 
                      hostedFreeArchiveStorageUsedSpaceUnits: GB
                      hostedRepositorySpaceUsageAlgorithm: Consumed
                      hostedRepositoryAllocatedSpacePrice: 0
                      hostedRepositoryAllocatedSpaceUnits: GB
                    cloudReplication:
                      replicatedVmPrice: 10
                      cloudStorageConsumedSpacePrice: 9
                      cloudStorageConsumedSpaceUnits: TB
                      freeCloudStorageConsumedSpace: 
                      freeCloudStorageConsumedSpaceUnits: GB
                      computeResourcesPrice: 0
                      computeResourcesUnits: Hours
                      freeComputeResources: 1
                      freeComputeResourcesUnits: Days
                      replicationDataTransferOutPrice: 0
                      replicationDataTransferOutUnits: GB
                    fileShareBackup:
                      fileShareRemoteBackupUsedSpacePrice: 0
                      fileShareRemoteBackupUsedSpaceUnits: GB
                      freeFileShareRemoteBackupUsedSpace: 
                      freeFileShareRemoteBackupUsedSpaceUnits: GB
                      fileShareRemoteArchiveUsedSpacePrice: 0
                      fileShareRemoteArchiveUsedSpaceUnits: GB
                      freeFileShareRemoteArchiveUsedSpace: 
                      freeFileShareRemoteArchiveUsedSpaceUnits: GB
                      sourceRemoteAmountOfDataPrice: 0
                      sourceRemoteAmountOfDataUnits: GB
                      freeSourceRemoteAmountOfData: 
                      freeSourceRemoteAmountOfDataUnits: GB
                      fileShareHostedBackupUsedSpacePrice: 0
                      fileShareHostedBackupUsedSpaceUnits: GB
                      freeFileShareHostedBackupUsedSpace: 
                      freeFileShareHostedBackupUsedSpaceUnits: GB
                      fileShareHostedArchiveUsedSpacePrice: 0
                      fileShareHostedArchiveUsedSpaceUnits: GB
                      freeFileShareHostedArchiveUsedSpace: 
                      freeFileShareHostedArchiveUsedSpaceUnits: GB
                      sourceHostedAmountOfDataPrice: 0
                      sourceHostedAmountOfDataUnits: GB
                      freeSourceHostedAmountOfData: 
                      freeSourceHostedAmountOfDataUnits: GB
                    cloudBackup:
                      roundUpUsedSpace: false
                      vmCloudBackupsPrice: 5
                      serverCloudBackupsPrice: 6
                      workstationCloudBackupsPrice: 7
                      cloudRepositorySpaceUsageAlgorithm: Consumed
                      cloudRepositoryAllocatedSpacePrice: 11
                      cloudRepositoryAllocatedSpaceUnits: TB
                      cloudRepositoryConsumedSpacePrice: 15
                      cloudRepositoryConsumedSpaceChunkSize: 1
                      cloudRepositoryConsumedSpaceUnits: TB
                      freeCloudRepositoryConsumedSpace: 
                      freeCloudRepositoryConsumedSpaceUnits: GB
                      backupDataTransferOutPrice: 8
                      backupDataTransferOutUnits: GB
                      insiderProtectionUsedSpacePrice: 0
                      insiderProtectionUsedSpaceUnits: GB
                      performanceTierUsedSpacePrice: 0
                      performanceTierUsedSpaceChunkSize: 1
                      performanceTierUsedSpaceUnits: GB
                      capacityTierUsedSpacePrice: 0
                      capacityTierUsedSpaceChunkSize: 1
                      capacityTierUsedSpaceUnits: GB
                      archiveTierUsedSpacePrice: 0
                      archiveTierUsedSpaceChunkSize: 1
                      archiveTierUsedSpaceUnits: GB
                    licenses:
                      vspcLicenses:
                        workstationPrice: 0
                        serverPrice: 0
                      backupAndReplicationStandardEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      backupAndReplicationEnterpriseEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      backupAndReplicationEnterprisePlusEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpFoundationPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpAdvancedPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpPremiumPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      cloudConnectLicenses:
                        vmBackupPrice: 0
                        vmReplicaPrice: 0
                        workstationBackupPrice: 0
                        serverBackupPrice: 0
                      vb365Licenses:
                        userPrice: 0
                      veeamOneLicenses:
                        monitoredObjectPrice: 0
                    externalPlugins: [ ]
                  - instanceUid: 59214e62-c216-45f7-b693-23190b7b0193
                    name: Rlab2_SP_SubscriptionPlan
                    organizationUid: 20a6dd08-8876-47a4-9acf-61d684b771e9
                    type: Provider
                    description: 
                    currency: USD
                    taxType: VAT
                    taxPercent: 10
                    discountPercent: 5
                    managedBackup:
                      managedServicePrice: 0
                      monitoredServicePrice: 0
                      remoteManagedVmPrice: 0
                      remoteManagedCdpVmPrice: 0
                      remoteManagedWorkstationPrice: 0
                      remoteManagedServerAgentPrice: 0
                      remoteFreeManagedVms: 0
                      remoteFreeManagedCdpVms: 0
                      remoteFreeManagedWorkstations: 0
                      remoteFreeManagedServerAgents: 0
                      remoteWindowsServerOsPrice: 0
                      remoteWindowsClientOsPrice: 0
                      remoteLinuxOsPrice: 0
                      remoteMacOsPrice: 0
                      remoteBackupUsedSpacePrice: 0
                      remoteBackupUsedSpaceUnits: GB
                      remoteFreeBackupUsedSpace: 
                      remoteFreeBackupUsedSpaceUnits: GB
                      remoteRepositorySpaceUsageAlgorithm: Consumed
                      remoteRepositoryAllocatedSpacePrice: 0
                      remoteRepositoryAllocatedSpaceUnits: GB
                      remoteRoundUpBackupUsedSpace: false
                      remoteBackupUsedSpaceChunkSize: 1
                      hostedManagedVmPrice: 0
                      hostedManagedCdpVmPrice: 0
                      hostedManagedWorkstationPrice: 0
                      hostedManagedServerAgentPrice: 0
                      hostedFreeManagedVms: 0
                      hostedFreeManagedCdpVms: 0
                      hostedFreeManagedWorkstations: 0
                      hostedFreeManagedServerAgents: 0
                      hostedWindowsServerOsPrice: 0
                      hostedWindowsClientOsPrice: 0
                      hostedLinuxOsPrice: 0
                      hostedMacOsPrice: 0
                      hostedBackupUsedSpacePrice: 0
                      hostedBackupUsedSpaceUnits: GB
                      hostedFreeBackupUsedSpace: 
                      hostedFreeBackupUsedSpaceUnits: GB
                      hostedRepositorySpaceUsageAlgorithm: Consumed
                      hostedRepositoryAllocatedSpacePrice: 0
                      hostedRepositoryAllocatedSpaceUnits: GB
                      hostedRoundUpBackupUsedSpace: false
                      hostedBackupUsedSpaceChunkSize: 1
                    publicCloud:
                      remoteCloudVmPrice: 0
                      remoteFreeCloudVms: 0
                      remoteCloudFileSharePrice: 0
                      remoteFreeCloudFileShares: 0
                      remoteCloudDatabasePrice: 0
                      remoteFreeCloudDatabases: 0
                      remoteCloudNetworkPrice: 0
                      remoteBackupUsedSpacePrice: 0
                      remoteBackupUsedSpaceUnits: GB
                      remoteFreeBackupUsedSpace: 
                      remoteFreeBackupUsedSpaceUnits: GB
                      remoteArchiveUsedSpacePrice: 0
                      remoteArchiveUsedSpaceUnits: GB
                      remoteFreeArchiveUsedSpace: 
                      remoteFreeArchiveUsedSpaceUnits: GB
                      hostedCloudVmPrice: 0
                      hostedFreeCloudVms: 0
                      hostedCloudFileSharePrice: 0
                      hostedFreeCloudFileShares: 0
                      hostedCloudDatabasePrice: 0
                      hostedFreeCloudDatabases: 0
                      hostedCloudNetworkPrice: 0
                      hostedBackupUsedSpacePrice: 0
                      hostedBackupUsedSpaceUnits: GB
                      hostedFreeBackupUsedSpace: 
                      hostedFreeBackupUsedSpaceUnits: GB
                      hostedArchiveUsedSpacePrice: 0
                      hostedArchiveUsedSpaceUnits: GB
                      hostedFreeArchiveUsedSpace: 
                      hostedFreeArchiveUsedSpaceUnits: GB
                    vb365:
                      remoteSubscriptionUserPrice: 0
                      remoteFreeSubscriptionUsers: 0
                      remoteEducationalUserPrice: 0
                      remoteFreeEducationalUsers: 0
                      remoteRoundUpUsedSpace: false
                      remoteStandardStorageUsedSpacePrice: 0
                      remoteStandardStorageUsedSpaceChunkSize: 1
                      remoteStandardStorageUsedSpaceUnits: GB
                      remoteFreeStandardStorageUsedSpace: 
                      remoteFreeStandardStorageUsedSpaceUnits: GB
                      remoteArchiveStorageUsedSpacePrice: 0
                      remoteArchiveStorageUsedSpaceChunkSize: 1
                      remoteArchiveStorageUsedSpaceUnits: GB
                      remoteFreeArchiveStorageUsedSpace: 
                      remoteFreeArchiveStorageUsedSpaceUnits: GB
                      remoteRepositorySpaceUsageAlgorithm: Consumed
                      remoteRepositoryAllocatedSpacePrice: 0
                      remoteRepositoryAllocatedSpaceUnits: GB
                      hostedSubscriptionUserPrice: 0
                      hostedFreeSubscriptionUsers: 0
                      hostedEducationalUserPrice: 0
                      hostedFreeEducationalUsers: 0
                      hostedRoundUpUsedSpace: false
                      hostedStandardStorageUsedSpacePrice: 0
                      hostedStandardStorageUsedSpaceChunkSize: 1
                      hostedStandardStorageUsedSpaceUnits: GB
                      hostedFreeStandardStorageUsedSpace: 
                      hostedFreeStandardStorageUsedSpaceUnits: GB
                      hostedArchiveStorageUsedSpacePrice: 0
                      hostedArchiveStorageUsedSpaceChunkSize: 1
                      hostedArchiveStorageUsedSpaceUnits: GB
                      hostedFreeArchiveStorageUsedSpace: 
                      hostedFreeArchiveStorageUsedSpaceUnits: GB
                      hostedRepositorySpaceUsageAlgorithm: Consumed
                      hostedRepositoryAllocatedSpacePrice: 0
                      hostedRepositoryAllocatedSpaceUnits: GB
                    cloudReplication:
                      replicatedVmPrice: 0
                      cloudStorageConsumedSpacePrice: 0
                      cloudStorageConsumedSpaceUnits: TB
                      freeCloudStorageConsumedSpace: 
                      freeCloudStorageConsumedSpaceUnits: GB
                      computeResourcesPrice: 0
                      computeResourcesUnits: Hours
                      freeComputeResources: 0
                      freeComputeResourcesUnits: Minutes
                      replicationDataTransferOutPrice: 0
                      replicationDataTransferOutUnits: GB
                    fileShareBackup:
                      fileShareRemoteBackupUsedSpacePrice: 0
                      fileShareRemoteBackupUsedSpaceUnits: GB
                      freeFileShareRemoteBackupUsedSpace: 
                      freeFileShareRemoteBackupUsedSpaceUnits: GB
                      fileShareRemoteArchiveUsedSpacePrice: 0
                      fileShareRemoteArchiveUsedSpaceUnits: GB
                      freeFileShareRemoteArchiveUsedSpace: 
                      freeFileShareRemoteArchiveUsedSpaceUnits: GB
                      sourceRemoteAmountOfDataPrice: 0
                      sourceRemoteAmountOfDataUnits: GB
                      freeSourceRemoteAmountOfData: 
                      freeSourceRemoteAmountOfDataUnits: GB
                      fileShareHostedBackupUsedSpacePrice: 0
                      fileShareHostedBackupUsedSpaceUnits: GB
                      freeFileShareHostedBackupUsedSpace: 
                      freeFileShareHostedBackupUsedSpaceUnits: GB
                      fileShareHostedArchiveUsedSpacePrice: 0
                      fileShareHostedArchiveUsedSpaceUnits: GB
                      freeFileShareHostedArchiveUsedSpace: 
                      freeFileShareHostedArchiveUsedSpaceUnits: GB
                      sourceHostedAmountOfDataPrice: 0
                      sourceHostedAmountOfDataUnits: GB
                      freeSourceHostedAmountOfData: 
                      freeSourceHostedAmountOfDataUnits: GB
                    cloudBackup:
                      roundUpUsedSpace: false
                      vmCloudBackupsPrice: 0
                      serverCloudBackupsPrice: 0
                      workstationCloudBackupsPrice: 0
                      cloudRepositorySpaceUsageAlgorithm: Consumed
                      cloudRepositoryAllocatedSpacePrice: 0
                      cloudRepositoryAllocatedSpaceUnits: GB
                      cloudRepositoryConsumedSpacePrice: 0
                      cloudRepositoryConsumedSpaceChunkSize: 1
                      cloudRepositoryConsumedSpaceUnits: TB
                      freeCloudRepositoryConsumedSpace: 
                      freeCloudRepositoryConsumedSpaceUnits: GB
                      backupDataTransferOutPrice: 0
                      backupDataTransferOutUnits: GB
                      insiderProtectionUsedSpacePrice: 0
                      insiderProtectionUsedSpaceUnits: GB
                      performanceTierUsedSpacePrice: 0
                      performanceTierUsedSpaceChunkSize: 1
                      performanceTierUsedSpaceUnits: GB
                      capacityTierUsedSpacePrice: 0
                      capacityTierUsedSpaceChunkSize: 1
                      capacityTierUsedSpaceUnits: GB
                      archiveTierUsedSpacePrice: 0
                      archiveTierUsedSpaceChunkSize: 1
                      archiveTierUsedSpaceUnits: GB
                    licenses:
                      vspcLicenses:
                        workstationPrice: 0
                        serverPrice: 0
                      backupAndReplicationStandardEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      backupAndReplicationEnterpriseEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      backupAndReplicationEnterprisePlusEditionLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpFoundationPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpAdvancedPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      vdpPremiumPackageLicenses:
                        vmPrice: 0
                        workstationPrice: 0
                        serverPrice: 0
                        applicationPrice: 0
                        microsoftEntraIdPrice: 0
                        fileSharePrice: 0
                        objectStoragePrice: 0
                        cloudVmPrice: 0
                        cloudFileSharePrice: 0
                        cloudDatabasePrice: 0
                      cloudConnectLicenses:
                        vmBackupPrice: 0
                        vmReplicaPrice: 0
                        workstationBackupPrice: 0
                        serverBackupPrice: 0
                      vb365Licenses:
                        userPrice: 0
                      veeamOneLicenses:
                        monitoredObjectPrice: 0
                    externalPlugins: [ ]
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyInvoiceAuditor
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
    post:
      tags:
        - Subscription Plans
      summary: Create Subscription Plan
      description: Creates a subscription plan.
      operationId: CreateSubscriptionPlan
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Subscription plan model.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SubscriptionPlan'
            example:
              name: Pittsburgh subscription plan
              description: Subscription plan for Pittsburgh clients
              currency: USD
              taxType: VAT
              taxPercent: 10
              discountPercent: 12
              managedBackup:
                managedServicePrice: 21
                monitoredServicePrice: 0
                remoteManagedVmPrice: 0
                remoteManagedCdpVmPrice: 0
                remoteManagedWorkstationPrice: 0
                remoteManagedServerAgentPrice: 0
                remoteFreeManagedVms: 0
                remoteFreeManagedCdpVms: 0
                remoteFreeManagedWorkstations: 0
                remoteFreeManagedServerAgents: 0
                remoteWindowsServerOsPrice: 0
                remoteWindowsClientOsPrice: 0
                remoteLinuxOsPrice: 0
                remoteMacOsPrice: 0
                remoteBackupUsedSpacePrice: 0
                remoteBackupUsedSpaceUnits: GB
                remoteFreeBackupUsedSpace: 
                remoteFreeBackupUsedSpaceUnits: GB
                remoteRepositorySpaceUsageAlgorithm: Consumed
                remoteRepositoryAllocatedSpacePrice: 0
                remoteRepositoryAllocatedSpaceUnits: GB
                remoteRoundUpBackupUsedSpace: false
                remoteBackupUsedSpaceChunkSize: 1
                hostedManagedVmPrice: 0
                hostedManagedCdpVmPrice: 0
                hostedManagedWorkstationPrice: 0
                hostedManagedServerAgentPrice: 0
                hostedFreeManagedVms: 0
                hostedFreeManagedCdpVms: 0
                hostedFreeManagedWorkstations: 0
                hostedFreeManagedServerAgents: 0
                hostedWindowsServerOsPrice: 0
                hostedWindowsClientOsPrice: 0
                hostedLinuxOsPrice: 0
                hostedMacOsPrice: 0
                hostedBackupUsedSpacePrice: 0
                hostedBackupUsedSpaceUnits: GB
                hostedFreeBackupUsedSpace: 
                hostedFreeBackupUsedSpaceUnits: GB
                hostedRepositorySpaceUsageAlgorithm: Consumed
                hostedRepositoryAllocatedSpacePrice: 0
                hostedRepositoryAllocatedSpaceUnits: GB
                hostedRoundUpBackupUsedSpace: false
                hostedBackupUsedSpaceChunkSize: 1
              publicCloud:
                remoteCloudVmPrice: 0
                remoteFreeCloudVms: 0
                remoteCloudFileSharePrice: 0
                remoteFreeCloudFileShares: 0
                remoteCloudDatabasePrice: 0
                remoteFreeCloudDatabases: 0
                remoteCloudNetworkPrice: 0
                remoteBackupUsedSpacePrice: 0
                remoteBackupUsedSpaceUnits: GB
                remoteFreeBackupUsedSpace: 
                remoteFreeBackupUsedSpaceUnits: GB
                remoteArchiveUsedSpacePrice: 0
                remoteArchiveUsedSpaceUnits: GB
                remoteFreeArchiveUsedSpace: 
                remoteFreeArchiveUsedSpaceUnits: GB
                hostedCloudVmPrice: 0
                hostedFreeCloudVms: 0
                hostedCloudFileSharePrice: 0
                hostedFreeCloudFileShares: 0
                hostedCloudDatabasePrice: 0
                hostedFreeCloudDatabases: 0
                hostedCloudNetworkPrice: 0
                hostedBackupUsedSpacePrice: 0
                hostedBackupUsedSpaceUnits: GB
                hostedFreeBackupUsedSpace: 
                hostedFreeBackupUsedSpaceUnits: GB
                hostedArchiveUsedSpacePrice: 0
                hostedArchiveUsedSpaceUnits: GB
                hostedFreeArchiveUsedSpace: 
                hostedFreeArchiveUsedSpaceUnits: GB
              vb365:
                remoteSubscriptionUserPrice: 0
                remoteFreeSubscriptionUsers: 0
                remoteEducationalUserPrice: 0
                remoteFreeEducationalUsers: 0
                remoteRoundUpUsedSpace: false
                remoteStandardStorageUsedSpacePrice: 0
                remoteStandardStorageUsedSpaceChunkSize: 1
                remoteStandardStorageUsedSpaceUnits: GB
                remoteFreeStandardStorageUsedSpace: 
                remoteFreeStandardStorageUsedSpaceUnits: GB
                remoteArchiveStorageUsedSpacePrice: 0
                remoteArchiveStorageUsedSpaceChunkSize: 1
                remoteArchiveStorageUsedSpaceUnits: GB
                remoteFreeArchiveStorageUsedSpace: 
                remoteFreeArchiveStorageUsedSpaceUnits: GB
                remoteRepositorySpaceUsageAlgorithm: Consumed
                remoteRepositoryAllocatedSpacePrice: 0
                remoteRepositoryAllocatedSpaceUnits: GB
                hostedSubscriptionUserPrice: 0
                hostedFreeSubscriptionUsers: 0
                hostedEducationalUserPrice: 0
                hostedFreeEducationalUsers: 0
                hostedRoundUpUsedSpace: false
                hostedStandardStorageUsedSpacePrice: 0
                hostedStandardStorageUsedSpaceChunkSize: 1
                hostedStandardStorageUsedSpaceUnits: GB
                hostedFreeStandardStorageUsedSpace: 
                hostedFreeStandardStorageUsedSpaceUnits: GB
                hostedArchiveStorageUsedSpacePrice: 0
                hostedArchiveStorageUsedSpaceChunkSize: 1
                hostedArchiveStorageUsedSpaceUnits: GB
                hostedFreeArchiveStorageUsedSpace: 
                hostedFreeArchiveStorageUsedSpaceUnits: GB
                hostedRepositorySpaceUsageAlgorithm: Consumed
                hostedRepositoryAllocatedSpacePrice: 0
                hostedRepositoryAllocatedSpaceUnits: GB
              cloudReplication:
                replicatedVmPrice: 10
                cloudStorageConsumedSpacePrice: 10
                cloudStorageConsumedSpaceUnits: TB
                freeCloudStorageConsumedSpace: 
                freeCloudStorageConsumedSpaceUnits: GB
                computeResourcesPrice: 0
                computeResourcesUnits: Hours
                freeComputeResources: 1
                freeComputeResourcesUnits: Hours
                replicationDataTransferOutPrice: 0
                replicationDataTransferOutUnits: GB
              fileShareBackup:
                fileShareRemoteBackupUsedSpacePrice: 0
                fileShareRemoteBackupUsedSpaceUnits: GB
                freeFileShareRemoteBackupUsedSpace: 
                freeFileShareRemoteBackupUsedSpaceUnits: GB
                fileShareRemoteArchiveUsedSpacePrice: 0
                fileShareRemoteArchiveUsedSpaceUnits: GB
                freeFileShareRemoteArchiveUsedSpace: 
                freeFileShareRemoteArchiveUsedSpaceUnits: GB
                sourceRemoteAmountOfDataPrice: 0
                sourceRemoteAmountOfDataUnits: GB
                freeSourceRemoteAmountOfData: 
                freeSourceRemoteAmountOfDataUnits: GB
                fileShareHostedBackupUsedSpacePrice: 0
                fileShareHostedBackupUsedSpaceUnits: GB
                freeFileShareHostedBackupUsedSpace: 
                freeFileShareHostedBackupUsedSpaceUnits: GB
                fileShareHostedArchiveUsedSpacePrice: 0
                fileShareHostedArchiveUsedSpaceUnits: GB
                freeFileShareHostedArchiveUsedSpace: 
                freeFileShareHostedArchiveUsedSpaceUnits: GB
                sourceHostedAmountOfDataPrice: 0
                sourceHostedAmountOfDataUnits: GB
                freeSourceHostedAmountOfData: 
                freeSourceHostedAmountOfDataUnits: GB
              cloudBackup:
                roundUpUsedSpace: false
                vmCloudBackupsPrice: 5
                serverCloudBackupsPrice: 6
                workstationCloudBackupsPrice: 7
                cloudRepositorySpaceUsageAlgorithm: Consumed
                cloudRepositoryAllocatedSpacePrice: 0
                cloudRepositoryAllocatedSpaceUnits: GB
                cloudRepositoryConsumedSpacePrice: 15
                cloudRepositoryConsumedSpaceChunkSize: 1
                cloudRepositoryConsumedSpaceUnits: TB
                freeCloudRepositoryConsumedSpace: 
                freeCloudRepositoryConsumedSpaceUnits: GB
                backupDataTransferOutPrice: 8
                backupDataTransferOutUnits: GB
                insiderProtectionUsedSpacePrice: 0
                insiderProtectionUsedSpaceUnits: GB
                performanceTierUsedSpacePrice: 0
                performanceTierUsedSpaceChunkSize: 1
                performanceTierUsedSpaceUnits: GB
                capacityTierUsedSpacePrice: 0
                capacityTierUsedSpaceChunkSize: 1
                capacityTierUsedSpaceUnits: GB
                archiveTierUsedSpacePrice: 0
                archiveTierUsedSpaceChunkSize: 1
                archiveTierUsedSpaceUnits: GB
              licenses:
                vspcLicenses:
                  workstationPrice: 0
                  serverPrice: 0
                backupAndReplicationStandardEditionLicenses:
                  vmPrice: 0
                  workstationPrice: 0
                  serverPrice: 0
                  applicationPrice: 0
                  microsoftEntraIdPrice: 0
                  fileSharePrice: 0
                  objectStoragePrice: 0
                  cloudVmPrice: 0
                  cloudFileSharePrice: 0
                  cloudDatabasePrice: 0
                backupAndReplicationEnterpriseEditionLicenses:
                  vmPrice: 0
                  workstationPrice: 0
                  serverPrice: 0
                  applicationPrice: 0
                  microsoftEntraIdPrice: 0
                  fileSharePrice: 0
                  objectStoragePrice: 0
                  cloudVmPrice: 0
                  cloudFileSharePrice: 0
                  cloudDatabasePrice: 0
                backupAndReplicationEnterprisePlusEditionLicenses:
                  vmPrice: 0
                  workstationPrice: 0
                  serverPrice: 0
                  applicationPrice: 0
                  microsoftEntraIdPrice: 0
                  fileSharePrice: 0
                  objectStoragePrice: 0
                  cloudVmPrice: 0
                  cloudFileSharePrice: 0
                  cloudDatabasePrice: 0
                vdpFoundationPackageLicenses:
                  vmPrice: 0
                  workstationPrice: 0
                  serverPrice: 0
                  applicationPrice: 0
                  microsoftEntraIdPrice: 0
                  fileSharePrice: 0
                  objectStoragePrice: 0
                  cloudVmPrice: 0
                  cloudFileSharePrice: 0
                  cloudDatabasePrice: 0
                vdpAdvancedPackageLicenses:
                  vmPrice: 0
                  workstationPrice: 0
                  serverPrice: 0
                  applicationPrice: 0
                  microsoftEntraIdPrice: 0
                  fileSharePrice: 0
                  objectStoragePrice: 0
                  cloudVmPrice: 0
                  cloudFileSharePrice: 0
                  cloudDatabasePrice: 0
                vdpPremiumPackageLicenses:
                  vmPrice: 0
                  workstationPrice: 0
                  serverPrice: 0
                  applicationPrice: 0
                  microsoftEntraIdPrice: 0
                  fileSharePrice: 0
                  objectStoragePrice: 0
                  cloudVmPrice: 0
                  cloudFileSharePrice: 0
                  cloudDatabasePrice: 0
                cloudConnectLicenses:
                  vmBackupPrice: 0
                  vmReplicaPrice: 0
                  workstationBackupPrice: 0
                  serverBackupPrice: 0
                vb365Licenses:
                  userPrice: 0
                veeamOneLicenses:
                  monitoredObjectPrice: 0
              externalPlugins: [ ]
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SubscriptionPlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: a9e59625-d54a-41a1-94ee-005abf6f9d55
                  name: Pittsburgh subscription plan
                  organizationUid: 4b8274fc-f0ff-42ed-a541-a5fd9b48d0a6
                  type: Reseller
                  description: Subscription plan for Pittsburgh clients
                  currency: USD
                  taxType: VAT
                  taxPercent: 10
                  discountPercent: 12
                  managedBackup:
                    managedServicePrice: 21
                    monitoredServicePrice: 0
                    remoteManagedVmPrice: 0
                    remoteManagedCdpVmPrice: 0
                    remoteManagedWorkstationPrice: 0
                    remoteManagedServerAgentPrice: 0
                    remoteFreeManagedVms: 0
                    remoteFreeManagedCdpVms: 0
                    remoteFreeManagedWorkstations: 0
                    remoteFreeManagedServerAgents: 0
                    remoteWindowsServerOsPrice: 0
                    remoteWindowsClientOsPrice: 0
                    remoteLinuxOsPrice: 0
                    remoteMacOsPrice: 0
                    remoteBackupUsedSpacePrice: 0
                    remoteBackupUsedSpaceUnits: GB
                    remoteFreeBackupUsedSpace: 
                    remoteFreeBackupUsedSpaceUnits: GB
                    remoteRepositorySpaceUsageAlgorithm: Consumed
                    remoteRepositoryAllocatedSpacePrice: 0
                    remoteRepositoryAllocatedSpaceUnits: GB
                    remoteRoundUpBackupUsedSpace: false
                    remoteBackupUsedSpaceChunkSize: 1
                    hostedManagedVmPrice: 0
                    hostedManagedCdpVmPrice: 0
                    hostedManagedWorkstationPrice: 0
                    hostedManagedServerAgentPrice: 0
                    hostedFreeManagedVms: 0
                    hostedFreeManagedCdpVms: 0
                    hostedFreeManagedWorkstations: 0
                    hostedFreeManagedServerAgents: 0
                    hostedWindowsServerOsPrice: 0
                    hostedWindowsClientOsPrice: 0
                    hostedLinuxOsPrice: 0
                    hostedMacOsPrice: 0
                    hostedBackupUsedSpacePrice: 0
                    hostedBackupUsedSpaceUnits: GB
                    hostedFreeBackupUsedSpace: 
                    hostedFreeBackupUsedSpaceUnits: GB
                    hostedRepositorySpaceUsageAlgorithm: Consumed
                    hostedRepositoryAllocatedSpacePrice: 0
                    hostedRepositoryAllocatedSpaceUnits: GB
                    hostedRoundUpBackupUsedSpace: false
                    hostedBackupUsedSpaceChunkSize: 1
                  publicCloud:
                    remoteCloudVmPrice: 0
                    remoteFreeCloudVms: 0
                    remoteCloudFileSharePrice: 0
                    remoteFreeCloudFileShares: 0
                    remoteCloudDatabasePrice: 0
                    remoteFreeCloudDatabases: 0
                    remoteCloudNetworkPrice: 0
                    remoteBackupUsedSpacePrice: 0
                    remoteBackupUsedSpaceUnits: GB
                    remoteFreeBackupUsedSpace: 
                    remoteFreeBackupUsedSpaceUnits: GB
                    remoteArchiveUsedSpacePrice: 0
                    remoteArchiveUsedSpaceUnits: GB
                    remoteFreeArchiveUsedSpace: 
                    remoteFreeArchiveUsedSpaceUnits: GB
                    hostedCloudVmPrice: 0
                    hostedFreeCloudVms: 0
                    hostedCloudFileSharePrice: 0
                    hostedFreeCloudFileShares: 0
                    hostedCloudDatabasePrice: 0
                    hostedFreeCloudDatabases: 0
                    hostedCloudNetworkPrice: 0
                    hostedBackupUsedSpacePrice: 0
                    hostedBackupUsedSpaceUnits: GB
                    hostedFreeBackupUsedSpace: 
                    hostedFreeBackupUsedSpaceUnits: GB
                    hostedArchiveUsedSpacePrice: 0
                    hostedArchiveUsedSpaceUnits: GB
                    hostedFreeArchiveUsedSpace: 
                    hostedFreeArchiveUsedSpaceUnits: GB
                  vb365:
                    remoteSubscriptionUserPrice: 0
                    remoteFreeSubscriptionUsers: 0
                    remoteEducationalUserPrice: 0
                    remoteFreeEducationalUsers: 0
                    remoteRoundUpUsedSpace: false
                    remoteStandardStorageUsedSpacePrice: 0
                    remoteStandardStorageUsedSpaceChunkSize: 1
                    remoteStandardStorageUsedSpaceUnits: GB
                    remoteFreeStandardStorageUsedSpace: 
                    remoteFreeStandardStorageUsedSpaceUnits: GB
                    remoteArchiveStorageUsedSpacePrice: 0
                    remoteArchiveStorageUsedSpaceChunkSize: 1
                    remoteArchiveStorageUsedSpaceUnits: GB
                    remoteFreeArchiveStorageUsedSpace: 
                    remoteFreeArchiveStorageUsedSpaceUnits: GB
                    remoteRepositorySpaceUsageAlgorithm: Consumed
                    remoteRepositoryAllocatedSpacePrice: 0
                    remoteRepositoryAllocatedSpaceUnits: GB
                    hostedSubscriptionUserPrice: 0
                    hostedFreeSubscriptionUsers: 0
                    hostedEducationalUserPrice: 0
                    hostedFreeEducationalUsers: 0
                    hostedRoundUpUsedSpace: false
                    hostedStandardStorageUsedSpacePrice: 0
                    hostedStandardStorageUsedSpaceChunkSize: 1
                    hostedStandardStorageUsedSpaceUnits: GB
                    hostedFreeStandardStorageUsedSpace: 
                    hostedFreeStandardStorageUsedSpaceUnits: GB
                    hostedArchiveStorageUsedSpacePrice: 0
                    hostedArchiveStorageUsedSpaceChunkSize: 1
                    hostedArchiveStorageUsedSpaceUnits: GB
                    hostedFreeArchiveStorageUsedSpace: 
                    hostedFreeArchiveStorageUsedSpaceUnits: GB
                    hostedRepositorySpaceUsageAlgorithm: Consumed
                    hostedRepositoryAllocatedSpacePrice: 0
                    hostedRepositoryAllocatedSpaceUnits: GB
                  cloudReplication:
                    replicatedVmPrice: 10
                    cloudStorageConsumedSpacePrice: 10
                    cloudStorageConsumedSpaceUnits: TB
                    freeCloudStorageConsumedSpace: 
                    freeCloudStorageConsumedSpaceUnits: GB
                    computeResourcesPrice: 0
                    computeResourcesUnits: Hours
                    freeComputeResources: 1
                    freeComputeResourcesUnits: Hours
                    replicationDataTransferOutPrice: 0
                    replicationDataTransferOutUnits: GB
                  fileShareBackup:
                    fileShareRemoteBackupUsedSpacePrice: 0
                    fileShareRemoteBackupUsedSpaceUnits: GB
                    freeFileShareRemoteBackupUsedSpace: 
                    freeFileShareRemoteBackupUsedSpaceUnits: GB
                    fileShareRemoteArchiveUsedSpacePrice: 0
                    fileShareRemoteArchiveUsedSpaceUnits: GB
                    freeFileShareRemoteArchiveUsedSpace: 
                    freeFileShareRemoteArchiveUsedSpaceUnits: GB
                    sourceRemoteAmountOfDataPrice: 0
                    sourceRemoteAmountOfDataUnits: GB
                    freeSourceRemoteAmountOfData: 
                    freeSourceRemoteAmountOfDataUnits: GB
                    fileShareHostedBackupUsedSpacePrice: 0
                    fileShareHostedBackupUsedSpaceUnits: GB
                    freeFileShareHostedBackupUsedSpace: 
                    freeFileShareHostedBackupUsedSpaceUnits: GB
                    fileShareHostedArchiveUsedSpacePrice: 0
                    fileShareHostedArchiveUsedSpaceUnits: GB
                    freeFileShareHostedArchiveUsedSpace: 
                    freeFileShareHostedArchiveUsedSpaceUnits: GB
                    sourceHostedAmountOfDataPrice: 0
                    sourceHostedAmountOfDataUnits: GB
                    freeSourceHostedAmountOfData: 
                    freeSourceHostedAmountOfDataUnits: GB
                  cloudBackup:
                    roundUpUsedSpace: false
                    vmCloudBackupsPrice: 5
                    serverCloudBackupsPrice: 6
                    workstationCloudBackupsPrice: 7
                    cloudRepositorySpaceUsageAlgorithm: Consumed
                    cloudRepositoryAllocatedSpacePrice: 0
                    cloudRepositoryAllocatedSpaceUnits: GB
                    cloudRepositoryConsumedSpacePrice: 15
                    cloudRepositoryConsumedSpaceChunkSize: 1
                    cloudRepositoryConsumedSpaceUnits: TB
                    freeCloudRepositoryConsumedSpace: 
                    freeCloudRepositoryConsumedSpaceUnits: GB
                    backupDataTransferOutPrice: 8
                    backupDataTransferOutUnits: GB
                    insiderProtectionUsedSpacePrice: 0
                    insiderProtectionUsedSpaceUnits: GB
                    performanceTierUsedSpacePrice: 0
                    performanceTierUsedSpaceChunkSize: 1
                    performanceTierUsedSpaceUnits: GB
                    capacityTierUsedSpacePrice: 0
                    capacityTierUsedSpaceChunkSize: 1
                    capacityTierUsedSpaceUnits: GB
                    archiveTierUsedSpacePrice: 0
                    archiveTierUsedSpaceChunkSize: 1
                    archiveTierUsedSpaceUnits: GB
                  licenses:
                    vspcLicenses:
                      workstationPrice: 0
                      serverPrice: 0
                    backupAndReplicationStandardEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    backupAndReplicationEnterpriseEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    backupAndReplicationEnterprisePlusEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpFoundationPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpAdvancedPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpPremiumPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    cloudConnectLicenses:
                      vmBackupPrice: 0
                      vmReplicaPrice: 0
                      workstationBackupPrice: 0
                      serverBackupPrice: 0
                    vb365Licenses:
                      userPrice: 0
                    veeamOneLicenses:
                      monitoredObjectPrice: 0
                  externalPlugins: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/subscriptionPlans/{subscriptionPlanUid}':
    get:
      tags:
        - Subscription Plans
      summary: Get Subscription Plan
      description: Returns a resource representation of a subscription plan with the specified UID.
      operationId: GetSubscriptionPlan
      parameters:
        - name: subscriptionPlanUid
          in: path
          description: Subscription plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SubscriptionPlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 5767983e-9007-4bcb-a4c6-782acf17ed4a
                  name: Pittsburgh subscription plan
                  organizationUid: b0253922-01af-4ceb-ad92-3fe6a4e8f37c
                  type: Reseller
                  description: Subscription plan for Pittsburgh clients
                  currency: USD
                  taxType: VAT
                  taxPercent: 10
                  discountPercent: 12
                  managedBackup:
                    managedServicePrice: 21
                    monitoredServicePrice: 0
                    remoteManagedVmPrice: 0
                    remoteManagedCdpVmPrice: 0
                    remoteManagedWorkstationPrice: 0
                    remoteManagedServerAgentPrice: 0
                    remoteFreeManagedVms: 0
                    remoteFreeManagedCdpVms: 0
                    remoteFreeManagedWorkstations: 0
                    remoteFreeManagedServerAgents: 0
                    remoteWindowsServerOsPrice: 0
                    remoteWindowsClientOsPrice: 0
                    remoteLinuxOsPrice: 0
                    remoteMacOsPrice: 0
                    remoteBackupUsedSpacePrice: 0
                    remoteBackupUsedSpaceUnits: GB
                    remoteFreeBackupUsedSpace: 
                    remoteFreeBackupUsedSpaceUnits: GB
                    remoteRepositorySpaceUsageAlgorithm: Consumed
                    remoteRepositoryAllocatedSpacePrice: 0
                    remoteRepositoryAllocatedSpaceUnits: GB
                    remoteRoundUpBackupUsedSpace: false
                    remoteBackupUsedSpaceChunkSize: 1
                    hostedManagedVmPrice: 0
                    hostedManagedCdpVmPrice: 0
                    hostedManagedWorkstationPrice: 0
                    hostedManagedServerAgentPrice: 0
                    hostedFreeManagedVms: 0
                    hostedFreeManagedCdpVms: 0
                    hostedFreeManagedWorkstations: 0
                    hostedFreeManagedServerAgents: 0
                    hostedWindowsServerOsPrice: 0
                    hostedWindowsClientOsPrice: 0
                    hostedLinuxOsPrice: 0
                    hostedMacOsPrice: 0
                    hostedBackupUsedSpacePrice: 0
                    hostedBackupUsedSpaceUnits: GB
                    hostedFreeBackupUsedSpace: 
                    hostedFreeBackupUsedSpaceUnits: GB
                    hostedRepositorySpaceUsageAlgorithm: Consumed
                    hostedRepositoryAllocatedSpacePrice: 0
                    hostedRepositoryAllocatedSpaceUnits: GB
                    hostedRoundUpBackupUsedSpace: false
                    hostedBackupUsedSpaceChunkSize: 1
                  publicCloud:
                    remoteCloudVmPrice: 0
                    remoteFreeCloudVms: 0
                    remoteCloudFileSharePrice: 0
                    remoteFreeCloudFileShares: 0
                    remoteCloudDatabasePrice: 0
                    remoteFreeCloudDatabases: 0
                    remoteCloudNetworkPrice: 0
                    remoteBackupUsedSpacePrice: 0
                    remoteBackupUsedSpaceUnits: GB
                    remoteFreeBackupUsedSpace: 
                    remoteFreeBackupUsedSpaceUnits: GB
                    remoteArchiveUsedSpacePrice: 0
                    remoteArchiveUsedSpaceUnits: GB
                    remoteFreeArchiveUsedSpace: 
                    remoteFreeArchiveUsedSpaceUnits: GB
                    hostedCloudVmPrice: 0
                    hostedFreeCloudVms: 0
                    hostedCloudFileSharePrice: 0
                    hostedFreeCloudFileShares: 0
                    hostedCloudDatabasePrice: 0
                    hostedFreeCloudDatabases: 0
                    hostedCloudNetworkPrice: 0
                    hostedBackupUsedSpacePrice: 0
                    hostedBackupUsedSpaceUnits: GB
                    hostedFreeBackupUsedSpace: 
                    hostedFreeBackupUsedSpaceUnits: GB
                    hostedArchiveUsedSpacePrice: 0
                    hostedArchiveUsedSpaceUnits: GB
                    hostedFreeArchiveUsedSpace: 
                    hostedFreeArchiveUsedSpaceUnits: GB
                  vb365:
                    remoteSubscriptionUserPrice: 0
                    remoteFreeSubscriptionUsers: 0
                    remoteEducationalUserPrice: 0
                    remoteFreeEducationalUsers: 0
                    remoteRoundUpUsedSpace: false
                    remoteStandardStorageUsedSpacePrice: 0
                    remoteStandardStorageUsedSpaceChunkSize: 1
                    remoteStandardStorageUsedSpaceUnits: GB
                    remoteFreeStandardStorageUsedSpace: 
                    remoteFreeStandardStorageUsedSpaceUnits: GB
                    remoteArchiveStorageUsedSpacePrice: 0
                    remoteArchiveStorageUsedSpaceChunkSize: 1
                    remoteArchiveStorageUsedSpaceUnits: GB
                    remoteFreeArchiveStorageUsedSpace: 
                    remoteFreeArchiveStorageUsedSpaceUnits: GB
                    remoteRepositorySpaceUsageAlgorithm: Consumed
                    remoteRepositoryAllocatedSpacePrice: 0
                    remoteRepositoryAllocatedSpaceUnits: GB
                    hostedSubscriptionUserPrice: 0
                    hostedFreeSubscriptionUsers: 0
                    hostedEducationalUserPrice: 0
                    hostedFreeEducationalUsers: 0
                    hostedRoundUpUsedSpace: false
                    hostedStandardStorageUsedSpacePrice: 0
                    hostedStandardStorageUsedSpaceChunkSize: 1
                    hostedStandardStorageUsedSpaceUnits: GB
                    hostedFreeStandardStorageUsedSpace: 
                    hostedFreeStandardStorageUsedSpaceUnits: GB
                    hostedArchiveStorageUsedSpacePrice: 0
                    hostedArchiveStorageUsedSpaceChunkSize: 1
                    hostedArchiveStorageUsedSpaceUnits: GB
                    hostedFreeArchiveStorageUsedSpace: 
                    hostedFreeArchiveStorageUsedSpaceUnits: GB
                    hostedRepositorySpaceUsageAlgorithm: Consumed
                    hostedRepositoryAllocatedSpacePrice: 0
                    hostedRepositoryAllocatedSpaceUnits: GB
                  cloudReplication:
                    replicatedVmPrice: 10
                    cloudStorageConsumedSpacePrice: 10
                    cloudStorageConsumedSpaceUnits: TB
                    freeCloudStorageConsumedSpace: 
                    freeCloudStorageConsumedSpaceUnits: GB
                    computeResourcesPrice: 0
                    computeResourcesUnits: Hours
                    freeComputeResources: 1
                    freeComputeResourcesUnits: Hours
                    replicationDataTransferOutPrice: 0
                    replicationDataTransferOutUnits: GB
                  fileShareBackup:
                    fileShareRemoteBackupUsedSpacePrice: 0
                    fileShareRemoteBackupUsedSpaceUnits: GB
                    freeFileShareRemoteBackupUsedSpace: 
                    freeFileShareRemoteBackupUsedSpaceUnits: GB
                    fileShareRemoteArchiveUsedSpacePrice: 0
                    fileShareRemoteArchiveUsedSpaceUnits: GB
                    freeFileShareRemoteArchiveUsedSpace: 
                    freeFileShareRemoteArchiveUsedSpaceUnits: GB
                    sourceRemoteAmountOfDataPrice: 0
                    sourceRemoteAmountOfDataUnits: GB
                    freeSourceRemoteAmountOfData: 
                    freeSourceRemoteAmountOfDataUnits: GB
                    fileShareHostedBackupUsedSpacePrice: 0
                    fileShareHostedBackupUsedSpaceUnits: GB
                    freeFileShareHostedBackupUsedSpace: 
                    freeFileShareHostedBackupUsedSpaceUnits: GB
                    fileShareHostedArchiveUsedSpacePrice: 0
                    fileShareHostedArchiveUsedSpaceUnits: GB
                    freeFileShareHostedArchiveUsedSpace: 
                    freeFileShareHostedArchiveUsedSpaceUnits: GB
                    sourceHostedAmountOfDataPrice: 0
                    sourceHostedAmountOfDataUnits: GB
                    freeSourceHostedAmountOfData: 
                    freeSourceHostedAmountOfDataUnits: GB
                  cloudBackup:
                    roundUpUsedSpace: false
                    vmCloudBackupsPrice: 5
                    serverCloudBackupsPrice: 6
                    workstationCloudBackupsPrice: 7
                    cloudRepositorySpaceUsageAlgorithm: Consumed
                    cloudRepositoryAllocatedSpacePrice: 0
                    cloudRepositoryAllocatedSpaceUnits: GB
                    cloudRepositoryConsumedSpacePrice: 15
                    cloudRepositoryConsumedSpaceChunkSize: 1
                    cloudRepositoryConsumedSpaceUnits: TB
                    freeCloudRepositoryConsumedSpace: 
                    freeCloudRepositoryConsumedSpaceUnits: GB
                    backupDataTransferOutPrice: 8
                    backupDataTransferOutUnits: GB
                    insiderProtectionUsedSpacePrice: 0
                    insiderProtectionUsedSpaceUnits: GB
                    performanceTierUsedSpacePrice: 0
                    performanceTierUsedSpaceChunkSize: 1
                    performanceTierUsedSpaceUnits: GB
                    capacityTierUsedSpacePrice: 0
                    capacityTierUsedSpaceChunkSize: 1
                    capacityTierUsedSpaceUnits: GB
                    archiveTierUsedSpacePrice: 0
                    archiveTierUsedSpaceChunkSize: 1
                    archiveTierUsedSpaceUnits: GB
                  licenses:
                    vspcLicenses:
                      workstationPrice: 0
                      serverPrice: 0
                    backupAndReplicationStandardEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    backupAndReplicationEnterpriseEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    backupAndReplicationEnterprisePlusEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpFoundationPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpAdvancedPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpPremiumPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    cloudConnectLicenses:
                      vmBackupPrice: 0
                      vmReplicaPrice: 0
                      workstationBackupPrice: 0
                      serverBackupPrice: 0
                    vb365Licenses:
                      userPrice: 0
                    veeamOneLicenses:
                      monitoredObjectPrice: 0
                  externalPlugins: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/SubscriptionPlan'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyInvoiceAuditor
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
    patch:
      tags:
        - Subscription Plans
      summary: Modify Subscription Plan
      description: Modifies a subscription plan with the specified UID.
      operationId: PatchSubscriptionPlan
      parameters:
        - name: subscriptionPlanUid
          in: path
          description: Subscription plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Pittsburgh subscription plan
                path: /name
                op: replace
              - value: GST
                path: /taxtype
                op: replace
              - value: 10
                path: /ManagedBackup/managedVmPrice
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SubscriptionPlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: b0ddf649-b6e7-4347-9241-3694e796e0ed
                  name: Pittsburgh subscription plan
                  organizationUid: 8f54f378-f79b-4924-a67b-8a10a3a6737c
                  type: Provider
                  description: 
                  currency: USD
                  taxType: GST
                  taxPercent: 10
                  discountPercent: 5
                  managedBackup:
                    managedServicePrice: 0
                    monitoredServicePrice: 0
                    remoteManagedVmPrice: 10
                    remoteManagedCdpVmPrice: 0
                    remoteManagedWorkstationPrice: 0
                    remoteManagedServerAgentPrice: 0
                    remoteFreeManagedVms: 0
                    remoteFreeManagedCdpVms: 0
                    remoteFreeManagedWorkstations: 0
                    remoteFreeManagedServerAgents: 0
                    remoteWindowsServerOsPrice: 0
                    remoteWindowsClientOsPrice: 0
                    remoteLinuxOsPrice: 0
                    remoteMacOsPrice: 0
                    remoteBackupUsedSpacePrice: 0
                    remoteBackupUsedSpaceUnits: GB
                    remoteFreeBackupUsedSpace: 
                    remoteFreeBackupUsedSpaceUnits: GB
                    remoteRepositorySpaceUsageAlgorithm: Consumed
                    remoteRepositoryAllocatedSpacePrice: 0
                    remoteRepositoryAllocatedSpaceUnits: GB
                    remoteRoundUpBackupUsedSpace: false
                    remoteBackupUsedSpaceChunkSize: 1
                    hostedManagedVmPrice: 0
                    hostedManagedCdpVmPrice: 0
                    hostedManagedWorkstationPrice: 0
                    hostedManagedServerAgentPrice: 0
                    hostedFreeManagedVms: 0
                    hostedFreeManagedCdpVms: 0
                    hostedFreeManagedWorkstations: 0
                    hostedFreeManagedServerAgents: 0
                    hostedWindowsServerOsPrice: 0
                    hostedWindowsClientOsPrice: 0
                    hostedLinuxOsPrice: 0
                    hostedMacOsPrice: 0
                    hostedBackupUsedSpacePrice: 0
                    hostedBackupUsedSpaceUnits: GB
                    hostedFreeBackupUsedSpace: 
                    hostedFreeBackupUsedSpaceUnits: GB
                    hostedRepositorySpaceUsageAlgorithm: Consumed
                    hostedRepositoryAllocatedSpacePrice: 0
                    hostedRepositoryAllocatedSpaceUnits: GB
                    hostedRoundUpBackupUsedSpace: false
                    hostedBackupUsedSpaceChunkSize: 1
                  publicCloud:
                    remoteCloudVmPrice: 0
                    remoteFreeCloudVms: 0
                    remoteCloudFileSharePrice: 0
                    remoteFreeCloudFileShares: 0
                    remoteCloudDatabasePrice: 0
                    remoteFreeCloudDatabases: 0
                    remoteCloudNetworkPrice: 0
                    remoteBackupUsedSpacePrice: 0
                    remoteBackupUsedSpaceUnits: GB
                    remoteFreeBackupUsedSpace: 
                    remoteFreeBackupUsedSpaceUnits: GB
                    remoteArchiveUsedSpacePrice: 0
                    remoteArchiveUsedSpaceUnits: GB
                    remoteFreeArchiveUsedSpace: 
                    remoteFreeArchiveUsedSpaceUnits: GB
                    hostedCloudVmPrice: 0
                    hostedFreeCloudVms: 0
                    hostedCloudFileSharePrice: 0
                    hostedFreeCloudFileShares: 0
                    hostedCloudDatabasePrice: 0
                    hostedFreeCloudDatabases: 0
                    hostedCloudNetworkPrice: 0
                    hostedBackupUsedSpacePrice: 0
                    hostedBackupUsedSpaceUnits: GB
                    hostedFreeBackupUsedSpace: 
                    hostedFreeBackupUsedSpaceUnits: GB
                    hostedArchiveUsedSpacePrice: 0
                    hostedArchiveUsedSpaceUnits: GB
                    hostedFreeArchiveUsedSpace: 
                    hostedFreeArchiveUsedSpaceUnits: GB
                  vb365:
                    remoteSubscriptionUserPrice: 0
                    remoteFreeSubscriptionUsers: 0
                    remoteEducationalUserPrice: 0
                    remoteFreeEducationalUsers: 0
                    remoteRoundUpUsedSpace: false
                    remoteStandardStorageUsedSpacePrice: 0
                    remoteStandardStorageUsedSpaceChunkSize: 1
                    remoteStandardStorageUsedSpaceUnits: GB
                    remoteFreeStandardStorageUsedSpace: 
                    remoteFreeStandardStorageUsedSpaceUnits: GB
                    remoteArchiveStorageUsedSpacePrice: 0
                    remoteArchiveStorageUsedSpaceChunkSize: 1
                    remoteArchiveStorageUsedSpaceUnits: GB
                    remoteFreeArchiveStorageUsedSpace: 
                    remoteFreeArchiveStorageUsedSpaceUnits: GB
                    remoteRepositorySpaceUsageAlgorithm: Consumed
                    remoteRepositoryAllocatedSpacePrice: 0
                    remoteRepositoryAllocatedSpaceUnits: GB
                    hostedSubscriptionUserPrice: 0
                    hostedFreeSubscriptionUsers: 0
                    hostedEducationalUserPrice: 0
                    hostedFreeEducationalUsers: 0
                    hostedRoundUpUsedSpace: false
                    hostedStandardStorageUsedSpacePrice: 0
                    hostedStandardStorageUsedSpaceChunkSize: 1
                    hostedStandardStorageUsedSpaceUnits: GB
                    hostedFreeStandardStorageUsedSpace: 
                    hostedFreeStandardStorageUsedSpaceUnits: GB
                    hostedArchiveStorageUsedSpacePrice: 0
                    hostedArchiveStorageUsedSpaceChunkSize: 1
                    hostedArchiveStorageUsedSpaceUnits: GB
                    hostedFreeArchiveStorageUsedSpace: 
                    hostedFreeArchiveStorageUsedSpaceUnits: GB
                    hostedRepositorySpaceUsageAlgorithm: Consumed
                    hostedRepositoryAllocatedSpacePrice: 0
                    hostedRepositoryAllocatedSpaceUnits: GB
                  cloudReplication:
                    replicatedVmPrice: 0
                    cloudStorageConsumedSpacePrice: 0
                    cloudStorageConsumedSpaceUnits: TB
                    freeCloudStorageConsumedSpace: 
                    freeCloudStorageConsumedSpaceUnits: GB
                    computeResourcesPrice: 0
                    computeResourcesUnits: Hours
                    freeComputeResources: 0
                    freeComputeResourcesUnits: Minutes
                    replicationDataTransferOutPrice: 0
                    replicationDataTransferOutUnits: GB
                  fileShareBackup:
                    fileShareRemoteBackupUsedSpacePrice: 0
                    fileShareRemoteBackupUsedSpaceUnits: GB
                    freeFileShareRemoteBackupUsedSpace: 
                    freeFileShareRemoteBackupUsedSpaceUnits: GB
                    fileShareRemoteArchiveUsedSpacePrice: 0
                    fileShareRemoteArchiveUsedSpaceUnits: GB
                    freeFileShareRemoteArchiveUsedSpace: 
                    freeFileShareRemoteArchiveUsedSpaceUnits: GB
                    sourceRemoteAmountOfDataPrice: 0
                    sourceRemoteAmountOfDataUnits: GB
                    freeSourceRemoteAmountOfData: 
                    freeSourceRemoteAmountOfDataUnits: GB
                    fileShareHostedBackupUsedSpacePrice: 0
                    fileShareHostedBackupUsedSpaceUnits: GB
                    freeFileShareHostedBackupUsedSpace: 
                    freeFileShareHostedBackupUsedSpaceUnits: GB
                    fileShareHostedArchiveUsedSpacePrice: 0
                    fileShareHostedArchiveUsedSpaceUnits: GB
                    freeFileShareHostedArchiveUsedSpace: 
                    freeFileShareHostedArchiveUsedSpaceUnits: GB
                    sourceHostedAmountOfDataPrice: 0
                    sourceHostedAmountOfDataUnits: GB
                    freeSourceHostedAmountOfData: 
                    freeSourceHostedAmountOfDataUnits: GB
                  cloudBackup:
                    roundUpUsedSpace: false
                    vmCloudBackupsPrice: 0
                    serverCloudBackupsPrice: 0
                    workstationCloudBackupsPrice: 0
                    cloudRepositorySpaceUsageAlgorithm: Consumed
                    cloudRepositoryAllocatedSpacePrice: 0
                    cloudRepositoryAllocatedSpaceUnits: GB
                    cloudRepositoryConsumedSpacePrice: 0
                    cloudRepositoryConsumedSpaceChunkSize: 1
                    cloudRepositoryConsumedSpaceUnits: TB
                    freeCloudRepositoryConsumedSpace: 
                    freeCloudRepositoryConsumedSpaceUnits: GB
                    backupDataTransferOutPrice: 0
                    backupDataTransferOutUnits: GB
                    insiderProtectionUsedSpacePrice: 0
                    insiderProtectionUsedSpaceUnits: GB
                    performanceTierUsedSpacePrice: 0
                    performanceTierUsedSpaceChunkSize: 1
                    performanceTierUsedSpaceUnits: GB
                    capacityTierUsedSpacePrice: 0
                    capacityTierUsedSpaceChunkSize: 1
                    capacityTierUsedSpaceUnits: GB
                    archiveTierUsedSpacePrice: 0
                    archiveTierUsedSpaceChunkSize: 1
                    archiveTierUsedSpaceUnits: GB
                  licenses:
                    vspcLicenses:
                      workstationPrice: 0
                      serverPrice: 0
                    backupAndReplicationStandardEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    backupAndReplicationEnterpriseEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    backupAndReplicationEnterprisePlusEditionLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpFoundationPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpAdvancedPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    vdpPremiumPackageLicenses:
                      vmPrice: 0
                      workstationPrice: 0
                      serverPrice: 0
                      applicationPrice: 0
                      microsoftEntraIdPrice: 0
                      fileSharePrice: 0
                      objectStoragePrice: 0
                      cloudVmPrice: 0
                      cloudFileSharePrice: 0
                      cloudDatabasePrice: 0
                    cloudConnectLicenses:
                      vmBackupPrice: 0
                      vmReplicaPrice: 0
                      workstationBackupPrice: 0
                      serverBackupPrice: 0
                    vb365Licenses:
                      userPrice: 0
                    veeamOneLicenses:
                      monitoredObjectPrice: 0
                  externalPlugins: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/SubscriptionPlan'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    delete:
      tags:
        - Subscription Plans
      summary: Delete Subscription Plan
      description: Deletes a subscription plan with the specified UID.
      operationId: DeleteSubscriptionPlan
      parameters:
        - name: subscriptionPlanUid
          in: path
          description: Subscription plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/subscriptionPlans/{subscriptionPlanUid}/companies':
    get:
      tags:
        - Subscription Plans
      summary: Get Companies by Subscription Plan
      description: Returns a collection resource representation of all companies to which a subscription plan with the specified UID is assigned.
      operationId: GetCompaniesBySubscriptionPlan
      parameters:
        - name: subscriptionPlanUid
          in: path
          description: Subscription plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/CompanyExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Company'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: eb866e8f-a0f5-41f4-9dd9-8cc59266ff25
                    name: Alpha
                    status: Active
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    subscriptionPlanUid: 477ce6a4-9bee-4387-9df0-3444f7da425f
                    isRestAccessEnabled: false
                    isAlarmDetectEnabled: false
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement:
                          workstationAgentsQuota: 
                          serverAgentsQuota: 
                        backupServersManagement: 
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: alphaowner
                      password: 
                    _embedded:
                      organization:
                        instanceUid: eb866e8f-a0f5-41f4-9dd9-8cc59266ff2
                        name: Alpha
                        alias: alpha
                        type: Company
                        taxId: 12345
                        email: s.smith@alpha.com
                        phone: 414-351-6025
                        country: 1
                        state: 49
                        countryName: USA
                        regionName: Midwest
                        city: Milwaukee
                        street: 3025 Johnny Lane
                        locationAdmin0Code: us
                        locationAdmin1Code: us-wi
                        locationAdmin2Code: 
                        notes: ''
                        zipCode: '53217'
                        website: www.alpha.com
                        veeamTenantId: 2
                        companyId: 
                  - instanceUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                    name: Beta
                    status: Active
                    resellerUid: a1797b02-364e-4e31-b052-7d7db48edb4a
                    subscriptionPlanUid: 477ce6a4-9bee-4387-9df0-3444f7da425f
                    isRestAccessEnabled: false
                    isAlarmDetectEnabled: false
                    companyServices:
                      hostedServices:
                        isVbPublicCloudManagementEnabled: false
                      remoteServices:
                        isBackupResourcesEnabled: true
                        backupAgentsManagement:
                          workstationAgentsQuota: 
                          serverAgentsQuota: 
                        backupServersManagement: 
                        vb365ServersManagement: 
                        isVbPublicCloudManagementEnabled: false
                    loginUrl: 
                    ownerCredentials:
                      userName: betaowner
                      password: 
                    _embedded:
                      organization:
                        instanceUid: 7a40eaf3-a380-4f16-aad0-ca7b08f60fb0
                        name: Beta
                        alias: beta
                        type: Company
                        taxId: 9876
                        email: m.lore@beta.com
                        phone: 503-254-0212
                        country: 1
                        state: 37
                        countryName: USA
                        regionName: West
                        city: Portland
                        street: 5006 Gateway Road
                        locationAdmin0Code: us
                        locationAdmin1Code: us-or
                        locationAdmin2Code: 
                        notes: Company with network appliance
                        zipCode: '11202'
                        website: www.beta.com
                        veeamTenantId: ''
                        companyId: ''
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /discovery/rules:
    get:
      tags:
        - Discovery
      summary: Get All Discovery Rules
      description: Returns a collection resource representation of all discovery rules.
      operationId: GetDiscoveryRules
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 796e1b6d-c766-4c17-bf55-fe6bb15fb171
                    name: Scheduled Linux Network Rule
                    masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                    locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                    companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                    systemType: Linux
                    status: Created
                    lastRun: 
                    filter:
                      exclusionMask: [ ]
                      ignoreInaccessibleMachine: false
                      osTypes: 
                      applications: 
                      customApplication: 
                      platforms: 
                    notificationSettings:
                      isEnabled: false
                      scheduleType: Days
                      scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                      weekSettings: 
                      to: 
                      subject: 
                      notifyOnTheFirstRun: false
                    scheduleSettings:
                      scheduleType: Monthly
                      timeZone:
                        timeZoneId: Pacific Standard Time
                        displayName: (UTC-08:00) Pacific Time (US & Canada)
                        utcOffset: 180
                      dailyScheduleSettings: 
                      monthlyScheduleSettings:
                        time: '2025-09-09T11:00:00.0000000+02:00'
                        calendarSettings:
                          monthlyMode: Day
                          weekDayNumber: 
                          dayOfWeek: 
                          day: 2
                          months:
                            - Jun
                            - Jul
                            - Dec
                      periodicalScheduleSettings: 
                    totalComputersCount: 1
                    onlineComputersCount: 1
                    offlineComputersCount: 0
                  - instanceUid: b44ae0ed-5700-4637-bd4f-06193f68f002
                    name: Key Linux Network Rule
                    masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                    locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                    companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                    systemType: Linux
                    status: Success
                    lastRun: '2024-07-18T06:00:04.6937361+02:00'
                    filter:
                      exclusionMask: [ ]
                      ignoreInaccessibleMachine: true
                      osTypes:
                        - Debian
                        - Ubuntu
                      applications: 
                      customApplication: 
                      platforms:
                        - MicrosoftHyperVandVmWareVSphere
                        - Physical
                    notificationSettings:
                      isEnabled: true
                      scheduleType: Weeks
                      scheduleTime: '2025-09-09T05:00:00.0000000+02:00'
                      weekSettings:
                        scheduleDay: Wednesday
                      to: ivza@q.we
                      subject: notify me
                      notifyOnTheFirstRun: false
                    scheduleSettings:
                      scheduleType: NotScheduled
                      timeZone:
                        timeZoneId: Pacific Standard Time
                        displayName: (UTC-08:00) Pacific Time (US & Canada)
                        utcOffset: -420
                      dailyScheduleSettings: 
                      monthlyScheduleSettings: 
                      periodicalScheduleSettings: 
                    totalComputersCount: 2
                    onlineComputersCount: 2
                    offlineComputersCount: 0
                  - instanceUid: 740f6271-5812-4af1-a20e-277c5beecc8d
                    name: Complex Linux Network Rule
                    masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                    locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                    companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                    systemType: Linux
                    status: Created
                    lastRun: 
                    filter:
                      exclusionMask: [ ]
                      ignoreInaccessibleMachine: true
                      osTypes:
                        - Debian
                        - Ubuntu
                      applications: 
                      customApplication: 
                      platforms:
                        - MicrosoftHyperVandVmWareVSphere
                        - Physical
                    notificationSettings:
                      isEnabled: false
                      scheduleType: Weeks
                      scheduleTime: '2025-09-09T05:00:00.0000000+02:00'
                      weekSettings:
                        scheduleDay: Monday
                      to: ivza@q.we
                      subject: notify me
                      notifyOnTheFirstRun: false
                    scheduleSettings:
                      scheduleType: NotScheduled
                      timeZone:
                        timeZoneId: Pacific Standard Time
                        displayName: (UTC-08:00) Pacific Time (US & Canada)
                        utcOffset: -420
                      dailyScheduleSettings: 
                      monthlyScheduleSettings: 
                      periodicalScheduleSettings: 
                    totalComputersCount: 1
                    onlineComputersCount: 1
                    offlineComputersCount: 0
                  - instanceUid: 3d4503cc-f2c2-4a61-9434-beaea5852b05
                    name: Complex AD Rule By Search
                    masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                    locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                    companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                    systemType: Windows
                    status: Created
                    lastRun: 
                    filter:
                      exclusionMask:
                        - string
                      ignoreInaccessibleMachine: true
                      osTypes:
                        - WindowsServer
                      applications:
                        - MicrosoftExchangeServer
                        - MicrosoftActiveDirectory
                      customApplication: 
                      platforms:
                        - MicrosoftHyperVandVmWareVSphere
                    notificationSettings:
                      isEnabled: true
                      scheduleType: Days
                      scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                      weekSettings: 
                      to: administrator@vspc1.com
                      subject: VSPC Discovery Results
                      notifyOnTheFirstRun: false
                    scheduleSettings:
                      scheduleType: NotScheduled
                      timeZone:
                        timeZoneId: Pacific Standard Time
                        displayName: (UTC-08:00) Pacific Time (US & Canada)
                        utcOffset: -420
                      dailyScheduleSettings: 
                      monthlyScheduleSettings: 
                      periodicalScheduleSettings: 
                    totalComputersCount: 1
                    onlineComputersCount: 1
                    offlineComputersCount: 0
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/discovery/rules/{ruleUid}':
    get:
      tags:
        - Discovery
      summary: Get Discovery Rule
      description: Returns a resource representation of a discovery rule with the specified UID.
      operationId: GetDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 796e1b6d-c766-4c17-bf55-fe6bb15fb171
                  name: Scheduled Linux Network Rule
                  masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                  locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                  companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                  systemType: Linux
                  status: Created
                  lastRun: 
                  filter:
                    exclusionMask: [ ]
                    ignoreInaccessibleMachine: false
                    osTypes: 
                    applications: 
                    customApplication: 
                    platforms: 
                  notificationSettings:
                    isEnabled: false
                    scheduleType: Days
                    scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                    weekSettings: 
                    to: 
                    subject: 
                    notifyOnTheFirstRun: false
                  scheduleSettings:
                    scheduleType: Monthly
                    timeZone:
                      timeZoneId: Pacific Standard Time
                      displayName: (UTC-08:00) Pacific Time (US & Canada)
                      utcOffset: 180
                    dailyScheduleSettings: 
                    monthlyScheduleSettings:
                      time: '2025-09-09T11:00:00.0000000+02:00'
                      calendarSettings:
                        monthlyMode: Day
                        weekDayNumber: 
                        dayOfWeek: 
                        day: 2
                        months:
                          - Jun
                          - Jul
                          - Dec
                    periodicalScheduleSettings: 
                  totalComputersCount: 1
                  onlineComputersCount: 1
                  offlineComputersCount: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/DiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Discovery
      summary: Modify Discovery Rule
      description: Modifies a discovery rule with the specified UID.
      operationId: PatchDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Scheduled Linux Network Rule
                path: /name
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 796e1b6d-c766-4c17-bf55-fe6bb15fb171
                  name: Scheduled Linux Network Rule
                  masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                  locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                  companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                  systemType: Linux
                  status: Created
                  lastRun: '2024-07-20T05:27:57.7715383+02:00'
                  filter:
                    exclusionMask: [ ]
                    ignoreInaccessibleMachine: false
                    osTypes:
                      - Debian
                      - Ubuntu
                    applications: 
                    customApplication: 
                    platforms: 
                  notificationSettings:
                    isEnabled: false
                    scheduleType: Days
                    scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                    weekSettings: 
                    to: 
                    subject: 
                    notifyOnTheFirstRun: false
                  scheduleSettings:
                    scheduleType: Monthly
                    timeZone:
                      timeZoneId: Pacific Standard Time
                      displayName: (UTC-08:00) Pacific Time (US & Canada)
                      utcOffset: -420
                    dailyScheduleSettings: 
                    monthlyScheduleSettings:
                      time: '2025-09-09T11:00:00.0000000+02:00'
                      calendarSettings:
                        monthlyMode: Day
                        weekDayNumber: 
                        dayOfWeek: 
                        day: 2
                        months:
                          - Jun
                          - Jul
                          - Dec
                    periodicalScheduleSettings: 
                  totalComputersCount: 12
                  onlineComputersCount: 12
                  offlineComputersCount: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/DiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    delete:
      tags:
        - Discovery
      summary: Delete Discovery Rule
      description: Deletes a discovery rule with the specified UID.
      operationId: DeleteDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/discovery/rules/{ruleUid}/start':
    post:
      tags:
        - Discovery
      summary: Start Discovery Rule
      description: Run discovery by a discovery rule with the specified UID. Returns a positive response when the discovery task is added to the internal queue and not when the task is executed.
      operationId: StartDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/discovery/rules/{ruleUid}/stop':
    post:
      tags:
        - Discovery
      summary: Stop Discovery Rule
      description: Stop discovery by a discovery rule with the specified UID. Returns a positive response when the task is added to the internal queue and not when the task is executed.
      operationId: StopDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/discovery/rules/{ruleUid}/reset':
    post:
      tags:
        - Discovery
      summary: Reset Discovery Rule Results
      description: Resets results of discovery by a discovery rule with the specified UID.
      operationId: ResetComputersByDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /discovery/rules/windows:
    get:
      tags:
        - Discovery
      summary: Get All Discovery Rules for Windows
      description: Returns a collection resource representation of all Windows discovery rules.
      operationId: GetWindowsDiscoveryRules
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/WindowsDiscoveryRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WindowsDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 3d4503cc-f2c2-4a61-9434-beaea5852b05
                    method: AD
                    useMasterManagementAgentCredentials: true
                    accessAccount:
                      userName: tech\administrator
                      password: 
                    deploymentSettings:
                      isEnabled: true
                      backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                      setReadOnlyAccess: true
                      backupAgentSettings:
                        backupAgentUid: 00000000-0000-0000-0000-000000000000
                        disableScheduledBackups: true
                        disableControlPanelNotification: true
                        disableBackupOverMeteredConnection: true
                        disableScheduleWakeup: true
                        throttleBackupActivity: true
                        restrictVpnConnections: true
                        limitBandwidthConsumption: false
                        bandwidthSpeedLimit: 1
                        bandwidthSpeedLimitUnit: MbitPerSec
                        flrWithoutAdminPrivilegesAllowed: true
                    _embedded:
                      discoveryRule:
                        instanceUid: 3d4503cc-f2c2-4a61-9434-beaea5852b05
                        name: AD Rule By Search
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask:
                            - string
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - WindowsServer
                          applications:
                            - MicrosoftExchangeServer
                            - MicrosoftActiveDirectory
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Days
                          scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                          weekSettings: 
                          to: administrator@vac.com
                          subject: VSPC Discovery Results
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                  - instanceUid: f44f4629-84af-4f2e-bd8e-9cbd6080d0ad
                    method: AD
                    useMasterManagementAgentCredentials: true
                    accessAccount:
                      userName: tech\administrator
                      password: 
                    deploymentSettings:
                      isEnabled: true
                      backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                      setReadOnlyAccess: true
                      backupAgentSettings:
                        backupAgentUid: 00000000-0000-0000-0000-000000000000
                        disableScheduledBackups: true
                        disableControlPanelNotification: true
                        disableBackupOverMeteredConnection: true
                        disableScheduleWakeup: true
                        throttleBackupActivity: true
                        restrictVpnConnections: true
                        limitBandwidthConsumption: false
                        bandwidthSpeedLimit: 2
                        bandwidthSpeedLimitUnit: MbitPerSec
                        flrWithoutAdminPrivilegesAllowed: true
                    _embedded:
                      discoveryRule:
                        instanceUid: f44f4629-84af-4f2e-bd8e-9cbd6080d0ad
                        name: Complex AD Rule By Query
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask:
                            - string
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - WindowsServer
                          applications:
                            - MicrosoftExchangeServer
                            - MicrosoftActiveDirectory
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Days
                          scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                          weekSettings: 
                          to: administrator@vspc1.com
                          subject: VSPC Discovery Results
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                  - instanceUid: 07ed391b-c9d2-4b96-8eef-a25a9728f004
                    method: Manual
                    useMasterManagementAgentCredentials: true
                    accessAccount:
                      userName: .\administrator
                      password: 
                    deploymentSettings:
                      isEnabled: true
                      backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                      setReadOnlyAccess: true
                      backupAgentSettings:
                        backupAgentUid: 00000000-0000-0000-0000-000000000000
                        disableScheduledBackups: true
                        disableControlPanelNotification: true
                        disableBackupOverMeteredConnection: true
                        disableScheduleWakeup: true
                        throttleBackupActivity: true
                        restrictVpnConnections: true
                        limitBandwidthConsumption: true
                        bandwidthSpeedLimit: 2
                        bandwidthSpeedLimitUnit: MbitPerSec
                        flrWithoutAdminPrivilegesAllowed: true
                    _embedded:
                      discoveryRule:
                        instanceUid: 07ed391b-c9d2-4b96-8eef-a25a9728f004
                        name: Complex Custom Rule
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask:
                            - string
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - WindowsServer
                            - WindowsWorkstation
                          applications:
                            - MicrosoftExchangeServer
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Days
                          scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                          weekSettings: 
                          to: administrator@vspc1.com
                          subject: VSPC Discovery Results
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                  - instanceUid: 7728817f-8026-4c38-ad8d-b0e26c710d75
                    method: NetworkBased
                    useMasterManagementAgentCredentials: true
                    accessAccount:
                      userName: .\administrator
                      password: 
                    deploymentSettings:
                      isEnabled: false
                      backupPolicyUid: 
                      setReadOnlyAccess: true
                      backupAgentSettings:
                        backupAgentUid: 00000000-0000-0000-0000-000000000000
                        disableScheduledBackups: false
                        disableControlPanelNotification: false
                        disableBackupOverMeteredConnection: true
                        disableScheduleWakeup: false
                        throttleBackupActivity: true
                        restrictVpnConnections: false
                        limitBandwidthConsumption: false
                        bandwidthSpeedLimit: 1
                        bandwidthSpeedLimitUnit: MbitPerSec
                        flrWithoutAdminPrivilegesAllowed: false
                    _embedded:
                      discoveryRule:
                        instanceUid: 7728817f-8026-4c38-ad8d-b0e26c710d75
                        name: Scheduled Windows Network Rule
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: Daily
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings:
                            time: '2025-09-09T02:30:00.0000000+02:00'
                            specificDays:
                              - Sunday
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/discovery/rules/windows/{ruleUid}':
    get:
      tags:
        - Discovery
      summary: Get Discovery Rule for Windows
      description: Returns a resource representation of a Windows discovery rule with the specified UID.
      operationId: GetWindowsDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 7728817f-8026-4c38-ad8d-b0e26c710d75
                  method: NetworkBased
                  useMasterManagementAgentCredentials: true
                  accessAccount:
                    userName: .\administrator
                    password: 
                  deploymentSettings:
                    isEnabled: false
                    backupPolicyUid: 
                    setReadOnlyAccess: true
                    backupAgentSettings:
                      backupAgentUid: 00000000-0000-0000-0000-000000000000
                      disableScheduledBackups: false
                      disableControlPanelNotification: false
                      disableBackupOverMeteredConnection: true
                      disableScheduleWakeup: false
                      throttleBackupActivity: true
                      restrictVpnConnections: false
                      limitBandwidthConsumption: false
                      bandwidthSpeedLimit: 1
                      bandwidthSpeedLimitUnit: MbitPerSec
                      flrWithoutAdminPrivilegesAllowed: false
                  _embedded:
                    discoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/WindowsDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Discovery
      summary: Modify Discovery Rule for Windows
      description: Modifies a Windows discovery rule with the specified UID.
      operationId: PatchWindowsDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /deploymentsettings/isenabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: bb2d14b7-0307-435e-9846-9cf8aa262ec6
                  method: NetworkBased
                  useMasterManagementAgentCredentials: true
                  accessAccount:
                    userName: .\administrator
                    password: 
                  deploymentSettings:
                    isEnabled: false
                    backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                    setReadOnlyAccess: true
                    backupAgentSettings:
                      backupAgentUid: 00000000-0000-0000-0000-000000000000
                      disableScheduledBackups: true
                      disableControlPanelNotification: true
                      disableBackupOverMeteredConnection: true
                      disableScheduleWakeup: true
                      throttleBackupActivity: true
                      restrictVpnConnections: true
                      limitBandwidthConsumption: true
                      bandwidthSpeedLimit: 2
                      bandwidthSpeedLimitUnit: MbitPerSec
                      flrWithoutAdminPrivilegesAllowed: true
                  _embedded:
                    discoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/WindowsDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /discovery/rules/windows/networkBased:
    get:
      tags:
        - Discovery
      summary: Get All Network-Based Discovery Rules for Windows
      description: Returns a collection resource representation of all Windows network-based discovery rules.
      operationId: GetWindowsNetworkBasedDiscoveryRules
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/WindowsNetworkBasedDiscoveryRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WindowsNetworkBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7728817f-8026-4c38-ad8d-b0e26c710d75
                    networks:
                      - networkName: Production
                        firstIp: 172.28.53.1
                        lastIp: 172.28.53.2
                        trustOptions:
                          trustOption: All
                          knownHostList: 
                    _embedded:
                      discoveryRule:
                        instanceUid: 7728817f-8026-4c38-ad8d-b0e26c710d75
                        name: Scheduled Windows Network Rule
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: Daily
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings:
                            time: '2025-09-09T02:30:00.0000000+02:00'
                            specificDays:
                              - Sunday
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: 7728817f-8026-4c38-ad8d-b0e26c710d75
                        method: NetworkBased
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: .\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: false
                          backupPolicyUid: 
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: false
                            disableControlPanelNotification: false
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: false
                            throttleBackupActivity: true
                            restrictVpnConnections: false
                            limitBandwidthConsumption: false
                            bandwidthSpeedLimit: 1
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: false
                        _embedded:
                          discoveryRule: 
                  - instanceUid: bb2d14b7-0307-435e-9846-9cf8aa262ec6
                    networks:
                      - networkName: Production Patched
                        firstIp: 172.28.53.1
                        lastIp: 172.28.53.5
                        trustOptions:
                          trustOption: All
                          knownHostList: 
                    _embedded:
                      discoveryRule:
                        instanceUid: bb2d14b7-0307-435e-9846-9cf8aa262ec6
                        name: Complex Network Rule
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask:
                            - string
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - WindowsServer
                          applications:
                            - MicrosoftExchangeServer
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Days
                          scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                          weekSettings: 
                          to: administrator@vspc1.com
                          subject: VSPC Discovery Results
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: bb2d14b7-0307-435e-9846-9cf8aa262ec6
                        method: NetworkBased
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: .\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: false
                          backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: true
                            disableControlPanelNotification: true
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: true
                            throttleBackupActivity: true
                            restrictVpnConnections: true
                            limitBandwidthConsumption: true
                            bandwidthSpeedLimit: 2
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: true
                        _embedded:
                          discoveryRule: 
                  - instanceUid: e10c6b29-a1f2-4a45-8bc2-ccfb44999b6b
                    networks:
                      - networkName: Production
                        firstIp: 172.28.53.1
                        lastIp: 172.28.53.50
                        trustOptions:
                          trustOption: All
                          knownHostList: 
                    _embedded:
                      discoveryRule:
                        instanceUid: e10c6b29-a1f2-4a45-8bc2-ccfb44999b6b
                        name: Negative Network Rule
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask:
                            - string
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - WindowsServer
                          applications:
                            - MicrosoftExchangeServer
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Days
                          scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                          weekSettings: 
                          to: administrator@vspc1.com
                          subject: VSPC Discovery Results
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: e10c6b29-a1f2-4a45-8bc2-ccfb44999b6b
                        method: NetworkBased
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: .\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: true
                          backupPolicyUid: 
                          setReadOnlyAccess: false
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: true
                            disableControlPanelNotification: true
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: true
                            throttleBackupActivity: true
                            restrictVpnConnections: true
                            limitBandwidthConsumption: true
                            bandwidthSpeedLimit: 2
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: true
                        _embedded:
                          discoveryRule: 
                  - instanceUid: 88400c1f-d0fd-4e6e-9b18-3a98f5c6dfbc
                    networks:
                      - networkName: Production
                        firstIp: 172.36.48.42
                        lastIp: 172.36.48.42
                        trustOptions:
                          trustOption: All
                          knownHostList: 
                    _embedded:
                      discoveryRule:
                        instanceUid: 88400c1f-d0fd-4e6e-9b18-3a98f5c6dfbc
                        name: DallasRule
                        masterAgentUid: c7b1a508-5fff-4bcb-a329-71f36ff581c9
                        locationUid: 29d16c61-7298-4486-92ce-cb736797095f
                        companyUid: 14c012bd-f4b0-4445-a75b-9346158cbc82
                        systemType: Windows
                        status: Success
                        lastRun: '2024-07-18T06:19:24.1358669+02:00'
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 2
                        onlineComputersCount: 2
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: 88400c1f-d0fd-4e6e-9b18-3a98f5c6dfbc
                        method: NetworkBased
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: .\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: false
                          backupPolicyUid: 
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: false
                            disableControlPanelNotification: false
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: false
                            throttleBackupActivity: true
                            restrictVpnConnections: false
                            limitBandwidthConsumption: false
                            bandwidthSpeedLimit: 1
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: false
                        _embedded:
                          discoveryRule: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Discovery
      summary: Create Network-Based Discovery Rule for Windows
      description: Creates a Windows network-based discovery rule.
      operationId: CreateWindowsNetworkBasedDiscoveryRule
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Discovery rule settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WindowsNetworkBasedDiscoveryRuleInput'
            example:
              name: Complex Network Rule
              masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
              networks:
                - networkName: Production
                  firstIp: 172.28.53.1
                  lastIp: 172.28.53.2
                  trustOptions: 
              useMasterManagementAgentCredentials: true
              accessAccount:
                userName: .\administrator
                password: Password1
              filter:
                exclusionMask:
                  - string
                ignoreInaccessibleMachine: true
                osTypes:
                  - WindowsServer
                applications:
                  - MicrosoftExchangeServer
                customApplication: 
                platforms:
                  - MicrosoftHyperVandVmWareVSphere
              notificationSettings:
                isEnabled: true
                scheduleType: Days
                scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                weekSettings: 
                to: administrator@mycompany.com
                subject: VSPC Discovery Results
                notifyOnTheFirstRun: false
              deploymentSettings:
                isEnabled: true
                backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                setReadOnlyAccess: true
                backupAgentSettings:
                  disableScheduledBackups: true
                  disableControlPanelNotification: true
                  disableBackupOverMeteredConnection: true
                  disableScheduleWakeup: true
                  throttleBackupActivity: true
                  restrictVpnConnections: true
                  limitBandwidthConsumption: true
                  bandwidthSpeedLimit: 2
                  bandwidthSpeedLimitUnit: MbitPerSec
                  flrWithoutAdminPrivilegesAllowed: true
              scheduleSettings:
                scheduleType: NotScheduled
                timeZone: 
                dailyScheduleSettings: 
                monthlyScheduleSettings: 
                periodicalScheduleSettings: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsNetworkBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 6953cf4e-2f8e-4bc2-8eea-1f7ef6de9396
                  networks:
                    - networkName: Production
                      firstIp: 172.28.53.1
                      lastIp: 172.28.53.2
                      trustOptions:
                        trustOption: All
                        knownHostList: 
                  _embedded:
                    discoveryRule: 
                    windowsDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/discovery/rules/windows/networkBased/{ruleUid}':
    get:
      tags:
        - Discovery
      summary: Get Network-Based Discovery Rule for Windows
      description: Returns a resource representation of a Windows network-based discovery rule.
      operationId: GetWindowsNetworkBasedDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsNetworkBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: bb2d14b7-0307-435e-9846-9cf8aa262ec6
                  networks:
                    - networkName: Production
                      firstIp: 172.28.53.1
                      lastIp: 172.28.53.50
                      trustOptions:
                        trustOption: All
                        knownHostList: 
                  _embedded:
                    discoveryRule: 
                    windowsDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/WindowsNetworkBasedDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Discovery
      summary: Modify Network-Based Discovery Rule for Windows
      description: Modifies a Windows network-based discovery rule with the specified UID.
      operationId: PatchWindowsNetworkBasedDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Production 2
                path: /networks/networkName
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsNetworkBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: bb2d14b7-0307-435e-9846-9cf8aa262ec6
                  networks:
                    - networkName: Production 2
                      firstIp: 172.28.53.1
                      lastIp: 172.28.53.2
                      trustOptions:
                        trustOption: All
                        knownHostList: 
                  _embedded:
                    discoveryRule: 
                    windowsDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/WindowsNetworkBasedDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /discovery/rules/windows/adBased:
    get:
      tags:
        - Discovery
      summary: Get All Microsoft Entra ID Discovery Rules for Windows
      description: Returns a collection resource representation of all Microsoft Entra ID discovery rules.
      operationId: GetWindowsActiveDirectoryBasedDiscoveryRules
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/WindowsActiveDirectoryBasedDiscoveryRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WindowsActiveDirectoryBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 3d4503cc-f2c2-4a61-9434-beaea5852b05
                    customQuery: string
                    adMethod: Search
                    skipOfflineComputersDays: 
                    _embedded:
                      discoveryRule:
                        instanceUid: 3d4503cc-f2c2-4a61-9434-beaea5852b05
                        name: Complex AD Rule By Search
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask:
                            - string
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - WindowsServer
                          applications:
                            - MicrosoftExchangeServer
                            - MicrosoftActiveDirectory
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Days
                          scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                          weekSettings: 
                          to: administrator@vspc1.com
                          subject: VSPC Discovery Results
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: 3d4503cc-f2c2-4a61-9434-beaea5852b05
                        method: AD
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: tech\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: true
                          backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: true
                            disableControlPanelNotification: true
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: true
                            throttleBackupActivity: true
                            restrictVpnConnections: true
                            limitBandwidthConsumption: false
                            bandwidthSpeedLimit: 1
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: true
                        _embedded:
                          discoveryRule: 
                  - instanceUid: f44f4629-84af-4f2e-bd8e-9cbd6080d0ad
                    customQuery: 'OU=auto, DC=n, DC=local'
                    adMethod: Query
                    skipOfflineComputersDays: 45
                    _embedded:
                      discoveryRule:
                        instanceUid: f44f4629-84af-4f2e-bd8e-9cbd6080d0ad
                        name: Complex AD Rule By Query
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask:
                            - string
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - WindowsServer
                          applications:
                            - MicrosoftExchangeServer
                            - MicrosoftActiveDirectory
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Days
                          scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                          weekSettings: 
                          to: administrator@vspc1.com
                          subject: VSPC Discovery Results
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: f44f4629-84af-4f2e-bd8e-9cbd6080d0ad
                        method: AD
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: tech\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: true
                          backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: true
                            disableControlPanelNotification: true
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: true
                            throttleBackupActivity: true
                            restrictVpnConnections: true
                            limitBandwidthConsumption: false
                            bandwidthSpeedLimit: 2
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: true
                        _embedded:
                          discoveryRule: 
                  - instanceUid: 20eaec65-a3a4-4539-83ce-05426171eb20
                    customQuery: 'OU=auto, DC=n, DC=local'
                    adMethod: Query
                    skipOfflineComputersDays: 30
                    _embedded:
                      discoveryRule:
                        instanceUid: 20eaec65-a3a4-4539-83ce-05426171eb20
                        name: The Simplest AD Rule By Search
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: 20eaec65-a3a4-4539-83ce-05426171eb20
                        method: AD
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: tech\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: false
                          backupPolicyUid: 
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: false
                            disableControlPanelNotification: false
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: false
                            throttleBackupActivity: true
                            restrictVpnConnections: false
                            limitBandwidthConsumption: false
                            bandwidthSpeedLimit: 1
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: false
                        _embedded:
                          discoveryRule: 
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Discovery
      summary: Create Microsoft Entra ID Discovery Rule for Windows
      description: Creates an Microsoft Entra ID discovery rule.
      operationId: CreateWindowsActiveDirectoryBasedDiscoveryRule
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Discovery rule settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WindowsActiveDirectoryBasedDiscoveryRuleInput'
            example:
              name: Complex AD Rule By Query
              masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
              skipOfflineComputersDays: 45
              customQuery: 'OU=auto, DC=n, DC=local'
              adMethod: Query
              useMasterManagementAgentCredentials: true
              accessAccount:
                userName: tech\administrator
                password: Password1
              filter:
                exclusionMask:
                  - string
                ignoreInaccessibleMachine: true
                osTypes:
                  - WindowsServer
                applications:
                  - MicrosoftExchangeServer
                  - MicrosoftActiveDirectory
                customApplication: 
                platforms:
                  - MicrosoftHyperVandVmWareVSphere
              notificationSettings:
                isEnabled: true
                scheduleType: Days
                scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                weekSettings: 
                to: administrator@vspc1.com
                subject: VSPC Discovery Results
                notifyOnTheFirstRun: false
              deploymentSettings:
                isEnabled: true
                backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                setReadOnlyAccess: true
                backupAgentSettings:
                  disableScheduledBackups: true
                  disableControlPanelNotification: true
                  disableBackupOverMeteredConnection: true
                  disableScheduleWakeup: true
                  throttleBackupActivity: true
                  restrictVpnConnections: true
                  limitBandwidthConsumption: false
                  bandwidthSpeedLimit: 2
                  bandwidthSpeedLimitUnit: MbitPerSec
                  flrWithoutAdminPrivilegesAllowed: true
              scheduleSettings:
                scheduleType: NotScheduled
                timeZone: 
                dailyScheduleSettings: 
                monthlyScheduleSettings: 
                periodicalScheduleSettings: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsActiveDirectoryBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: f44f4629-84af-4f2e-bd8e-9cbd6080d0ad
                  customQuery: 'OU=auto, DC=n, DC=local'
                  adMethod: Query
                  skipOfflineComputersDays: 45
                  _embedded:
                    discoveryRule: 
                    windowsDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/discovery/rules/windows/adBased/{ruleUid}':
    get:
      tags:
        - Discovery
      summary: Get Microsoft Entra ID Discovery Rule for Windows
      description: Returns a resource representation of an Microsoft Entra ID discovery rule with the specified UID.
      operationId: GetWindowsActiveDirectoryBasedDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsActiveDirectoryBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 20eaec65-a3a4-4539-83ce-05426171eb20
                  customQuery: string
                  adMethod: Search
                  skipOfflineComputersDays: 
                  _embedded:
                    discoveryRule: 
                    windowsDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/WindowsActiveDirectoryBasedDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Discovery
      summary: Modify Microsoft Entra ID Discovery Rule for Windows
      description: Modifies an Microsoft Entra ID discovery rule with the specified UID.
      operationId: PatchWindowsActiveDirectoryBasedDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 'OU=auto, DC=n, DC=local'
                path: /customquery
                op: replace
              - value: Query
                path: /admethod
                op: replace
              - value: 30
                path: /skipofflinecomputersdays
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsActiveDirectoryBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 20eaec65-a3a4-4539-83ce-05426171eb20
                  customQuery: 'OU=auto, DC=n, DC=local'
                  adMethod: Query
                  skipOfflineComputersDays: 30
                  _embedded:
                    discoveryRule: 
                    windowsDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/WindowsActiveDirectoryBasedDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /discovery/rules/windows/custom:
    get:
      tags:
        - Discovery
      summary: Get All Import-Based Discovery Rules for Windows
      description: Returns a collection resource representation of all Windows discovery rules based on lists of IP addresses and DNS names.
      operationId: GetWindowsCustomDiscoveryRules
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/WindowsCustomDiscoveryRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WindowsCustomDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 07ed391b-c9d2-4b96-8eef-a25a9728f004
                    hosts:
                      - r2vaw2rule.tech.local
                      - 172.27.21.161
                    _embedded:
                      discoveryRule:
                        instanceUid: 07ed391b-c9d2-4b96-8eef-a25a9728f004
                        name: Complex Custom Rule
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask:
                            - string
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - WindowsServer
                            - WindowsWorkstation
                          applications:
                            - MicrosoftExchangeServer
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Days
                          scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                          weekSettings: 
                          to: administrator@vspc1.com
                          subject: VSPC Discovery Results
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: 07ed391b-c9d2-4b96-8eef-a25a9728f004
                        method: Manual
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: .\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: true
                          backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: true
                            disableControlPanelNotification: true
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: true
                            throttleBackupActivity: true
                            restrictVpnConnections: true
                            limitBandwidthConsumption: true
                            bandwidthSpeedLimit: 2
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: true
                        _embedded:
                          discoveryRule: 
                  - instanceUid: cbd6196d-530a-4d66-9fbe-77e11d21b2c0
                    hosts:
                      - r2vawServ2
                      - r2em
                    _embedded:
                      discoveryRule:
                        instanceUid: cbd6196d-530a-4d66-9fbe-77e11d21b2c0
                        name: EmptyVMDiscoveryRule
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Success
                        lastRun: '2024-07-18T05:40:18.4302148+02:00'
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 3
                        onlineComputersCount: 3
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: cbd6196d-530a-4d66-9fbe-77e11d21b2c0
                        method: Manual
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: .\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: false
                          backupPolicyUid: 
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: false
                            disableControlPanelNotification: false
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: false
                            throttleBackupActivity: true
                            restrictVpnConnections: false
                            limitBandwidthConsumption: false
                            bandwidthSpeedLimit: 1
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: false
                        _embedded:
                          discoveryRule: 
                  - instanceUid: 58fc261e-1e65-4683-b75d-79f6e0f7c247
                    hosts:
                      - r2vaw2.tech.local
                      - 172.27.21.161
                    _embedded:
                      discoveryRule:
                        instanceUid: 58fc261e-1e65-4683-b75d-79f6e0f7c247
                        name: The Simplest Custom Rule
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: 58fc261e-1e65-4683-b75d-79f6e0f7c247
                        method: Manual
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: .\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: false
                          backupPolicyUid: 
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: false
                            disableControlPanelNotification: false
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: false
                            throttleBackupActivity: true
                            restrictVpnConnections: false
                            limitBandwidthConsumption: false
                            bandwidthSpeedLimit: 1
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: false
                        _embedded:
                          discoveryRule: 
                  - instanceUid: 57edaa0c-b1e2-4e71-b030-d31039a05728
                    hosts:
                      - r2vawServ1.tech.local
                      - 172.27.21.164
                    _embedded:
                      discoveryRule:
                        instanceUid: 57edaa0c-b1e2-4e71-b030-d31039a05728
                        name: The Simplest Custom Rule New
                        masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Windows
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      windowsDiscoveryRule:
                        instanceUid: 57edaa0c-b1e2-4e71-b030-d31039a05728
                        method: Manual
                        useMasterManagementAgentCredentials: true
                        accessAccount:
                          userName: .\administrator
                          password: 
                        deploymentSettings:
                          isEnabled: false
                          backupPolicyUid: 
                          setReadOnlyAccess: true
                          backupAgentSettings:
                            backupAgentUid: 00000000-0000-0000-0000-000000000000
                            disableScheduledBackups: false
                            disableControlPanelNotification: false
                            disableBackupOverMeteredConnection: true
                            disableScheduleWakeup: false
                            throttleBackupActivity: true
                            restrictVpnConnections: false
                            limitBandwidthConsumption: false
                            bandwidthSpeedLimit: 1
                            bandwidthSpeedLimitUnit: MbitPerSec
                            flrWithoutAdminPrivilegesAllowed: false
                        _embedded:
                          discoveryRule: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Discovery
      summary: Create Import-Based Discovery Rule for Windows
      description: Creates a Windows rule based on a list of IP addresses and DNS names.
      operationId: CreateWindowsCustomDiscoveryRule
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Discovery rule configuration data.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WindowsCustomDiscoveryRuleInput'
            example:
              name: Complex Custom Rule
              masterAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
              hosts:
                - vaw2rule.tech.local
                - 173.27.21.161
              useMasterManagementAgentCredentials: true
              accessAccount:
                userName: .\administrator
                password: Password1
              filter:
                exclusionMask:
                  - string
                ignoreInaccessibleMachine: true
                osTypes:
                  - WindowsServer
                  - WindowsWorkstation
                applications:
                  - MicrosoftExchangeServer
                customApplication: 
                platforms:
                  - MicrosoftHyperVandVmWareVSphere
              notificationSettings:
                isEnabled: true
                scheduleType: Days
                scheduleTime: '2025-09-09T08:00:00.0000000+02:00'
                weekSettings: 
                to: administrator@vspc1.com
                subject: VSPC Discovery Results
                notifyOnTheFirstRun: false
              deploymentSettings:
                isEnabled: true
                backupPolicyUid: 7a8f9468-4c46-4b52-b011-cce3507f6b04
                setReadOnlyAccess: true
                backupAgentSettings:
                  disableScheduledBackups: true
                  disableControlPanelNotification: true
                  disableBackupOverMeteredConnection: true
                  disableScheduleWakeup: true
                  throttleBackupActivity: true
                  restrictVpnConnections: true
                  limitBandwidthConsumption: true
                  bandwidthSpeedLimit: 2
                  bandwidthSpeedLimitUnit: MbitPerSec
                  flrWithoutAdminPrivilegesAllowed: true
              scheduleSettings:
                scheduleType: NotScheduled
                timeZone: 
                dailyScheduleSettings: 
                monthlyScheduleSettings: 
                periodicalScheduleSettings: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsCustomDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: cbd6196d-530a-4d66-9fbe-77e11d21b2c0
                  hosts:
                    - vawServ2
                    - 2em
                  _embedded:
                    discoveryRule: 
                    windowsDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/discovery/rules/windows/custom/{ruleUid}':
    get:
      tags:
        - Discovery
      summary: Get Import-Based Discovery Rule for Windows
      description: Returns a resource representation of a Windows discovery rule based on a list of IP addresses and DNS names.
      operationId: GetWindowsCustomDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsCustomDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 07ed391b-c9d2-4b96-8eef-a25a9728f004
                  hosts:
                    - r2vaw7.tech.local
                    - 172.27.21.168
                  _embedded:
                    discoveryRule: 
                    windowsDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/WindowsCustomDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Discovery
      summary: Modify Import-Based Discovery Rule for Windows
      description: Modifies a Windows discovery rule based on a list of IP addresses and DNS names.
      operationId: PatchWindowsCustomDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: vawServ1.tech.local
                path: /hosts/0
                op: replace
              - value: vawServ2.tech.local
                path: /hosts/1
                op: add
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsCustomDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 57edaa0c-b1e2-4e71-b030-d31039a05728
                  hosts:
                    - vawServ1.tech.local
                    - em
                  _embedded:
                    discoveryRule: 
                    windowsDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/WindowsCustomDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /discovery/rules/linux:
    get:
      tags:
        - Discovery
      summary: Get All Discovery Rules for Linux
      description: Returns a collection resource representation of all Linux discovery rules.
      operationId: GetLinuxDiscoveryRules
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/LinuxDiscoveryRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LinuxDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 796e1b6d-c766-4c17-bf55-fe6bb15fb171
                    method: NetworkBased
                    credentials:
                      - instanceUid: 00000008-0000-0000-0000-000000000000
                        username: root
                        password: ••••••
                        priority: 0
                        description: ''
                        sshPort: 22
                        elevateAccountPrivileges: false
                        addAccountToSudoersFile: false
                        useSuIfsudoFails: false
                        rootPassword: 
                        sshPrivateKey: 
                        passphrase: 
                        type: LinuxBased
                    deploymentSettings:
                      isEnabled: false
                      backupPolicyUid: 
                      setReadOnlyAccess: true
                    _embedded:
                      discoveryRule:
                        instanceUid: 796e1b6d-c766-4c17-bf55-fe6bb15fb171
                        name: Scheduled Linux Network Rule
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: Monthly
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: 180
                          dailyScheduleSettings: 
                          monthlyScheduleSettings:
                            time: '2025-09-09T11:00:00.0000000+02:00'
                            calendarSettings:
                              monthlyMode: Day
                              weekDayNumber: 
                              dayOfWeek: 
                              day: 2
                              months:
                                - Jun
                                - Jul
                                - Dec
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                  - instanceUid: b44ae0ed-5700-4637-bd4f-06193f68f002
                    method: NetworkBased
                    credentials:
                      - instanceUid: 00000004-0000-0000-0000-000000000000
                        username: root
                        password: 
                        priority: 0
                        description: '1'
                        sshPort: 22
                        elevateAccountPrivileges: false
                        addAccountToSudoersFile: false
                        useSuIfsudoFails: false
                        rootPassword: 
                        sshPrivateKey: ••••••
                        passphrase: 
                        type: LinuxCertificate
                    deploymentSettings:
                      isEnabled: false
                      backupPolicyUid: 
                      setReadOnlyAccess: true
                    _embedded:
                      discoveryRule:
                        instanceUid: b44ae0ed-5700-4637-bd4f-06193f68f002
                        name: Key Linux Network Rule
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Success
                        lastRun: '2024-07-18T06:00:04.6937361+02:00'
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - Debian
                            - Ubuntu
                          applications: 
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                            - Physical
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Weeks
                          scheduleTime: '2025-09-09T05:00:00.0000000+02:00'
                          weekSettings:
                            scheduleDay: Wednesday
                          to: ivza@q.we
                          subject: notify me
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 2
                        onlineComputersCount: 2
                        offlineComputersCount: 0
                  - instanceUid: 740f6271-5812-4af1-a20e-277c5beecc8d
                    method: NetworkBased
                    credentials:
                      - instanceUid: 00000006-0000-0000-0000-000000000000
                        username: root
                        password: ••••••
                        priority: 0
                        description: '1'
                        sshPort: 22
                        elevateAccountPrivileges: true
                        addAccountToSudoersFile: true
                        useSuIfsudoFails: true
                        rootPassword: ••••••
                        sshPrivateKey: ••••••
                        passphrase: 
                        type: LinuxCertificate
                    deploymentSettings:
                      isEnabled: true
                      backupPolicyUid: 
                      setReadOnlyAccess: false
                    _embedded:
                      discoveryRule:
                        instanceUid: 740f6271-5812-4af1-a20e-277c5beecc8d
                        name: Linux Network Rule 2
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - Debian
                            - Ubuntu
                          applications: 
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                            - Physical
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Weeks
                          scheduleTime: '2025-09-09T05:00:00.0000000+02:00'
                          weekSettings:
                            scheduleDay: Monday
                          to: admin@alpha.com
                          subject: notify me
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                  - instanceUid: f723d728-229b-4128-8160-2053673c4bdb
                    method: Manual
                    credentials:
                      - instanceUid: 00000003-0000-0000-0000-000000000000
                        username: root
                        password: ••••••
                        priority: 0
                        description: ''
                        sshPort: 22
                        elevateAccountPrivileges: false
                        addAccountToSudoersFile: false
                        useSuIfsudoFails: false
                        rootPassword: ••••••
                        sshPrivateKey: 
                        passphrase: 
                        type: LinuxBased
                    deploymentSettings:
                      isEnabled: false
                      backupPolicyUid: 
                      setReadOnlyAccess: true
                    _embedded:
                      discoveryRule:
                        instanceUid: f723d728-229b-4128-8160-2053673c4bdb
                        name: Linux Custom Rule 1
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Success
                        lastRun: '2024-07-18T05:47:34.5990319+02:00'
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 2
                        onlineComputersCount: 2
                        offlineComputersCount: 0
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/discovery/rules/linux/{ruleUid}':
    get:
      tags:
        - Discovery
      summary: Get Discovery Rule for Linux
      description: Returns a resource representation of a Linux discovery rule with the specified UID.
      operationId: GetLinuxDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: b68fbe4d-9886-430a-8389-fc01da7b081b
                  method: Manual
                  credentials:
                    - instanceUid: 00000007-0000-0000-0000-000000000000
                      username: root
                      password: ••••••
                      priority: 0
                      description: ''
                      sshPort: 22
                      elevateAccountPrivileges: false
                      addAccountToSudoersFile: false
                      useSuIfsudoFails: false
                      rootPassword: ••••••
                      sshPrivateKey: 
                      passphrase: 
                      type: LinuxBased
                  deploymentSettings:
                    isEnabled: false
                    backupPolicyUid: 
                    setReadOnlyAccess: true
                  _embedded:
                    discoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/LinuxDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Discovery
      summary: Modify Discovery Rule for Windows
      description: Modifies a Linux discovery rule with the specified UID.
      operationId: PatchLinuxDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /deploymentsettings/isenabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 740f6271-5812-4af1-a20e-277c5beecc8d
                  method: NetworkBased
                  credentials:
                    - instanceUid: 00000007-0000-0000-0000-000000000000
                      username: root
                      password: ••••••
                      priority: 0
                      description: '1'
                      sshPort: 22
                      elevateAccountPrivileges: true
                      addAccountToSudoersFile: true
                      useSuIfsudoFails: true
                      rootPassword: ••••••
                      sshPrivateKey: ••••••
                      passphrase: 
                      type: LinuxCertificate
                  deploymentSettings:
                    isEnabled: true
                    backupPolicyUid: 
                    setReadOnlyAccess: false
                  _embedded:
                    discoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/LinuxDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /discovery/rules/linux/networkBased:
    get:
      tags:
        - Discovery
      summary: Get All Network-Based Discovery Rules for Linux
      description: Returns a collection resource representation of all Linux network-based discovery rules.
      operationId: GetLinuxNetworkBasedDiscoveryRules
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/LinuxNetworkBasedDiscoveryRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LinuxNetworkBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 796e1b6d-c766-4c17-bf55-fe6bb15fb171
                    networks:
                      - networkName: Production
                        firstIp: 172.36.48.41
                        lastIp: 172.36.48.41
                        trustOptions:
                          trustOption: All
                          knownHostList: 
                    _embedded:
                      discoveryRule:
                        instanceUid: 796e1b6d-c766-4c17-bf55-fe6bb15fb171
                        name: Scheduled Linux Network Rule
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: Monthly
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: 180
                          dailyScheduleSettings: 
                          monthlyScheduleSettings:
                            time: '2025-09-09T11:00:00.0000000+02:00'
                            calendarSettings:
                              monthlyMode: Day
                              weekDayNumber: 
                              dayOfWeek: 
                              day: 2
                              months:
                                - Jun
                                - Jul
                                - Dec
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      linuxDiscoveryRule: 
                  - instanceUid: b44ae0ed-5700-4637-bd4f-06193f68f002
                    networks:
                      - networkName: netw
                        firstIp: 172.25.48.41
                        lastIp: 172.25.48.41
                        trustOptions:
                          trustOption: All
                          knownHostList: 
                    _embedded:
                      discoveryRule:
                        instanceUid: b44ae0ed-5700-4637-bd4f-06193f68f002
                        name: Key Linux Network Rule
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Success
                        lastRun: '2024-07-18T06:00:04.6937361+02:00'
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - Debian
                            - Ubuntu
                          applications: 
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                            - Physical
                        notificationSettings:
                          isEnabled: true
                          scheduleType: Weeks
                          scheduleTime: '2025-09-09T05:00:00.0000000+02:00'
                          weekSettings:
                            scheduleDay: Wednesday
                          to: ivza@q.we
                          subject: notify me
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 2
                        onlineComputersCount: 2
                        offlineComputersCount: 0
                      linuxDiscoveryRule: 
                  - instanceUid: 740f6271-5812-4af1-a20e-277c5beecc8d
                    networks:
                      - networkName: netw
                        firstIp: 172.36.48.41
                        lastIp: 172.36.48.41
                        trustOptions:
                          trustOption: KnownList
                          knownHostList: r2valNet
                    _embedded:
                      discoveryRule:
                        instanceUid: 740f6271-5812-4af1-a20e-277c5beecc8d
                        name: Linux Network Rule 4
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: true
                          osTypes:
                            - Debian
                            - Ubuntu
                          applications: 
                          customApplication: 
                          platforms:
                            - MicrosoftHyperVandVmWareVSphere
                            - Physical
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Weeks
                          scheduleTime: '2025-09-09T05:00:00.0000000+02:00'
                          weekSettings:
                            scheduleDay: Monday
                          to: admin@alpha.com
                          subject: notify me
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      linuxDiscoveryRule: 
                  - instanceUid: 897cdc09-0568-4692-abed-9016387c1833
                    networks:
                      - networkName: Production
                        firstIp: 172.36.48.41
                        lastIp: 172.36.48.45
                        trustOptions:
                          trustOption: All
                          knownHostList: 
                    _embedded:
                      discoveryRule:
                        instanceUid: 897cdc09-0568-4692-abed-9016387c1833
                        name: Linux Network Rule 4
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Success
                        lastRun: '2024-07-18T06:04:16.7881954+02:00'
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 2
                        onlineComputersCount: 2
                        offlineComputersCount: 0
                      linuxDiscoveryRule: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Discovery
      summary: Create Network-Based Discovery Rule for Linux
      description: Creates a Linux network-based discovery rule.
      operationId: CreateLinuxNetworkBasedDiscoveryRule
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Discovery rule settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinuxNetworkBasedDiscoveryRuleInput'
            example:
              name: Complex Linux Network Rule
              masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
              networks:
                - networkName: netw
                  firstIp: 172.36.48.41
                  lastIp: 172.36.48.41
                  trustOptions:
                    trustOption: KnownList
                    knownHostList: valNet
              credentials:
                - username: root
                  password: Password1
                  priority: 0
                  description: Network-based rule for Linux computers
                  sshPort: 22
                  elevateAccountPrivileges: true
                  addAccountToSudoersFile: true
                  useSuIfsudoFails: true
                  rootPassword: Password1
                  sshPrivateKey: "-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArVMvwKOymfth5E0wq38d7svfmLVsVAHtIJYMlJBTx6Y+R2+3\nDcAqVLZG9neFJU2ivudafbZnu1TykuM0sKRXRix+cpMUGevoY026m6lo0s7m3ft9\nF5oOrr1LefsSadI7MTRhCPrHBKt+G9taMhovnGHq/8JzUflX2k1v7Sjy+zhJzpGW\nmJckhHZ+Jyd28JCdAWNiSEZgoEKGdLBL8/nkEm8Su4SRRKiTxRSbHtof+tUjIdoL\ntmdT9CiYM11eb46GMV8haaDEwpd0pL7iWZfXIo6ZZcKZ60JU70tYmz69JaYfVOLb\nasaI3ng22dzmt89Kk4C1i0ueVMH3WE7MvndpzwIBJQKCAQAODantBlqW3Qfv6pU+\nVmo19NrHMU34+Ty9c/Muo+seBo9tk2+1Ab4+OErxY6MDBkt3QzDZwq52+Qy/zTuf\nnp9K4QNVZd8JBUoxkK5D+PqpTwvMzzOn08wAVImURMokQXprxfoHpaFvFNLfqgBk\n7V3OaM3dYssUfAA0S3fHHv7xxijIfW/F4EKGk7B1+WX1LIoka4OF3fRtktqlv0xV\nIDG1YqugiwEHL2cxVHmviqJOfP496JKzz9TXS6TMWbRThykQjXf8irOfQsAbjmuO\nFFp+FCK8XITKuS9tBinpKpsUZoLiZ3r+uAO3gVWutdsdrJChYP87+Aaj82PWr+tv\nfSNlAoGBAOynYVyFklx597Yg4jdVg6+TEMlQ8Ga4TK6Iba8NzGPt6qRq1UeRninF\ncw7jIVojtqdqzKnnm+d5Ri4tS5rjLJjTwyePpR5HU3mwlDCpaJIS0XUptNOwwqso\n9Y/a92iwzAMA1Z4s3q+ye2tinP0WZb1B7RxMjrBNOuswnv3An7BFAoGBALt+eoI1\nNujkC/JXQVYgkkWtJJgu+d314qSate929cW8w37p/OevwcafOlocCvQPGOa7g6XP\nyCtw6CQtv2jbiZ2RddyvTP8kYg71o4MtND5SGiJ+Q2B2PmDbCcPZ5IZ5PyNru6Wj\nClX/bFVh0lszbpWLPKKwdJwhd+d6i3dJewUDAoGBALMW4eUmz5/tmNzanVpOjSrr\n1VoTvNgcxGhnPj9Itll1xlLpEBp8CP0EH7g9Lf8GRQkSjQr0dftHBK1StcFR+DxN\nOb0SwiTAWtihTYyb4G6KyAWjBWHtjGXZzpZgg+CFytHXHjKC0ghrZFFDtRKNfWyg\nl8JjcuZISENHY4+YsDJdAoGAfq9niGklGeYxleft4D+FbVlQE8y2qrrlPslmLC3I\nqDNvVcCxzPo20k/pKCDJIXH8EYWeI+1CD4OjxWsEyk8lodD8nAe+ZzRCQXWKKDNM\n0Cmi9LYthl27ceAbWtF+u7m1ChhcMaWDhjb2K9pP3MHi72vqsx1H3x2IXiJeO9ez\n/HcCgYEAvbcMG79y8Io4lm+c/emqnIPIL0fyrwo7SJ9qdojN63IV3YtQvct+V/Za\nOnLVizuPAye0Bk2qbc4nSt9Jj+E3PrOrZCyEtdQHwT90WM5fzb5OOk6sIwMJaajn\nY6mMXL0VW0XYI6PhfFPdwKhi2nPP07VzN302VWxTI3HeNT7Hg6A=\n-----END RSA PRIVATE KEY-----\n"
                  passphrase: ''
                  type: LinuxCertificate
              filter:
                exclusionMask: [ ]
                ignoreInaccessibleMachine: true
                osTypes:
                  - Debian
                  - Ubuntu
                applications: [ ]
                customApplication: 
                platforms:
                  - MicrosoftHyperVandVmWareVSphere
                  - Physical
              notificationSettings:
                isEnabled: true
                scheduleType: Weeks
                scheduleTime: '2025-09-09T05:00:00.0000000+02:00'
                weekSettings:
                  scheduleDay: Monday
                to: admin@mycompany.com
                subject: Linux Discovery
                notifyOnTheFirstRun: false
              deploymentSettings:
                isEnabled: false
                backupPolicyUid: 
                setReadOnlyAccess: true
              scheduleSettings:
                scheduleType: NotScheduled
                timeZone: 
                dailyScheduleSettings: 
                monthlyScheduleSettings: 
                periodicalScheduleSettings: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxNetworkBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 796e1b6d-c766-4c17-bf55-fe6bb15fb171
                  networks:
                    - networkName: Production
                      firstIp: 172.36.48.41
                      lastIp: 172.36.48.41
                      trustOptions:
                        trustOption: All
                        knownHostList: 
                  _embedded:
                    discoveryRule: 
                    linuxDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/discovery/rules/linux/networkBased/{ruleUid}':
    get:
      tags:
        - Discovery
      summary: Get Network-Based Discovery Rule for Linux
      description: Returns a resource representation of a Linux network-based discovery rule.
      operationId: GetLinuxNetworkBasedDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxNetworkBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 740f6271-5812-4af1-a20e-277c5beecc8d
                  networks:
                    - networkName: netw
                      firstIp: 172.25.48.41
                      lastIp: 172.25.48.41
                      trustOptions:
                        trustOption: KnownList
                        knownHostList: r2valNet
                  _embedded:
                    discoveryRule: 
                    linuxDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/LinuxNetworkBasedDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Discovery
      summary: Modify Network-Based Discovery Rule for Linux
      description: Modifies a Linux network-based discovery rule with the specified UID.
      operationId: PatchLinuxNetworkBasedDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 172.36.48.41
                path: /networks/0/firstIp
                op: replace
              - value: 172.36.48.41
                path: /networks/0/lastIp
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxNetworkBasedDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: b44ae0ed-5700-4637-bd4f-06193f68f002
                  networks:
                    - networkName: netw
                      firstIp: 172.36.48.41
                      lastIp: 172.36.48.41
                      trustOptions:
                        trustOption: All
                        knownHostList: 
                  _embedded:
                    discoveryRule: 
                    linuxDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/LinuxNetworkBasedDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /discovery/rules/linux/custom:
    get:
      tags:
        - Discovery
      summary: Get All Import-Based Discovery Rules for Linux
      description: Returns a collection resource representation of all Linux discovery rules based on lists of IP addresses and DNS names.
      operationId: GetLinuxCustomDiscoveryRules
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/LinuxCustomDiscoveryRuleExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LinuxCustomDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: b68fbe4d-9886-430a-8389-fc01da7b081b
                    hosts:
                      - r2val5
                      - r2val6
                    _embedded:
                      discoveryRule:
                        instanceUid: b68fbe4d-9886-430a-8389-fc01da7b081b
                        name: The Simplest Linux Custom Rule Second
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Created
                        lastRun: 
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      linuxDiscoveryRule:
                        instanceUid: b68fbe4d-9886-430a-8389-fc01da7b081b
                        method: Manual
                        credentials:
                          - instanceUid: 00000007-0000-0000-0000-000000000000
                            username: root
                            password: ••••••
                            priority: 0
                            description: ''
                            sshPort: 22
                            elevateAccountPrivileges: false
                            addAccountToSudoersFile: false
                            useSuIfsudoFails: false
                            rootPassword: ••••••
                            sshPrivateKey: 
                            passphrase: 
                            type: LinuxBased
                        deploymentSettings:
                          isEnabled: false
                          backupPolicyUid: 
                          setReadOnlyAccess: true
                        _embedded:
                          discoveryRule: 
                  - instanceUid: f723d728-229b-4128-8160-2053673c4bdb
                    hosts:
                      - r2val2
                    _embedded:
                      discoveryRule:
                        instanceUid: f723d728-229b-4128-8160-2053673c4bdb
                        name: Linux Custom Rule 2
                        masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        companyUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        systemType: Linux
                        status: Success
                        lastRun: '2024-07-18T05:47:34.5990319+02:00'
                        filter:
                          exclusionMask: [ ]
                          ignoreInaccessibleMachine: false
                          osTypes: 
                          applications: 
                          customApplication: 
                          platforms: 
                        notificationSettings:
                          isEnabled: false
                          scheduleType: Days
                          scheduleTime: '2025-09-09T00:00:00.0000000+02:00'
                          weekSettings: 
                          to: 
                          subject: 
                          notifyOnTheFirstRun: false
                        scheduleSettings:
                          scheduleType: NotScheduled
                          timeZone:
                            timeZoneId: Pacific Standard Time
                            displayName: (UTC-08:00) Pacific Time (US & Canada)
                            utcOffset: -420
                          dailyScheduleSettings: 
                          monthlyScheduleSettings: 
                          periodicalScheduleSettings: 
                        totalComputersCount: 1
                        onlineComputersCount: 1
                        offlineComputersCount: 0
                      linuxDiscoveryRule:
                        instanceUid: f723d728-229b-4128-8160-2053673c4bdb
                        method: Manual
                        credentials:
                          - instanceUid: 00000003-0000-0000-0000-000000000000
                            username: root
                            password: ••••••
                            priority: 0
                            description: ''
                            sshPort: 22
                            elevateAccountPrivileges: false
                            addAccountToSudoersFile: false
                            useSuIfsudoFails: false
                            rootPassword: ••••••
                            sshPrivateKey: 
                            passphrase: 
                            type: LinuxBased
                        deploymentSettings:
                          isEnabled: false
                          backupPolicyUid: 
                          setReadOnlyAccess: true
                        _embedded:
                          discoveryRule: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Discovery
      summary: Create Import-Based Discovery Rule for Linux
      description: Creates a Linux rule based on a list of IP addresses and DNS names.
      operationId: CreateLinuxCustomDiscoveryRule
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Discovery rule configuration data.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinuxCustomDiscoveryRuleInput'
            example:
              name: Linux Custom Rule
              masterAgentUid: da463bea-d186-4a14-b809-4aba366b03e8
              hosts:
                - r2val
              credentials:
                - username: root
                  password: Password1
                  priority: 0
                  description: 
                  sshPort: 22
                  elevateAccountPrivileges: false
                  addAccountToSudoersFile: false
                  useSuIfsudoFails: false
                  rootPassword: '1'
                  sshPrivateKey: 
                  passphrase: 
                  type: LinuxBased
              filter: 
              notificationSettings: 
              deploymentSettings: 
              scheduleSettings:
                scheduleType: NotScheduled
                timeZone: 
                dailyScheduleSettings: 
                monthlyScheduleSettings: 
                periodicalScheduleSettings: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxCustomDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: b68fbe4d-9886-430a-8389-fc01da7b081b
                  hosts:
                    - r2val
                  _embedded:
                    discoveryRule: 
                    linuxDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/discovery/rules/linux/custom/{ruleUid}':
    get:
      tags:
        - Discovery
      summary: Get Import-Based Discovery Rule for Linux
      description: Returns a resource representation of a Linux discovery rule based on a list of IP addresses and DNS names.
      operationId: GetLinuxCustomDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxCustomDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: b68fbe4d-9886-430a-8389-fc01da7b081b
                  hosts:
                    - r2val
                    - r2val2
                  _embedded:
                    discoveryRule: 
                    linuxDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/LinuxCustomDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Discovery
      summary: Modify Import-Based Discovery Rule for Linux
      description: Modifies a Linux discovery rule based on a list of IP addresses and DNS names.
      operationId: PatchLinuxCustomDiscoveryRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: r2valRule
                path: /hosts/0
                op: replace
              - value: r2valRuleCopy
                path: /hosts/1
                op: add
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxCustomDiscoveryRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: b68fbe4d-9886-430a-8389-fc01da7b081b
                  hosts:
                    - r2val
                    - r2valCopy
                  _embedded:
                    discoveryRule: 
                    linuxDiscoveryRule: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/LinuxCustomDiscoveryRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /discovery/computers:
    get:
      tags:
        - Discovery
      summary: Get All Discovered Computers
      description: Returns a collection resource representation of all discovered computers.
      operationId: GetDiscoveryComputers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DiscoveredComputer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: f32ce967-a570-59b9-b747-c41fc3e4a776
                    ruleUid: 
                    managementAgentUid: c7b1a508-5fff-4bcb-a329-71f36ff581c9
                    discoveredTime: '2024-07-18T06:16:59.2917184+02:00'
                    backupAgentInstallationStatus: Installed
                    status: Online
                    backupAgentVersion: 5.0.0.4301
                    backupAgentManagementStatus: ManagedByConsole
                    info:
                      uniqueUid: f32ce967-a570-59b9-b747-c41fc3e4a776
                      biosUuid: 6bbf3b42-5585-2ba6-9df2-515b8e62e1ea
                      hostName: r2vaw2
                      fqdn: r2vaw2.tech.local
                      guestOs: Microsoft Windows 10 Pro
                      guestOsType: Workstation
                      guestOsVersion: 10.0.19045
                      guestOsSku: 48
                      platformType: vSphere
                      ipAddresses:
                        - 172.36.50.45
                        - 172.35.155.122
                      macAddresses:
                        - 00:0C:30:62:E1:EA
                        - 00:50:67:BF:C0:10
                      applications: [ ]
                  - instanceUid: 507e7e37-6594-60fe-b6f1-6a5ce1e6e1ef
                    ruleUid: cbd6196d-530a-4d66-9fbe-77e11d21b2c0
                    managementAgentUid: 47d1b349-41b5-4dbd-b1c6-db0d17b747e3
                    discoveredTime: '2024-07-18T05:06:16.5600000+02:00'
                    backupAgentInstallationStatus: Installed
                    status: Online
                    backupAgentVersion: 6.2.0.58
                    backupAgentManagementStatus: ManagedByConsole
                    info:
                      uniqueUid: b3833609-f2f8-073c-552b-605893c3b708
                      biosUuid: 07773b42-89fb-7227-9c6a-95e6908f25de
                      hostName: r2em
                      fqdn: r2em.tech.local
                      guestOs: Microsoft Windows Server 2016 Standard
                      guestOsType: Server
                      guestOsVersion: 10.0.14393
                      guestOsSku: 7
                      platformType: vSphere
                      ipAddresses:
                        - 172.35.155.100
                      macAddresses:
                        - 00:0C:30:8F:25:DE
                      applications:
                        - MicrosoftSqlServer
                  - instanceUid: 552ae9f6-cd05-ab5a-a240-94180da87f70
                    ruleUid: 
                    managementAgentUid: 1db0dfe4-c5f4-49cf-b7f2-b8a20f935254
                    discoveredTime: '2024-07-18T05:09:48.9270000+02:00'
                    backupAgentInstallationStatus: NotInstalled
                    status: Online
                    backupAgentVersion: 
                    backupAgentManagementStatus: Unknown
                    info:
                      uniqueUid: 552ae9f6-cd05-ab5a-a240-94180da87f70
                      biosUuid: 4d773b42-fe7e-7395-f994-ba211bda176c
                      hostName: r2SecondVBR
                      fqdn: r2SecondVBR.tech.local
                      guestOs: Microsoft Windows Server 2016 Standard
                      guestOsType: Server
                      guestOsVersion: 10.0.14393
                      guestOsSku: 7
                      platformType: vSphere
                      ipAddresses:
                        - 172.35.155.107
                      macAddresses:
                        - 00:0C:30:DA:17:6C
                      applications:
                        - MicrosoftSqlServer
                  - instanceUid: cc0eded8-f485-d0a3-8959-fd7ca3cfe887
                    ruleUid: 
                    managementAgentUid: 4ae8db95-8a4e-4a6a-b1fb-89a0d4b8aca5
                    discoveredTime: '2024-07-18T04:59:06.1230000+02:00'
                    backupAgentInstallationStatus: Installed
                    status: Online
                    backupAgentVersion: 5.0.0.4301
                    backupAgentManagementStatus: UnManaged
                    info:
                      uniqueUid: cc0eded8-f485-d0a3-8959-fd7ca3cfe887
                      biosUuid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                      hostName: r2vbr
                      fqdn: r2vbr.tech.local
                      guestOs: Microsoft Windows Server 2016 Standard
                      guestOsType: Server
                      guestOsVersion: 10.0.14393
                      guestOsSku: 7
                      platformType: vSphere
                      ipAddresses:
                        - 172.35.155.117
                      macAddresses:
                        - 00:0C:30:7E:7B:5C
                      applications:
                        - MicrosoftSqlServer
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /discovery/timeZones:
    get:
      tags:
        - Misc
      summary: Get Time Zones
      description: Returns a collection resource representation of all time zones.
      operationId: GetTimeZones
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TimeZone'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - timeZoneId: Dateline Standard Time
                    displayName: (UTC-12:00) International Date Line West
                    utcOffset: -720
                  - timeZoneId: UTC-11
                    displayName: (UTC-11:00) Coordinated Universal Time-11
                    utcOffset: -660
                  - timeZoneId: Aleutian Standard Time
                    displayName: (UTC-10:00) Aleutian Islands
                    utcOffset: -600
                  - timeZoneId: Hawaiian Standard Time
                    displayName: (UTC-10:00) Hawaii
                    utcOffset: -600
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/discovery/rules/{ruleUid}/computers':
    get:
      tags:
        - Discovery
      summary: Get All Computers Discovered with Specific Rule
      description: Returns a collection resource representation of all computers discovered with a rule with the specified UID.
      operationId: GetDiscoveryComputersByRule
      parameters:
        - name: ruleUid
          in: path
          description: Discovery rule UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DiscoveredComputer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 552ae9f6-cd05-ab5a-a240-94180da87f70
                    ruleUid: d263cee3-c9a4-4c99-b5fd-465a98722274
                    managementAgentUid: 1db0dfe4-c5f4-49cf-b7f2-b8a20f935254
                    discoveredTime: '2024-07-18T05:09:48.9270000+02:00'
                    backupAgentInstallationStatus: NotInstalled
                    status: Online
                    backupAgentVersion: 
                    backupAgentManagementStatus: Unknown
                    info:
                      uniqueUid: 552ae9f6-cd05-ab5a-a240-94180da87f70
                      biosUuid: 4d773b42-fe7e-7395-f994-ba211bda176c
                      hostName: r2SecondVBR
                      fqdn: r2SecondVBR.tech.local
                      guestOs: Microsoft Windows Server 2016 Standard
                      guestOsType: Server
                      guestOsVersion: 10.0.14393
                      guestOsSku: 7
                      platformType: vSphere
                      ipAddresses:
                        - 172.35.155.107
                      macAddresses:
                        - 00:0C:30:DA:17:6C
                      applications:
                        - MicrosoftSqlServer
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/discovery/computers/{computerUid}':
    get:
      tags:
        - Discovery
      summary: Get Discovered Computer
      description: Returns a resource representation of a discovered computer with the specified UID.
      operationId: GetDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DiscoveredComputer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: fac74f2a-9bd1-6ec0-8ef0-fce753b27641
                  ruleUid: cbd6196d-530a-4d66-9fbe-77e11d21b2c0
                  managementAgentUid: e9d4ee49-e632-4e75-bfd1-d914a8f3b91b
                  discoveredTime: '2024-07-18T06:03:32.6922953+02:00'
                  backupAgentInstallationStatus: Installed
                  status: Online
                  backupAgentVersion: 5.0.0.4301
                  backupAgentManagementStatus: ManagedByConsole
                  info:
                    uniqueUid: 4366e664-1ffc-fb5e-df10-b089157739f1
                    biosUuid: 39713b42-902b-1b9d-ea6e-26f7bf7e4aa7
                    hostName: r2vawServ2
                    fqdn: r2vawServ2.tech.local
                    guestOs: Microsoft Windows Server 2019 Standard
                    guestOsType: Server
                    guestOsVersion: 10.0.17763
                    guestOsSku: 7
                    platformType: vSphere
                    ipAddresses:
                      - 172.35.155.127
                    macAddresses:
                      - 00:0C:30:7E:4A:A7
                    applications: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/discovery/computers/{computerUid}/installBackupAgent':
    post:
      tags:
        - Deployment
      summary: Install Backup Agent on Discovered Computer
      description: "Deploys Veeam backup agent and management agent on a discovered computer with the specified UID. \nDeploys only the missing component if the other one is already installed.\n> To track the deployment progress, you can use the `WaitDeploymentTask` operation.\n"
      operationId: InstallBackupAgentOnDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Deployment configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeploymentConfiguration'
            example:
              backupPolicyUid: 70069387-2799-489b-9592-4b11c55012d7
              allowAutoRebootIfNeeded: true
              setReadOnlyAccess: true
              installCbtDriver: false
              credentials: 
              backupAgentSettings: 
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                    nullable: true
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: e7b6ecfd-c87c-46e4-89f1-cc1bba09bede
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/discovery/computers/{computerUid}/installLinuxBackupAgent':
    post:
      tags:
        - Deployment
      summary: Install Backup Agent on Discovered Linux Computer
      description: "Deploy Veeam backup agent and management agent on a discovered Linux computer with the specified UID. \nDeploys only the missing component if the other one is already installed.\n> To track the deployment progress, you can use the `WaitDeploymentTask` operation.\n"
      operationId: InstallLinuxBackupAgentOnDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinuxDeploymentConfiguration'
            example:
              backupPolicyUid: 
              setReadOnlyAccess: true
              credentials: 
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                    nullable: true
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: b6293d84-cbb0-4ab1-a222-453fe60c07ef
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/computers/{computerUid}/installBackupServer/iso/predownload':
    post:
      tags:
        - Preview Operations
      summary: Download Veeam Backup & Replication Installation File
      description: Downloads the Veeam Backup & Replication disk image file for further installation on a discovered computer with the specified UID.
      operationId: PredownloadBackupServerIsoOnDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Discovered computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Installation file download configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VbrIsoPredownloadInput'
            example:
              path: C:\ProgramData\Veeam\Veeam Availability Console
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DeploymentTaskResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  deploymentTaskUid: b68fbe4d-9886-430a-8389-fc01da7b081b
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/discovery/computers/{computerUid}/installBackupServer':
    post:
      tags:
        - Deployment
      summary: Install Veeam Backup & Replication on Discovered Computer
      description: "Installs Veeam Backup & Replication and management agent on a discovered computer with the specified UID. \n> Deploys only the missing component if the other one is already installed.\n> To track the deployment progress, you can use the `WaitDeploymentTask` operation.\n"
      operationId: InstallBackupServerOnDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Discovered computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Deployment configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VbrDeploymentConfigurationWithCredentials'
            example:
              configuration:
                distribution:
                  filePath: \\tech.local\tech\VSPC\VBR\13\Butler\VeeamBackup&Replication_13.iso
                  userName: tech\svc-datam
                  password: n_59=r2wc%k8Rx.X
                usePredownloadedIso: false
                answerXml: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<unattendedInstallationConfiguration bundle=\"VBR\" mode=\"install\">\r\n  <properties>\r\n\r\n    <!--License agreements-->\r\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\r\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\r\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\r\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\r\n\r\n    <!--License file-->\r\n    <property name=\"VBR_LICENSE_FILE\" value=\"\" />\r\n    <property name=\"VBR_LICENSE_AUTOUPDATE\" value=\"1\" />\r\n\r\n    <!--Service account-->\r\n    <property name=\"VBR_SERVICE_USER\" value=\"vspc1\\administrator\" />\r\n    <property name=\"VBR_SERVICE_PASSWORD\" value=\"Password1\" hidden=\"1\" />\r\n\r\n    <!--Database configuration-->\r\n    <property name=\"VBR_SQLSERVER_INSTALL\" value=\"0\" />\r\n    <property name=\"VBR_SQLSERVER_ENGINE\" value=\"1\" />\r\n    <property name=\"VBR_SQLSERVER_SERVER\" value=\"localhost\" />\r\n    <property name=\"VBR_SQLSERVER_DATABASE\" value=\"VeeamBackup\" />\r\n    <property name=\"VBR_SQLSERVER_AUTHENTICATION\" value=\"1\" />\r\n    <property name=\"VBR_SQLSERVER_USERNAME\" value=\"postgres\" />\r\n    <property name=\"VBR_SQLSERVER_PASSWORD\" value=\"Password1\" hidden=\"1\"/>\r\n\r\n    <!--Ports configuration-->\r\n    <property name=\"VBRC_SERVICE_PORT\" value=\"9393\" />\r\n    <property name=\"VBR_SERVICE_PORT\" value=\"9392\" />\r\n    <property name=\"VBR_SECURE_CONNECTIONS_PORT\" value=\"9401\" />\r\n    <property name=\"VBR_RESTSERVICE_PORT\" value=\"9419\" />\r\n\r\n    <!--Data locations-->\r\n    <property name=\"INSTALLDIR\" value=\"C:\\Program Files\\Veeam\\Backup and Replication\" />\r\n    <property name=\"VM_CATALOGPATH\" value=\"C:\\VBRCatalog\" />\r\n    <property name=\"VBR_IRCACHE\" value=\"C:\\ProgramData\\Veeam\\Backup\\IRCache\" />\r\n\r\n    <!--Automatic update settings-->\r\n    <property name=\"VBR_CHECK_UPDATES\" value=\"1\" />\r\n\r\n    <!--Plug-ins for Veeam Backup & Replication-->\r\n    <property name=\"AHV_INSTALL\" value=\"0\" />\r\n    <property name=\"RHV_INSTALL\" value=\"0\" />\r\n    <property name=\"AWS_INSTALL\" value=\"0\" />\r\n    <property name=\"AZURE_INSTALL\" value=\"0\" />\r\n    <property name=\"GCP_INSTALL\" value=\"0\" />\r\n    <property name=\"KASTEN_INSTALL\" value=\"0\" />\r\n\r\n  </properties>\r\n</unattendedInstallationConfiguration>"
                allowAutoReboot: true
                stopAllActivities: false
                useManagementAgentCredentials: false
                adminCredentials:
                  username: vspc1\administrator
                  password: Password1
              licenseSettings:
                licenseFileContent: BADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBAIPK6bojg0Tj/GcvQvg5iTFpmGbAdAFXRmOE4L5gDiYdTIPSMMJnGDITqF33lTX6nkVA5EQQy14xHziMvONEmHkIsNwudIthody3H07aiKp+fakIwlCAsFCC3TnSHBuc1+Xp0r8L9ILi9UNWmss/XdsXiaPZd03daAR2JLUzXp3zAgMBAAECgYB6sez4utkZyLqSAaDyYPZFh0430tHs8ah5PBrTga+KclpqmsOEKOCQtlZX7Qf/seupA6m/aHc8oLS1O+kaGCFtpwsFSnin/7f8vXXlDpFSZYfWO+1u7W0ub50E9zmSH/Uup4QFPQm20Vf45Frq1KTpJfkywMKf5jbNwaEcEmFvYQJBAONHojOa1sAijDMUqdq4sZdIhvnz9EdCalzNGO3GCWV0ptwLGh7V4zP0heQnl1aaz/Tt9QJ7RlOUZomNIc/0siMCQQCUclNptWWp72iG0QmwVEmvn9vs8nlunGbmBBeo++a/46T51qU2GQxRSSi1M8T8aXrxHwA8HFjd5T1PK17tBJnxAkEAtYfMlP0yU2oEovP5KppkNhoWvOPOE3CHtbGXHKsVbDR85bn0VfauLxw6KN46cVDbkpzRGfdOV4lrUKgp/ohKEwJAN62N1bdA83UlanObQ7TJkoLOFVh47WDiQ2HDkhExYkW7Ci5U9y577T0YdKZ/OwFBKJEtIF6tgkTKMxicWSABsQJBANKIj6wkNfnxn5EwniB1959xNS0PrpeaLVedEhW2HJKrBBzQKpfv0A3aGl1CwTAfld0lNiFJ7jMo1J6rlDHXw9QwggJeAgEAAoGBAJ5ghbXlirsjv5Fdn7BFruUfE1w48BPp0M3jUIQXsN3bB4nj5a5soCQjKVN80p9N5j+ns53Opd/7Zm6nBFhwJ+ahG2DkMvvN6ceS4gUQIJfQqcWJmJV8876I+MAr6WpA4yG2kBOntXw4kmB0dbNLsG5KRp96/Y30haSaJhicd27tAgMBAAECgYEAhOTZTdheoMlOZdv5sx/FsdxxkmD0ksEPxLOJTE3Uy1SO7tWcVNAxUCFw++0xjxr+qUs/HJvZ9Cgvu4nJy6vQzhNPwA09Yjw7IDVE73/wKydmdbI9sW4vSxpAHzP3khahqMCeAMjfoY1Ji/G0tiFtgUGY4cqhoM3eMGVyTfUroMECQQDLwmxU7vncEirPyRUj7S21ns9EIeKrgHChMk+wwdX3XBABCji5IKPNMheMCuOjzxFMLZxZQSNWBuRg57I9fdn7AkEAxvt2eRTcqHz7gNuKYP4bam9ODAVkVOkYFXSv2PjsohI1FALVBAffu7E0mJFbbs8aL1vO5wbr2bbYVuApjr+uNwJBAMgI6Dd9oPgnMbZpz4JEr3I1JX/a0F/UKT5nWQrLUNaVn/SVZ1h/ra+d9LX8Xr0LZQznXi3Vn+4tt/lWnYp2yg8CQHMTzyqrhAn1bkbRsS/zBcwCXzLYk3P/8qvF9kUXgVMiEIxoLuXL3/reuzpZJnXpVI17HSfDevdIpclojuA9vvUCQQCcxDFk/oAFnwIND7Xy5Jy0fzCCzvWW05mVCzYAnj2rKIw6y+q55jE6hExG1Z8Pfn36MS/cw1GmNlvKeq9hG+8b=
                licenseUid: 
                licenseSource: LicenseFileContent
              credentials:
                tenantName: alphaadmin
                tenantPassword: Password1
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: ae61e533-82c7-4cb6-a030-78ae589cf49d
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/discovery/computers/{computerUid}/scheduledTasks/installBackupServer':
    post:
      tags:
        - Deployment
      summary: Schedule Veeam Backup & Replication Installation on Discovered Computer
      description: "Creates a sheduled task that installs Veeam Backup & Replication and management agent on a discovered computer with the specified UID. \n> Deploys only the missing component if the other one is already installed.\n"
      operationId: ScheduleInstallBackupServerOnDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Discovered computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Deployment configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VbrScheduledDeploymentConfigurationWithCredentials'
            example:
              configuration:
                configuration:
                  distribution:
                    filePath: \\tech.local\tech\VSPC\VBR\13\Butler\VeeamBackup&Replication_13.iso
                    userName: tech\svc-datam
                    password: n_59=r2wc%k8Rx.X
                  usePredownloadedIso: false
                  answerXml: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<unattendedInstallationConfiguration bundle=\"VBR\" mode=\"install\">\r\n  <properties>\r\n\r\n    <!--License agreements-->\r\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\r\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\r\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\r\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\r\n\r\n    <!--License file-->\r\n    <property name=\"VBR_LICENSE_FILE\" value=\"\" />\r\n    <property name=\"VBR_LICENSE_AUTOUPDATE\" value=\"1\" />\r\n\r\n    <!--Service account-->\r\n    <property name=\"VBR_SERVICE_USER\" value=\"vspc1\\administrator\" />\r\n    <property name=\"VBR_SERVICE_PASSWORD\" value=\"Password1\" hidden=\"1\" />\r\n\r\n    <!--Database configuration-->\r\n    <property name=\"VBR_SQLSERVER_INSTALL\" value=\"0\" />\r\n    <property name=\"VBR_SQLSERVER_ENGINE\" value=\"1\" />\r\n    <property name=\"VBR_SQLSERVER_SERVER\" value=\"localhost\" />\r\n    <property name=\"VBR_SQLSERVER_DATABASE\" value=\"VeeamBackup\" />\r\n    <property name=\"VBR_SQLSERVER_AUTHENTICATION\" value=\"1\" />\r\n    <property name=\"VBR_SQLSERVER_USERNAME\" value=\"postgres\" />\r\n    <property name=\"VBR_SQLSERVER_PASSWORD\" value=\"Password1\" hidden=\"1\"/>\r\n\r\n    <!--Ports configuration-->\r\n    <property name=\"VBRC_SERVICE_PORT\" value=\"9393\" />\r\n    <property name=\"VBR_SERVICE_PORT\" value=\"9392\" />\r\n    <property name=\"VBR_SECURE_CONNECTIONS_PORT\" value=\"9401\" />\r\n    <property name=\"VBR_RESTSERVICE_PORT\" value=\"9419\" />\r\n\r\n    <!--Data locations-->\r\n    <property name=\"INSTALLDIR\" value=\"C:\\Program Files\\Veeam\\Backup and Replication\" />\r\n    <property name=\"VM_CATALOGPATH\" value=\"C:\\VBRCatalog\" />\r\n    <property name=\"VBR_IRCACHE\" value=\"C:\\ProgramData\\Veeam\\Backup\\IRCache\" />\r\n\r\n    <!--Automatic update settings-->\r\n    <property name=\"VBR_CHECK_UPDATES\" value=\"1\" />\r\n\r\n    <!--Plug-ins for Veeam Backup & Replication-->\r\n    <property name=\"AHV_INSTALL\" value=\"0\" />\r\n    <property name=\"RHV_INSTALL\" value=\"0\" />\r\n    <property name=\"AWS_INSTALL\" value=\"0\" />\r\n    <property name=\"AZURE_INSTALL\" value=\"0\" />\r\n    <property name=\"GCP_INSTALL\" value=\"0\" />\r\n    <property name=\"KASTEN_INSTALL\" value=\"0\" />\r\n\r\n  </properties>\r\n</unattendedInstallationConfiguration>"
                  allowAutoReboot: true
                  stopAllActivities: false
                  useManagementAgentCredentials: false
                  adminCredentials:
                    username: vspc1\administrator
                    password: Password1
                licenseSettings:
                  licenseFileContent: BADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBAIPK6bojg0Tj/GcvQvg5iTFpmGbAdAFXRmOE4L5gDiYdTIPSMMJnGDITqF33lTX6nkVA5EQQy14xHziMvONEmHkIsNwudIthody3H07aiKp+fakIwlCAsFCC3TnSHBuc1+Xp0r8L9ILi9UNWmss/XdsXiaPZd03daAR2JLUzXp3zAgMBAAECgYB6sez4utkZyLqSAaDyYPZFh0430tHs8ah5PBrTga+KclpqmsOEKOCQtlZX7Qf/seupA6m/aHc8oLS1O+kaGCFtpwsFSnin/7f8vXXlDpFSZYfWO+1u7W0ub50E9zmSH/Uup4QFPQm20Vf45Frq1KTpJfkywMKf5jbNwaEcEmFvYQJBAONHojOa1sAijDMUqdq4sZdIhvnz9EdCalzNGO3GCWV0ptwLGh7V4zP0heQnl1aaz/Tt9QJ7RlOUZomNIc/0siMCQQCUclNptWWp72iG0QmwVEmvn9vs8nlunGbmBBeo++a/46T51qU2GQxRSSi1M8T8aXrxHwA8HFjd5T1PK17tBJnxAkEAtYfMlP0yU2oEovP5KppkNhoWvOPOE3CHtbGXHKsVbDR85bn0VfauLxw6KN46cVDbkpzRGfdOV4lrUKgp/ohKEwJAN62N1bdA83UlanObQ7TJkoLOFVh47WDiQ2HDkhExYkW7Ci5U9y577T0YdKZ/OwFBKJEtIF6tgkTKMxicWSABsQJBANKIj6wkNfnxn5EwniB1959xNS0PrpeaLVedEhW2HJKrBBzQKpfv0A3aGl1CwTAfld0lNiFJ7jMo1J6rlDHXw9QwggJeAgEAAoGBAJ5ghbXlirsjv5Fdn7BFruUfE1w48BPp0M3jUIQXsN3bB4nj5a5soCQjKVN80p9N5j+ns53Opd/7Zm6nBFhwJ+ahG2DkMvvN6ceS4gUQIJfQqcWJmJV8876I+MAr6WpA4yG2kBOntXw4kmB0dbNLsG5KRp96/Y30haSaJhicd27tAgMBAAECgYEAhOTZTdheoMlOZdv5sx/FsdxxkmD0ksEPxLOJTE3Uy1SO7tWcVNAxUCFw++0xjxr+qUs/HJvZ9Cgvu4nJy6vQzhNPwA09Yjw7IDVE73/wKydmdbI9sW4vSxpAHzP3khahqMCeAMjfoY1Ji/G0tiFtgUGY4cqhoM3eMGVyTfUroMECQQDLwmxU7vncEirPyRUj7S21ns9EIeKrgHChMk+wwdX3XBABCji5IKPNMheMCuOjzxFMLZxZQSNWBuRg57I9fdn7AkEAxvt2eRTcqHz7gNuKYP4bam9ODAVkVOkYFXSv2PjsohI1FALVBAffu7E0mJFbbs8aL1vO5wbr2bbYVuApjr+uNwJBAMgI6Dd9oPgnMbZpz4JEr3I1JX/a0F/UKT5nWQrLUNaVn/SVZ1h/ra+d9LX8Xr0LZQznXi3Vn+4tt/lWnYp2yg8CQHMTzyqrhAn1bkbRsS/zBcwCXzLYk3P/8qvF9kUXgVMiEIxoLuXL3/reuzpZJnXpVI17HSfDevdIpclojuA9vvUCQQCcxDFk/oAFnwIND7Xy5Jy0fzCCzvWW05mVCzYAnj2rKIw6y+q55jE6hExG1Z8Pfn36MS/cw1GmNlvKeq9hG+8b=
                  licenseUid: 
                  licenseSource: LicenseFileContent
                credentials:
                  tenantName: alphaadmin
                  tenantPassword: Password1
              schedule:
                dateTime: '2025-07-24T02:55:26.3617936+02:00'
        required: true
      responses:
        '200':
          description: Resource representation of a scheduled task.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ScheduledDeployTaskResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  scheduledTaskUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  taskUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/computers/{computerUid}/installVOneServer/iso/predownload':
    post:
      tags:
        - Preview Operations
      summary: Download Veeam ONE Installation File
      description: Downloads the Veeam ONE disk image file for further installation on a discovered computer with the specified UID.
      operationId: PredownloadVOneServerIsoOnDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Discovered computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Installation file download configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VOneIsoPredownloadInput'
            example:
              path: \\tech.local\tech\VSPC\VBR\13\Butler\VeeamONE_13.0.0.5457_20250723.iso
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DeploymentTaskResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  deploymentTaskUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/discovery/computers/{computerUid}/installVOneServer':
    post:
      tags:
        - Deployment
      summary: Install Veeam ONE on Discovered Computer
      description: "Installs Veeam ONE and management agent on a discovered computer with the specified UID. \n> Deploys only the missing component if the other one is already installed.\n> To track the deployment progress, you can use the `WaitDeploymentTask` operation.\n"
      operationId: InstallVOneServerOnDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Discovered computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Deployment configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VOneDeploymentConfigurationWithCredentials'
            example:
              configuration:
                distribution:
                  filePath: \\tech.local\tech\VSPC\VBR\13\Butler\VeeamONE_13.0.0.5457_20250723.iso
                  userName: vspc\admin
                  password: Password1
                usePredownloadedIso: 
                answerXml: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<unattendedInstallationConfiguration bundle=\"Vo\" mode=\"install\" version=\"1.0\">\r\n  <properties>\r\n\r\n    <!--License agreements-->\r\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\r\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\r\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\r\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\r\n\r\n    <!--License file-->\r\n    <property name=\"VO_LICENSE_FILE\" value=\"\" />\r\n    <property name=\"VO_LICENSE_AUTOUPDATE\" value=\"1\" />\r\n\r\n    <!--Standalone components-->\r\n    <property name=\"VO_SERVER_COMPONENT\" value=\"1\" />\r\n    <property name=\"VO_WEB_COMPONENT\" value=\"1\" />\r\n    <property name=\"VO_CLIENT_COMPONENT\" value=\"1\" />\r\n\r\n    <!--Service account-->\r\n    <property name=\"VO_SERVICE_USER\" value=\"vspc\\administrator\" />\r\n    <property name=\"VO_SERVICE_PASSWORD\" value=\"Password1\" hidden=\"1\" />\r\n\r\n    <!--Database configuration-->\r\n    <property name=\"VO_SQLSERVER_INSTALL\" value=\"1\" />\r\n    <property name=\"VO_SQLSERVER_SERVER\" value=\"localhost\\VEEAMSQL2017\" />\r\n    <property name=\"VO_SQLSERVER_DATABASE\" value=\"VeeamONE\" />\r\n    <property name=\"VO_SQLSERVER_AUTHENTICATION\" value=\"0\" />\r\n    <property name=\"VO_SQLSERVER_USERNAME\" value=\"\" />\r\n    <property name=\"VO_SQLSERVER_PASSWORD\" value=\"\" hidden=\"1\"/>\r\n\r\n    <!-- Reporting database configuration-->\r\n    <property name=\"VO_POSTGRESQL_INSTALL\" value=\"1\" />\r\n    <property name=\"VO_POSTGRESQL_SERVER\" value=\"localhost\" />\r\n    <property name=\"VO_POSTGRESQL_PORT\" value=\"5432\" />\r\n    <property name=\"VO_POSTGRESQL_DATABASE\" value=\"VeeamONEWarehouse\" />\r\n    <property name=\"VO_POSTGRESQL_AUTHENTICATION\" value=\"0\" />\r\n    <property name=\"VO_POSTGRESQL_USERNAME\" value=\"postgres\" />\r\n    <property name=\"VO_POSTGRESQL_PASSWORD\" value=\"\" hidden=\"1\"/>\r\n\r\n    <!--Data collection mode-->\r\n    <property name=\"VO_INSTALLATION_TYPE\" value=\"2\" />\r\n\r\n    <!--Ports configuration-->\r\n    <property name=\"VO_MONITORING_SERVICE_PORT\" value=\"2714\" />\r\n    <property name=\"VO_REPORTING_SERVICE_PORT\" value=\"2742\" />\r\n    <property name=\"VO_CACHING_SERVICE_PORT\" value=\"2743\" />\r\n    <property name=\"VO_INTERNAL_WEB_API_PORT\" value=\"2741\"  />\r\n    <property name=\"VO_WEBSITE_PORT\" value=\"1239\" />\r\n    <property name=\"VO_AGENT_SERVICE_PORT\" value=\"2805\" />\r\n\r\n    <!--Certificate configuration-->\r\n    <property name=\"VO_CERTIFICATE_THUMBPRINT\" value=\"\" />\r\n\r\n    <!--Data locations-->\r\n    <property name=\"INSTALLDIR\" value=\"C:\\Program Files\\Veeam\\Veeam ONE\" />\r\n    <property name=\"VO_PERFCACHE\" value=\"C:\\PerfCache\" />\r\n\r\n    <!--Server connection-->\r\n    <property name=\"VO_CONNECTION_SERVER_NAME\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_WEB_API_PORT\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_USER\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_PASSWORD\" value=\"\" hidden=\"1\" />\r\n\r\n    <!--Setup settings-->\r\n    <property name=\"REBOOT_IF_REQUIRED\" value=\"0\" />\r\n    <property name=\"DONT_ADD_USER_TO_ADMINS\" value=\"1\" />\r\n\r\n  </properties>\r\n</unattendedInstallationConfiguration>"
                allowAutoReboot: true
                stopAllActivities: 
                useManagementAgentCredentials: 
                adminCredentials:
                  username: vspc\administrator
                  password: Password1
              licenseSettings:
                licenseFileContent: BADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBAIPK6bojg0Tj/GcvQvg5iTFpmGbAdAFXRmOE4L5gDiYdTIPSMMJnGDITqF33lTX6nkVA5EQQy14xHziMvONEmHkIsNwudIthody3H07aiKp+fakIwlCAsFCC3TnSHBuc1+Xp0r8L9ILi9UNWmss/XdsXiaPZd03daAR2JLUzXp3zAgMBAAECgYB6sez4utkZyLqSAaDyYPZFh0430tHs8ah5PBrTga+KclpqmsOEKOCQtlZX7Qf/seupA6m/aHc8oLS1O+kaGCFtpwsFSnin/7f8vXXlDpFSZYfWO+1u7W0ub50E9zmSH/Uup4QFPQm20Vf45Frq1KTpJfkywMKf5jbNwaEcEmFvYQJBAONHojOa1sAijDMUqdq4sZdIhvnz9EdCalzNGO3GCWV0ptwLGh7V4zP0heQnl1aaz/Tt9QJ7RlOUZomNIc/0siMCQQCUclNptWWp72iG0QmwVEmvn9vs8nlunGbmBBeo++a/46T51qU2GQxRSSi1M8T8aXrxHwA8HFjd5T1PK17tBJnxAkEAtYfMlP0yU2oEovP5KppkNhoWvOPOE3CHtbGXHKsVbDR85bn0VfauLxw6KN46cVDbkpzRGfdOV4lrUKgp/ohKEwJAN62N1bdA83UlanObQ7TJkoLOFVh47WDiQ2HDkhExYkW7Ci5U9y577T0YdKZ/OwFBKJEtIF6tgkTKMxicWSABsQJBANKIj6wkNfnxn5EwniB1959xNS0PrpeaLVedEhW2HJKrBBzQKpfv0A3aGl1CwTAfld0lNiFJ7jMo1J6rlDHXw9QwggJeAgEAAoGBAJ5ghbXlirsjv5Fdn7BFruUfE1w48BPp0M3jUIQXsN3bB4nj5a5soCQjKVN80p9N5j+ns53Opd/7Zm6nBFhwJ+ahG2DkMvvN6ceS4gUQIJfQqcWJmJV8876I+MAr6WpA4yG2kBOntXw4kmB0dbNLsG5KRp96/Y30haSaJhicd27tAgMBAAECgYEAhOTZTdheoMlOZdv5sx/FsdxxkmD0ksEPxLOJTE3Uy1SO7tWcVNAxUCFw++0xjxr+qUs/HJvZ9Cgvu4nJy6vQzhNPwA09Yjw7IDVE73/wKydmdbI9sW4vSxpAHzP3khahqMCeAMjfoY1Ji/G0tiFtgUGY4cqhoM3eMGVyTfUroMECQQDLwmxU7vncEirPyRUj7S21ns9EIeKrgHChMk+wwdX3XBABCji5IKPNMheMCuOjzxFMLZxZQSNWBuRg57I9fdn7AkEAxvt2eRTcqHz7gNuKYP4bam9ODAVkVOkYFXSv2PjsohI1FALVBAffu7E0mJFbbs8aL1vO5wbr2bbYVuApjr+uNwJBAMgI6Dd9oPgnMbZpz4JEr3I1JX/a0F/UKT5nWQrLUNaVn/SVZ1h/ra+d9LX8Xr0LZQznXi3Vn+4tt/lWnYp2yg8CQHMTzyqrhAn1bkbRsS/zBcwCXzLYk3P/8qvF9kUXgVMiEIxoLuXL3/reuzpZJnXpVI17HSfDevdIpclojuA9vvUCQQCcxDFk/oAFnwIND7Xy5Jy0fzCCzvWW05mVCzYAnj2rKIw6y+q55jE6hExG1Z8Pfn36MS/cw1GmNlvKeq9hG+8b=
                licenseUid: 
                licenseSource: LicenseFileContent
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: ae61e533-82c7-4cb6-a030-78ae589cf49d
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/discovery/computers/{computerUid}/scheduledTasks/installVOneServer':
    post:
      tags:
        - Deployment
      summary: Schedule Veeam ONE Installation on Discovered Computer
      description: "Creates a sheduled task that installs Veeam ONE and management agent on a discovered computer with the specified UID. \n> Deploys only the missing component if the other one is already installed.\n"
      operationId: ScheduleInstallVOneServerOnDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Discovered computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Deployment configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VOneScheduledDeploymentConfigurationWithCredentials'
            example:
              configuration:
                configuration:
                  distribution:
                    filePath: \\tech.local\tech\VSPC\VBR\13\Butler\VeeamONE_13.0.0.5457_20250723.iso
                    userName: vspc\admin
                    password: Password1
                  usePredownloadedIso: 
                  answerXml: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<unattendedInstallationConfiguration bundle=\"Vo\" mode=\"install\" version=\"1.0\">\r\n  <properties>\r\n\r\n    <!--License agreements-->\r\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\r\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\r\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\r\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\r\n\r\n    <!--License file-->\r\n    <property name=\"VO_LICENSE_FILE\" value=\"\" />\r\n    <property name=\"VO_LICENSE_AUTOUPDATE\" value=\"1\" />\r\n\r\n    <!--Standalone components-->\r\n    <property name=\"VO_SERVER_COMPONENT\" value=\"1\" />\r\n    <property name=\"VO_WEB_COMPONENT\" value=\"1\" />\r\n    <property name=\"VO_CLIENT_COMPONENT\" value=\"1\" />\r\n\r\n    <!--Service account-->\r\n    <property name=\"VO_SERVICE_USER\" value=\"vspc\\administrator\" />\r\n    <property name=\"VO_SERVICE_PASSWORD\" value=\"Password1\" hidden=\"1\" />\r\n\r\n    <!--Database configuration-->\r\n    <property name=\"VO_SQLSERVER_INSTALL\" value=\"1\" />\r\n    <property name=\"VO_SQLSERVER_SERVER\" value=\"localhost\\VEEAMSQL2017\" />\r\n    <property name=\"VO_SQLSERVER_DATABASE\" value=\"VeeamONE\" />\r\n    <property name=\"VO_SQLSERVER_AUTHENTICATION\" value=\"0\" />\r\n    <property name=\"VO_SQLSERVER_USERNAME\" value=\"\" />\r\n    <property name=\"VO_SQLSERVER_PASSWORD\" value=\"\" hidden=\"1\"/>\r\n\r\n    <!-- Reporting database configuration-->\r\n    <property name=\"VO_POSTGRESQL_INSTALL\" value=\"1\" />\r\n    <property name=\"VO_POSTGRESQL_SERVER\" value=\"localhost\" />\r\n    <property name=\"VO_POSTGRESQL_PORT\" value=\"5432\" />\r\n    <property name=\"VO_POSTGRESQL_DATABASE\" value=\"VeeamONEWarehouse\" />\r\n    <property name=\"VO_POSTGRESQL_AUTHENTICATION\" value=\"0\" />\r\n    <property name=\"VO_POSTGRESQL_USERNAME\" value=\"postgres\" />\r\n    <property name=\"VO_POSTGRESQL_PASSWORD\" value=\"\" hidden=\"1\"/>\r\n\r\n    <!--Data collection mode-->\r\n    <property name=\"VO_INSTALLATION_TYPE\" value=\"2\" />\r\n\r\n    <!--Ports configuration-->\r\n    <property name=\"VO_MONITORING_SERVICE_PORT\" value=\"2714\" />\r\n    <property name=\"VO_REPORTING_SERVICE_PORT\" value=\"2742\" />\r\n    <property name=\"VO_CACHING_SERVICE_PORT\" value=\"2743\" />\r\n    <property name=\"VO_INTERNAL_WEB_API_PORT\" value=\"2741\"  />\r\n    <property name=\"VO_WEBSITE_PORT\" value=\"1239\" />\r\n    <property name=\"VO_AGENT_SERVICE_PORT\" value=\"2805\" />\r\n\r\n    <!--Certificate configuration-->\r\n    <property name=\"VO_CERTIFICATE_THUMBPRINT\" value=\"\" />\r\n\r\n    <!--Data locations-->\r\n    <property name=\"INSTALLDIR\" value=\"C:\\Program Files\\Veeam\\Veeam ONE\" />\r\n    <property name=\"VO_PERFCACHE\" value=\"C:\\PerfCache\" />\r\n\r\n    <!--Server connection-->\r\n    <property name=\"VO_CONNECTION_SERVER_NAME\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_WEB_API_PORT\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_USER\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_PASSWORD\" value=\"\" hidden=\"1\" />\r\n\r\n    <!--Setup settings-->\r\n    <property name=\"REBOOT_IF_REQUIRED\" value=\"0\" />\r\n    <property name=\"DONT_ADD_USER_TO_ADMINS\" value=\"1\" />\r\n\r\n  </properties>\r\n</unattendedInstallationConfiguration>"
                  allowAutoReboot: true
                  stopAllActivities: 
                  useManagementAgentCredentials: 
                  adminCredentials:
                    username: vspc\administrator
                    password: Password1
                licenseSettings:
                  licenseFileContent: BADANBgkqhkiG9w0BAQEFAASCAmEwggJdAgEAAoGBAIPK6bojg0Tj/GcvQvg5iTFpmGbAdAFXRmOE4L5gDiYdTIPSMMJnGDITqF33lTX6nkVA5EQQy14xHziMvONEmHkIsNwudIthody3H07aiKp+fakIwlCAsFCC3TnSHBuc1+Xp0r8L9ILi9UNWmss/XdsXiaPZd03daAR2JLUzXp3zAgMBAAECgYB6sez4utkZyLqSAaDyYPZFh0430tHs8ah5PBrTga+KclpqmsOEKOCQtlZX7Qf/seupA6m/aHc8oLS1O+kaGCFtpwsFSnin/7f8vXXlDpFSZYfWO+1u7W0ub50E9zmSH/Uup4QFPQm20Vf45Frq1KTpJfkywMKf5jbNwaEcEmFvYQJBAONHojOa1sAijDMUqdq4sZdIhvnz9EdCalzNGO3GCWV0ptwLGh7V4zP0heQnl1aaz/Tt9QJ7RlOUZomNIc/0siMCQQCUclNptWWp72iG0QmwVEmvn9vs8nlunGbmBBeo++a/46T51qU2GQxRSSi1M8T8aXrxHwA8HFjd5T1PK17tBJnxAkEAtYfMlP0yU2oEovP5KppkNhoWvOPOE3CHtbGXHKsVbDR85bn0VfauLxw6KN46cVDbkpzRGfdOV4lrUKgp/ohKEwJAN62N1bdA83UlanObQ7TJkoLOFVh47WDiQ2HDkhExYkW7Ci5U9y577T0YdKZ/OwFBKJEtIF6tgkTKMxicWSABsQJBANKIj6wkNfnxn5EwniB1959xNS0PrpeaLVedEhW2HJKrBBzQKpfv0A3aGl1CwTAfld0lNiFJ7jMo1J6rlDHXw9QwggJeAgEAAoGBAJ5ghbXlirsjv5Fdn7BFruUfE1w48BPp0M3jUIQXsN3bB4nj5a5soCQjKVN80p9N5j+ns53Opd/7Zm6nBFhwJ+ahG2DkMvvN6ceS4gUQIJfQqcWJmJV8876I+MAr6WpA4yG2kBOntXw4kmB0dbNLsG5KRp96/Y30haSaJhicd27tAgMBAAECgYEAhOTZTdheoMlOZdv5sx/FsdxxkmD0ksEPxLOJTE3Uy1SO7tWcVNAxUCFw++0xjxr+qUs/HJvZ9Cgvu4nJy6vQzhNPwA09Yjw7IDVE73/wKydmdbI9sW4vSxpAHzP3khahqMCeAMjfoY1Ji/G0tiFtgUGY4cqhoM3eMGVyTfUroMECQQDLwmxU7vncEirPyRUj7S21ns9EIeKrgHChMk+wwdX3XBABCji5IKPNMheMCuOjzxFMLZxZQSNWBuRg57I9fdn7AkEAxvt2eRTcqHz7gNuKYP4bam9ODAVkVOkYFXSv2PjsohI1FALVBAffu7E0mJFbbs8aL1vO5wbr2bbYVuApjr+uNwJBAMgI6Dd9oPgnMbZpz4JEr3I1JX/a0F/UKT5nWQrLUNaVn/SVZ1h/ra+d9LX8Xr0LZQznXi3Vn+4tt/lWnYp2yg8CQHMTzyqrhAn1bkbRsS/zBcwCXzLYk3P/8qvF9kUXgVMiEIxoLuXL3/reuzpZJnXpVI17HSfDevdIpclojuA9vvUCQQCcxDFk/oAFnwIND7Xy5Jy0fzCCzvWW05mVCzYAnj2rKIw6y+q55jE6hExG1Z8Pfn36MS/cw1GmNlvKeq9hG+8b=
                  licenseUid: 
                  licenseSource: LicenseFileContent
              schedule:
                dateTime: '2025-07-24T02:55:26.3617936+02:00'
        required: true
      responses:
        '200':
          description: Resource representation of a scheduled task.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ScheduledDeployTaskResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  scheduledTaskUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  taskUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/discovery/computers/{computerUid}/reboot':
    post:
      tags:
        - Discovery
      summary: Reboot Discovered Computer
      description: Reboots Veeam backup agent on a discovered computer with the specified UID. Returns positive response when management agent receives the reboot task and not when the task is executed.
      operationId: RebootDiscoveryComputer
      parameters:
        - name: computerUid
          in: path
          description: Computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/managementAgents/{managementAgentUid}/adTree/discover':
    post:
      tags:
        - Preview Operations
      summary: Get Active Directory Infrastructure
      description: Returns a collection resource representation of organizational units of an Active Directory infrastructure where a management agent with the specified UID is installed.
      operationId: DiscoverActiveDirectoryTree
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DiscoverActiveDirectoryTreeInput'
            example:
              discoveryRuleUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              serviceAccount:
                userName: admin
                password: Password1
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ActiveDirectoryTreeNode'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: '10'
                    name: srv2
                    children: 
                    type: OrganizationalUnit
                    leaf: false
                  - id: '12'
                    name: srv5
                    children: 
                    type: OrganizationalUnit
                    leaf: false
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/discovery/computers/{computerUid}/scheduledDeploymentTasks':
    get:
      tags:
        - Deployment
      summary: Get All Deployment Tasks Scheduled for Computer
      description: Returns a collection resource representation of all deployment tasks scheduled for a computer with the specified UID.
      operationId: GetScheduledDeploymentTasksForComputer
      parameters:
        - name: computerUid
          in: path
          description: Computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ScheduledComputerDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - taskUid: cbd26256-1433-41a5-984a-d3146d62f3df
                    dateTime: '2023-11-17T20:44:54.3959225+01:00'
                    taskType: PatchVbr
                  - taskUid: 491a2482-2d20-43d2-b199-d54fdde8dfee
                    dateTime: '2023-11-22T03:50:09.0863288+01:00'
                    taskType: UpgradeVbr
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/managementAgents/{managementAgentUid}/scheduledDeploymentTasks':
    get:
      tags:
        - Deployment
      summary: Get All Deployment Tasks Scheduled for Management Agent
      description: Returns a collection resource representation of all deployment tasks scheduled for a management agent with the specified UID.
      operationId: GetScheduledDeploymentTasksForAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ScheduledManagementAgentDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - taskUid: cbd26256-1433-41a5-984a-d3146d62f3df
                    dateTime: '2023-11-17T20:44:54.3959225+01:00'
                    taskType: PatchVbr
                  - taskUid: 491a2482-2d20-43d2-b199-d54fdde8dfee
                    dateTime: '2023-11-22T03:50:09.0863288+01:00'
                    taskType: UpgradeVbr
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/discovery/computers/{computerUid}/scheduledDeploymentTasks/{taskUid}':
    get:
      tags:
        - Deployment
      summary: Get Computer Scheduled Deployment Task
      description: Returns a resource representation of a computer scheduled deployment task with the specified UID.
      operationId: GetScheduledDeploymentTaskForComputer
      parameters:
        - name: computerUid
          in: path
          description: Computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: taskUid
          in: path
          description: Deployment task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ScheduledComputerDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: 580e9a9c-a44f-45ac-9dfd-a9dc13972093
                  dateTime: '2023-11-22T03:50:09.0863288+01:00'
                  taskType: patchVbr
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ScheduledComputerDeploymentTask'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Deployment
      summary: Modify Computer Scheduled Deployment Task
      description: Modifies a computer scheduled deployment task with the specified UID.
      operationId: PatchScheduledDeploymentTaskForComputer
      parameters:
        - name: computerUid
          in: path
          description: Computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: taskUid
          in: path
          description: Deployment task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: '2023-11-22T03:50:09.0863288+01:00'
                path: /DateTime
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ScheduledComputerDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: 580e9a9c-a44f-45ac-9dfd-a9dc13972093
                  dateTime: '2023-11-22T03:50:09.0863288+01:00'
                  taskType: patchVbr
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ScheduledComputerDeploymentTask'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    delete:
      tags:
        - Deployment
      summary: Delete Computer Scheduled Deployment Task
      description: Deletes a computer scheduled deployment task with the specified UID.
      operationId: DeleteScheduledDeploymentTaskForComputer
      parameters:
        - name: computerUid
          in: path
          description: Computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: taskUid
          in: path
          description: Deployment task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/managementAgents/{managementAgentUid}/scheduledDeploymentTasks/{taskUid}':
    get:
      tags:
        - Deployment
      summary: Get Management Agent Scheduled Deployment Task
      description: Returns a resource representation of a management agent scheduled deployment task with the specified UID.
      operationId: GetScheduledDeploymentTaskForAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: taskUid
          in: path
          description: Deployment task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ScheduledManagementAgentDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: 7a76bcfc-9d43-440b-9c74-7b2167ad8885
                  dateTime: '2023-11-17T21:06:28.7905497+01:00'
                  taskType: UpgradeVbr
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ScheduledManagementAgentDeploymentTask'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Deployment
      summary: Modify Management Agent Scheduled Deployment Task
      description: Modifies a management agent scheduled deployment task with the specified UID.
      operationId: PatchScheduledDeploymentTaskForAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: taskUid
          in: path
          description: Deployment task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: '2023-02-01T08:30:00.0000000+01:00'
                path: /dateTime
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ScheduledManagementAgentDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: 3b60fcb4-6b92-4dc4-91e2-09a6a91222f4
                  dateTime: '2023-02-01T08:30:00.0000000+01:00'
                  taskType: deployVbr
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ScheduledManagementAgentDeploymentTask'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    delete:
      tags:
        - Deployment
      summary: Delete Management Agent Scheduled Deployment Task
      description: Deletes a management agent scheduled deployment task with the specified UID.
      operationId: DeleteScheduledDeploymentTaskForAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: taskUid
          in: path
          description: Deployment task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/discovery/computers/{computerUid}/scheduledDeploymentTasks/{taskUid}/start':
    post:
      tags:
        - Deployment
      summary: Start Computer Scheduled Deployment Task
      description: Starts a computer scheduled deployment task with the specified UID.
      operationId: StartScheduledDeploymentTaskForComputer
      parameters:
        - name: computerUid
          in: path
          description: Computer UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: taskUid
          in: path
          description: Scheduled task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                    nullable: true
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: cfce7c6e-3cea-4fe6-bf5b-6cdd6951ae75
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/managementAgents/{managementAgentUid}/scheduledDeploymentTasks/{taskUid}/start':
    post:
      tags:
        - Deployment
      summary: Start Management Agent Scheduled Deployment Task
      description: Starts a management agent scheduled deployment task with the specified UID.
      operationId: StartScheduledDeploymentTaskForAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: taskUid
          in: path
          description: Scheduled task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                    nullable: true
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: 733ccd0c-f40e-4348-96de-ed9a120c2667
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /infrastructure/unverifiedAgents:
    get:
      tags:
        - Management Agents
      summary: Get All Unverified Management Agents
      description: Returns a collection resource representation of all unverified management agents.
      operationId: GetUnverifiedAgents
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UnverifiedAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: eada2907-7415-4d64-a425-2b0fabf6e745
                    organizationUid: 988b3138-3968-4743-a245-c0e9cff21332
                    hostName: lrsfvaww10
                    registrationTime: '2021-08-18T12:59:43.1121054+02:00'
                    tag: ''
                    rejectReason: Failed to set company Alpha to the agent. The management agent is unavailable. Verify the agent state and try again.
                    type: Client
                    status: Inaccessible
                    statusMessage: Failed to set company Alpha to the agent. The management agent is unavailable. Verify the agent state and try again.
                    platformType: Windows
                  - instanceUid: b2206500-bdb8-4525-a72a-20893943d045
                    organizationUid: 79c9b4a5-933c-4dde-88c2-8f0c04890b06
                    hostName: psw10-19h2-vm01
                    registrationTime: '2021-08-18T12:59:34.6551800+02:00'
                    tag: ''
                    rejectReason: Failed to set company Beta to the agent. The management agent is unavailable. Verify the agent state and try again.
                    type: Client
                    status: Inaccessible
                    statusMessage: Failed to set company Beta to the agent. The management agent is unavailable. Verify the agent state and try again.
                    platformType: Windows
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/unverifiedAgents/{unverifiedAgentUid}':
    get:
      tags:
        - Management Agents
      summary: Get Unverified Management Agent
      description: Returns a resource representation of an unverified management agent with the specified UID.
      operationId: GetUnverifiedAgent
      parameters:
        - name: unverifiedAgentUid
          in: path
          description: Unverified management agent UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/UnverifiedAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: eada2907-7415-4d64-a425-2b0fabf6e745
                  organizationUid: 988b3138-3968-4743-a245-c0e9cff21332
                  hostName: lrsfvaww10
                  registrationTime: '2021-08-18T12:59:43.1121054+02:00'
                  tag: ''
                  rejectReason: Failed to set company Alpha to the agent. The management agent is unavailable. Verify the agent state and try again.
                  type: Client
                  status: Inaccessible
                  statusMessage: Failed to set company Alpha to the agent. The management agent is unavailable. Verify the agent state and try again.
                  platformType: Windows
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/UnverifiedAgent'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/unverifiedAgents/{unverifiedAgentUid}/accept':
    post:
      tags:
        - Management Agents
      summary: Accept Unverified Management Agent
      description: Accepts an unverified management agent with the specified UID.
      operationId: AcceptUnverifiedAgent
      parameters:
        - name: unverifiedAgentUid
          in: path
          description: Unverified management agent UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: organizationUid
          in: query
          description: Organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: cloudTenantUid
          in: query
          description: Veeam Cloud Connect tenant UID.
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/managementAgents:
    get:
      tags:
        - Management Agents
      summary: Get All Management Agents
      description: Returns a collection resource representation of all management agents.
      operationId: GetManagementAgents
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ManagementAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c7b1a508-5fff-4bcb-a329-71f36ff581c9
                    locationUid: 29d16c61-7298-4486-92ce-cb736797095f
                    organizationUid: 14c012bd-f4b0-4445-a75b-9346158cbc82
                    hostName: r2vaw2
                    friendlyName: r2vaw2
                    lastHeartbeatTime: '2024-07-18T15:02:21.0879915+02:00'
                    version: 8.1.0.20593
                    discoveryTime: '2024-07-18T06:16:59.2917184+02:00'
                    tag: ''
                    status: Healthy
                    type: Client
                    computerInfo:
                      uniqueUid: f32ce967-a570-59b9-b747-c41fc3e4a776
                      biosUuid: 6bbf3b42-5585-2ba6-9df2-515b8e62e1ea
                      hostName: r2vaw2
                      fqdn: r2vaw2.tech.local
                      guestOs: Microsoft Windows 10 Pro
                      guestOsType: Workstation
                      guestOsVersion: 10.0.19045
                      guestOsSku: 48
                      platformType: vSphere
                      ipAddresses:
                        - 172.36.50.45
                        - 172.35.155.122
                      macAddresses:
                        - 00:0C:30:62:E1:EA
                        - 00:50:67:BF:C0:10
                      applications: [ ]
                    connectionStatus: Online
                    isRebootRequired: false
                    connectionAccount: 19dd39c6-81b3-4f06-bc52-b38edeede3db
                    versionStatus: UpToDate
                    role: Master
                  - instanceUid: 50fc0692-8d76-40c3-866f-c211eae72043
                    locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                    organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    hostName: r2vspc
                    friendlyName: r2vspc
                    lastHeartbeatTime: '2024-07-18T15:01:34.9646882+02:00'
                    version: 8.1.0.20593
                    discoveryTime: '2024-07-18T04:39:20.1530000+02:00'
                    tag: My Company
                    status: Healthy
                    type: CloudConnect
                    computerInfo:
                      uniqueUid: 672400dc-106f-af15-8720-1380d82da05a
                      biosUuid: fbef3b42-52d3-28c2-f0b1-10fa95a7914a
                      hostName: r2vspc
                      fqdn: r2vspc.tech.local
                      guestOs: Microsoft Windows Server 2016 Standard
                      guestOsType: Server
                      guestOsVersion: 10.0.14393
                      guestOsSku: 7
                      platformType: vSphere
                      ipAddresses:
                        - 172.36.48.100
                      macAddresses:
                        - 00:0C:30:A7:91:4A
                      applications:
                        - MicrosoftSqlServer
                    connectionStatus: Online
                    isRebootRequired: false
                    connectionAccount: 0ba76c7e-1c9e-48bb-a97a-7ce51c192fa8
                    versionStatus: UpToDate
                    role: Client
                  - instanceUid: d6ece7c4-3828-473f-8df1-26e514fa294c
                    locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                    organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    hostName: r2SecondCC
                    friendlyName: r2SecondCC
                    lastHeartbeatTime: '2024-07-18T15:01:30.4843947+02:00'
                    version: 8.1.0.20593
                    discoveryTime: '2024-07-18T04:42:27.1200000+02:00'
                    tag: My Company
                    status: Healthy
                    type: CloudConnect
                    computerInfo:
                      uniqueUid: 8b213b7d-a096-5078-c8a1-1e525bc5ada8
                      biosUuid: 23773b42-3db9-9bde-fadf-809bf0a97ab8
                      hostName: r2SecondCC
                      fqdn: r2SecondCC.tech.local
                      guestOs: Microsoft Windows Server 2016 Datacenter
                      guestOsType: Server
                      guestOsVersion: 10.0.14393
                      guestOsSku: 8
                      platformType: vSphere
                      ipAddresses:
                        - 172.36.48.233
                      macAddresses:
                        - 00:0C:30:A9:7A:B8
                      applications:
                        - MicrosoftSqlServer
                    connectionStatus: Online
                    isRebootRequired: false
                    connectionAccount: 0ba76c7e-1c9e-48bb-a97a-7ce51c192fa8
                    versionStatus: UpToDate
                    role: Client
                  - instanceUid: 2e0e699f-af1b-49e0-9d72-b5fd6a1299f0
                    locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                    organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    hostName: r2ThirdCC
                    friendlyName: r2ThirdCC
                    lastHeartbeatTime: '2024-07-18T15:01:30.7343296+02:00'
                    version: 8.1.0.20593
                    discoveryTime: '2024-07-18T04:45:30.3870000+02:00'
                    tag: My Company
                    status: Healthy
                    type: CloudConnect
                    computerInfo:
                      uniqueUid: 2e94dcbe-1585-5a78-eb84-938a991aea00
                      biosUuid: 65443b42-9712-e4cc-e777-c3fb7ef176be
                      hostName: r2ThirdCC
                      fqdn: r2ThirdCC.tech.local
                      guestOs: Microsoft Windows Server 2016 Standard
                      guestOsType: Server
                      guestOsVersion: 10.0.14393
                      guestOsSku: 7
                      platformType: vSphere
                      ipAddresses:
                        - 172.35.155.105
                      macAddresses:
                        - 00:0C:30:F1:76:BE
                      applications:
                        - MicrosoftSqlServer
                    connectionStatus: Online
                    isRebootRequired: false
                    connectionAccount: 0ba76c7e-1c9e-48bb-a97a-7ce51c192fa8
                    versionStatus: UpToDate
                    role: Client
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/managementAgents/packages/windows:
    get:
      tags:
        - Management Agents
      summary: Download Management Agent Setup File for Windows
      description: Returns a download link to a management agent setup file in the `EXE` or `MSI` format for Microsoft Windows computers.
      operationId: DownloadWindowsManagementPackage
      parameters:
        - name: organizationUid
          in: query
          description: UID of an organization to which a management agent will be assigned.
          schema:
            type: string
            format: uuid
        - name: locationUid
          in: query
          description: UID of a location to which a management agent will be assigned.
          schema:
            type: string
            format: uuid
        - name: cloudTenantUid
          in: query
          description: UID of a cloud tenant to which a management agent will be assigned.
          schema:
            type: string
            format: uuid
        - name: tokenExpiryPeriodDays
          in: query
          description: "Time period for which you want to verify the management agent, in days.\n> The recommended value is `182` or less.\n"
          schema:
            maximum: 4700
            minimum: 1
            type: integer
            format: int32
            default: 365
        - name: packageType
          in: query
          description: Setup file extension.
          schema:
            enum:
              - msi
              - exe
            type: string
            default: exe
            x-ms-enum:
              name: WindowsInstallPackageType
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: Management agent setup file in the byte stream format.
          headers:
            content-disposition:
              description: 'Recommended file name that you can use while saving the setup file locally. For details, see [RFC6266](https://datatracker.ietf.org/doc/html/rfc6266).'
              required: true
              schema:
                type: string
              example: attachment; filename=ManagementAgent.My_Company.exe; filename*=UTF-8''ManagementAgent.My_Company.exe
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '520':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example: blob:https://lrsw10.tech.local:1280/b64d2863-97c5-49b6-a64a-fadc339c5804
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/managementAgents/packages/linux:
    get:
      tags:
        - Management Agents
      summary: Download Management Agent Setup File for Linux
      description: Returns a download link to a management agent setup file in the shell script format for Linux computers.
      operationId: DownloadLinuxManagementPackage
      parameters:
        - name: organizationUid
          in: query
          description: UID of an organization to which a management agent will be assigned.
          schema:
            type: string
            format: uuid
        - name: locationUid
          in: query
          description: UID of a location to which a management agent will be assigned.
          schema:
            type: string
            format: uuid
        - name: cloudTenantUid
          in: query
          description: UID of a cloud tenant to which a management agent will be assigned.
          schema:
            type: string
            format: uuid
        - name: tokenExpiryPeriodDays
          in: query
          description: "Time period for which you want to verify the management agent, in days.\n> The recommended value is `182` or less.\n"
          schema:
            maximum: 4700
            minimum: 1
            type: integer
            format: int32
            default: 365
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: Management agent setup file in the byte stream format.
          headers:
            content-disposition:
              description: 'Recommended file name that you can use while saving the setup file locally. For details, see [RFC6266](https://datatracker.ietf.org/doc/html/rfc6266).'
              required: true
              schema:
                type: string
              example: attachment; filename=ManagementAgent.My_Company.sh; filename*=UTF-8''ManagementAgent.My_Company.sh
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '520':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example: blob:https://lrsw10.tech.local:1280/562b5b52-c3d4-4ab4-bdf2-c450e220b38c
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/managementAgents/packages/mac:
    get:
      tags:
        - Management Agents
      summary: Download Management Agent Setup File for macOS.
      description: Returns a download link to a management agent setup file in the shell script format for macOS computers.
      operationId: DownloadMacManagementPackage
      parameters:
        - name: organizationUid
          in: query
          description: UID of an organization to which a management agent will be assigned.
          schema:
            type: string
            format: uuid
        - name: locationUid
          in: query
          description: UID of a location to which a management agent will be assigned.
          schema:
            type: string
            format: uuid
        - name: cloudTenantUid
          in: query
          description: UID of a cloud tenant to which a management agent will be assigned.
          schema:
            type: string
            format: uuid
        - name: tokenExpiryPeriodDays
          in: query
          description: "Time period for which you want to verify the management agent, in days.\n> The recommended value is `182` or less.\n"
          schema:
            maximum: 4700
            minimum: 1
            type: integer
            format: int32
            default: 365
        - name: packageType
          in: query
          description: Setup file extension.
          schema:
            enum:
              - sh
              - zip
            type: string
            default: zip
            x-ms-enum:
              name: MacInstallPackageType
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: Management agent setup file in the byte stream format.
          headers:
            content-disposition:
              description: 'Recommended file name that you can use while saving the setup file locally. For details, see [RFC6266](https://datatracker.ietf.org/doc/html/rfc6266).'
              required: true
              schema:
                type: string
              example: attachment; filename=ManagementAgent.My_Company.sh; filename*=UTF-8''ManagementAgent.My_Company.sh
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
        '520':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example: blob:https://lrsw10.tech.local:1280/1fa695d3-bc57-4f80-b838-7d7155973602
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/managementAgents/{managementAgentUid}':
    get:
      tags:
        - Management Agents
      summary: Get Management Agent
      description: Returns a resource representation of a management agent with the specified UID.
      operationId: GetManagementAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ManagementAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 06ba0a5b-b527-4686-8ab2-bc6f8274b880
                  locationUid: 79ff9d30-8eba-4315-a104-5622d05b2996
                  organizationUid: 7ca63e96-ec3d-49ca-ba94-92607960ae6f
                  hostName: r2vaw
                  friendlyName: r2vaw
                  lastHeartbeatTime: '2024-07-18T07:57:41.7633912+02:00'
                  version: 8.1.0.20593
                  discoveryTime: '2024-07-18T06:41:25.8018982+02:00'
                  tag: ''
                  status: Healthy
                  type: Client
                  computerInfo:
                    uniqueUid: 11d98047-d93d-4094-30af-072ef81704d2
                    biosUuid: d3533b42-475c-a193-4c1f-4c08fbff63cb
                    hostName: r2vaw
                    fqdn: r2vaw.tech.local
                    guestOs: Microsoft Windows 10 Pro
                    guestOsType: Workstation
                    guestOsVersion: 10.0.18363
                    guestOsSku: 48
                    platformType: vSphere
                    ipAddresses:
                      - 172.35.158.188
                    macAddresses:
                      - 00:0C:30:FF:63:CB
                    applications: [ ]
                  connectionStatus: Online
                  isRebootRequired: false
                  connectionAccount: b58106e9-bcea-4ab3-b195-e6c6cf5d91f6
                  versionStatus: UpToDate
                  role: Master
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ManagementAgent'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Management Agents
      summary: Modify Management Agent
      description: Modifies a management agent with the specified UID.
      operationId: PatchManagementAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: R3
                path: /tag
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ManagementAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 06ba0a5b-b527-4686-8ab2-bc6f8274b880
                  locationUid: 79ff9d30-8eba-4315-a104-5622d05b2996
                  organizationUid: 7ca63e96-ec3d-49ca-ba94-92607960ae6f
                  hostName: r2vaw
                  friendlyName: r2vaw
                  lastHeartbeatTime: '2024-07-18T07:57:41.7633912+02:00'
                  version: 8.1.0.20593
                  discoveryTime: '2024-07-18T06:41:25.8018982+02:00'
                  tag: R3
                  status: Healthy
                  type: Client
                  computerInfo:
                    uniqueUid: 11d98047-d93d-4094-30af-072ef81704d2
                    biosUuid: d3533b42-475c-a193-4c1f-4c08fbff63cb
                    hostName: r2vaw
                    fqdn: r2vaw.tech.local
                    guestOs: Microsoft Windows 10 Pro
                    guestOsType: Workstation
                    guestOsVersion: 10.0.18363
                    guestOsSku: 48
                    platformType: vSphere
                    ipAddresses:
                      - 172.24.158.188
                    macAddresses:
                      - 00:0C:29:FF:63:CB
                    applications: [ ]
                  connectionStatus: Online
                  isRebootRequired: false
                  connectionAccount: b58106e9-bcea-4ab3-b195-e6c6cf5d91f6
                  versionStatus: UpToDate
                  role: Master
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/ManagementAgent'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    delete:
      tags:
        - Management Agents
      summary: Delete Management Agent
      description: "Deletes a management agent with the specified UID.\n> If the management agent is inaccessible, it will be deleted only on the Veeam Service Provider Console side \nand the operation response will contain a warning message.\n\n> Does not delete the unverified management agents and the management agents that are installed on the Veeam Cloud Connect servers.\n"
      operationId: DeleteManagementAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Warnings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: [ ]
                meta:
                  pagingInfo:
                    total: 0
                    count: 0
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/managementAgents/{managementAgentUid}/proxyableProducts':
    get:
      tags:
        - Preview Operations
      summary: Get Veeam Products with Available Request Proxying.
      description: Returns a collection resource representation of Veeam products with available request proxying installed on the server where a management agent with the specified UID resides.
      operationId: GetManagementAgentInstalledProxyableProducts
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProxyProductInformation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - proxyProduct: VeeamBackupReplication
                    proxyProductUrlRepresentation: vbr
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /proxy/sessions:
    get:
      tags:
        - Preview Operations
      summary: Get Active Proxy Sessions.
      description: Returns a collection resource representation of active proxy sessions.
      operationId: GetActiveProxySessions
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProxySession'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - userUid: 303ab2de-639f-4f4e-b0a5-2af4eaa2d718
                    managementAgentUid: 5e6bee18-a91e-4b1d-a77e-f9ae815b6730
                    product: VeeamBackupReplication
                    creationTime: '2025-08-08T13:35:07.7210000+00:00'
                    lastActionTime: '2025-08-08T13:43:07.7210000+00:00'
                  - userUid: 19605e1d-1aca-42a9-821d-fa54ee35cb29
                    managementAgentUid: 5e6bee18-a91e-4b1d-a77e-f9ae815b6730
                    product: VeeamBackupReplication
                    creationTime: '2025-08-08T14:38:22.7210000+00:00'
                    lastActionTime: '2025-08-08T14:51:18.7210000+00:00'
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/managementAgents/{managementAgentUid}/restart':
    post:
      tags:
        - Management Agents
      summary: Restart Management Agent
      description: Restarts a management agent with the specified UID. Returns a positive response when the management agent receives the restart task and not when the task is executed.
      operationId: RestartManagementAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/managementAgents/{managementAgentUid}/reboot':
    post:
      tags:
        - Management Agents
      summary: Reboot System on Managed Computer
      description: Runs system reboot on a computer where management agent with the specified UID is installed. Returns a positive response when the management agent receives the reboot task and not when the task is executed.
      operationId: RebootSystemOnManagementAgent
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/managementAgents/{managementAgentUid}/credentials':
    get:
      tags:
        - Preview Operations
      summary: Get Management Agent Credentials
      description: Get a resource representation of credentials for Veeam Backup & Replication and Veeam backup agent installation configured on a management agent with the specified UID.
      operationId: GetManagementAgentCredentials
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ManagementAgentCredentials'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  username: VSPC\admin
                  password: Password1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/ManagementAgentCredentials'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    put:
      tags:
        - Preview Operations
      summary: Configure Management Agent Credentials
      description: Configure credentials for Veeam Backup & Replication and Veeam backup agent installation on a management agent with the specified UID.
      operationId: SetManagementAgentCredentials
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Parameters of credentials.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ManagementAgentCredentials'
            example:
              username: hv1\dma
              password: Password1
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ManagementAgentCredentials'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  username: hv1\dma
                  password: Password1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    delete:
      tags:
        - Preview Operations
      summary: Delete Management Agent Credentials
      description: Deletes credentials for Veeam Backup & Replication and Veeam backup agent installation configured on a management agent with the specified UID.
      operationId: DeleteManagementAgentCredentials
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupServers:
    get:
      tags:
        - Backup Servers
      summary: Get All Backup Servers
      description: Returns a collection resource representation of all Veeam Backup & Replication servers.
      operationId: GetBackupServers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 86238779-5bb3-4a2c-8578-466dedf635a3
                    name: LRSVBR10CC
                    organizationUid: b06a644b-4a55-443f-9f60-048073734a7b
                    locationUid: 29331def-5554-4866-9ed7-1020f379e062
                    managementAgentUid: ee12a85e-670c-49f4-b250-235f96238b6f
                    version: 10.0.1.4854
                    displayVersion: 10.0.1.4854
                    installationUid: ae517dbe-638d-459e-a32c-82c7bca1f7bb
                    backupServerRoleType: CloudConnect
                    status: Healthy
                  - instanceUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    name: LRSVBR11CC
                    organizationUid: b06a644b-4a55-443f-9f60-048073734a7b
                    locationUid: 29331def-5554-4866-9ed7-1020f379e062
                    managementAgentUid: 5e521f15-1ea7-4ec9-8a2e-8d759083676e
                    version: 11.0.1.1261
                    displayVersion: 11.0.1.1261 P20220302
                    installationUid: cf82f868-0c22-4bfe-9264-f4b370a74bd6
                    backupServerRoleType: CloudConnect
                    status: Healthy
                  - instanceUid: d8c5132a-30e1-4cf7-bea3-f0bc10bcaa96
                    name: lrsvbr12
                    organizationUid: b06a644b-4a55-443f-9f60-048073734a7b
                    locationUid: 29331def-5554-4866-9ed7-1020f379e062
                    managementAgentUid: a38f81df-bc23-426d-b870-4cf02c902f78
                    version: 12.1.0.2067
                    displayVersion: 12.1.0.2067
                    installationUid: 0ad6d11c-6450-4dd6-bb22-4602c169f8ce
                    backupServerRoleType: Hosted
                    status: Healthy
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}':
    get:
      tags:
        - Backup Servers
      summary: Get Backup Server
      description: Returns a resource representation of a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 4b3d7716-e303-4352-8c67-2497a8b12bdc
                  name: VBR4
                  organizationUid: 38103441-b276-41be-98f6-2b061a30e001
                  locationUid: 9939411a-c4ea-40b3-bdde-886ec0b7ad95
                  managementAgentUid: 134f9a02-59d3-4424-9bed-87c979dc3b21
                  version: 11.0.0.837
                  displayVersion: 11.0.0.837 P20210525
                  installationUid: 69773ff0-ddf5-4375-84c7-5dd1527120f6
                  backupServerRoleType: Client
                  status: Healthy
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/collect':
    post:
      tags:
        - Backup Servers
      summary: Force Data Collection from Backup Server
      description: Forces data collection from a Veeam Backup & Replication server with the specified UID. Returns a positive response when the collection task is added to the internal queue and not when the task is executed.
      operationId: ForceCollectBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/upgrade/iso/predownload':
    post:
      tags:
        - Preview Operations
      summary: Download Veeam Backup & Replication Upgrade Setup File
      description: Downloads the Veeam Backup & Replication upgrade setup file for further installation on a Veeam Backup & Replication server with the specified UID.
      operationId: PredownloadBackupServerIso
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: File download configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VbrIsoPredownloadInput'
            example:
              path: C:\ProgramData\Veeam\Veeam Availability Console
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DeploymentTaskResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  deploymentTaskUid: b68fbe4d-9886-430a-8389-fc01da7b081b
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/backupServers/{backupServerUid}/upgrade':
    post:
      tags:
        - Deployment
      summary: Update Veeam Backup & Replication on Server
      description: "Installs the latest update of Veeam Backup & Replication on a server with the specified UID.\n> To track the installation progress, you can use the `WaitDeploymentTask` operation.       \n"
      operationId: UpgradeBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Deployment configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VbrDeploymentConfiguration'
            example:
              distribution:
                filePath: \\tech.local\tech\VSPC\VBR\13\Butler\VeeamBackup&Replication_13.iso
                userName: vspc1\admin
                password: Password1
              usePredownloadedIso: false
              answerXml: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<unattendedInstallationConfiguration bundle=\"VBR\" mode=\"upgrade\">\r\n  <properties>\r\n\r\n    <!--License agreements-->\r\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\r\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\r\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\r\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\r\n\r\n    <!--License file-->\r\n    <!--property name=\"VBR_LICENSE_FILE\" value=\"\" /-->\r\n    <property name=\"VBR_LICENSE_AUTOUPDATE\" value=\"1\" />\r\n\r\n    <!--Service account-->\r\n    <!--property name=\"VBR_SERVICE_PASSWORD\" value=\"\" hidden=\"1\"/-->\r\n\r\n    <!--Database configuration-->\r\n    <property name=\"VBR_SQLSERVER_PASSWORD\" value=\"Password1\" hidden=\"1\"/>\r\n\r\n    <!--Automatic update settings-->\r\n    <property name=\"VBR_AUTO_UPGRADE\" value=\"1\" />\r\n\r\n  </properties>\r\n</unattendedInstallationConfiguration>\r\n"
              allowAutoReboot: true
              stopAllActivities: true
              useManagementAgentCredentials: false
              adminCredentials:
                username: vspc1\admin
                password: Password1
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: ae61e533-82c7-4cb6-a030-78ae589cf49d
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/backupServers/{backupServerUid}/patch':
    post:
      tags:
        - Deployment
      summary: Patch Veeam Backup & Replication on Server
      description: "Patches Veeam Backup & Replication on a server with the specified UID.\n> To track the deployment progress, you can use the `WaitDeploymentTask` operation.       \n"
      operationId: PatchBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Patch configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VbrPatchConfiguration'
            example:
              allowAutoReboot: true
              stopAllActivities: true
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: af483eb8-10ae-4482-a18a-4b5746ab5340
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/backupServers/{backupServerUid}/patch/upload/multipart/create':
    post:
      tags:
        - Preview Operations
      summary: Starts Patch Upload to Veeam Backup & Replication Server
      description: Initiates an upload of a patch to a Veeam Backup & Replication server with the specified UID.
      operationId: CreateBackupServerMultipartPatch
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBackupServerMultipartPatchInput'
            example:
              files:
                - name: Veeam.Backup.Core.dll
                  fileSize: 180605200
                  targetDirectory: \PatchFolder
              action: ReplaceFilesAndRestart
              stopAllActivities: true
              rebootAutomatically: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerMultipartPatchInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  uploadUid: 69d70dc2-25d4-4e82-a0fc-d89c1d847ec7
                  files:
                    - name: Veeam.Backup.Core.dll
                      fileStreamUid: 6d18e5fe-20e5-4248-a87f-29a109a44b80
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/backupServers/{backupServerUid}/patch/upload/multipart/uploadPart':
    post:
      tags:
        - Preview Operations
      summary: Upload Patch File Chunk to Veeam Backup & Replication Server
      description: Uploads a patch file chunk to Veeam Backup & Replication server with the specified UID.
      operationId: UploadBackupServerMultipartPatch
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: uploadUid
          in: query
          description: Upload UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: fileStreamUid
          in: query
          description: Single file UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: partNumber
          in: query
          description: File chunk ordinal number.
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        description: "File chunk.\n> Maximum size is 5 MB. Sending a bigger file chunk can return an unexpected error response.\n"
        content:
          application/octet-stream:
            schema:
              maxLength: 5242880
              minLength: 1
              type: string
              format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/backupServers/{backupServerUid}/patch/upload/multipart/complete':
    post:
      tags:
        - Preview Operations
      summary: Complete Patch Upload to Veeam Backup & Replication Server
      description: Finalizes an upload of a patch to Veeam Backup & Replication server with the specified UID.
      operationId: CompleteBackupServerMultipartPatch
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: uploadUid
          in: query
          description: Upload UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: 45818675-b248-41e4-911c-83bb3ea9fc3c
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/backupServers/{backupServerUid}/patch/upload/multipart/abort':
    post:
      tags:
        - Preview Operations
      summary: Abort Patch Upload to Veeam Backup & Replication Server
      description: Aborts an upload of a patch to Veeam Backup & Replication server with the specified UID.
      operationId: AbortBackupServerMultipartPatch
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: uploadUid
          in: query
          description: Upload UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/backupServers/{backupServerUid}/scheduledTasks/upgrade':
    post:
      tags:
        - Deployment
      summary: Schedule Veeam Backup & Replication Update
      description: Creates a scheduled task that installs the latest Veeam Backup & Replication update on a server with the specified UID.
      operationId: ScheduleUpgradeBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Deployment configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VbrScheduledDeploymentConfiguration'
            example:
              configuration:
                distribution:
                  filePath: \\tech.local\tech\VSPC\VBR\13\Butler\VeeamBackup&Replication_13.iso
                  userName: vspc\admin
                  password: Password1
                usePredownloadedIso: false
                answerXml: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<unattendedInstallationConfiguration bundle=\"VBR\" mode=\"upgrade\">\r\n  <properties>\r\n\r\n    <!--License agreements-->\r\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\r\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\r\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\r\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\r\n\r\n    <!--License file-->\r\n    <property name=\"VBR_LICENSE_AUTOUPDATE\" value=\"1\" />\r\n\r\n    <!--Service account-->\r\n    <property name=\"VBR_SERVICE_PASSWORD\" value=\"Password1\" hidden=\"1\" />\r\n\r\n    <!--Database configuration-->\r\n    <property name=\"VBR_SQLSERVER_PASSWORD\" value=\"Password1\" hidden=\"1\" />\r\n\r\n    <!--Automatic update settings-->\r\n    <property name=\"VBR_AUTO_UPGRADE\" value=\"1\" />\r\n\r\n  </properties>\r\n</unattendedInstallationConfiguration>\r\n"
                allowAutoReboot: true
                stopAllActivities: true
                useManagementAgentCredentials: true
                adminCredentials:
                  username: vspc\admin
                  password: Password1
              schedule:
                dateTime: '2025-07-24T07:23:16.3525528+02:00'
        required: true
      responses:
        '200':
          description: Resource representation of a scheduled task.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ScheduledDeployTaskResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  scheduledTaskUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  taskUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/backupServers/{backupServerUid}/scheduledTasks/patch':
    post:
      tags:
        - Deployment
      summary: Schedule Veeam Backup & Replication Patch
      description: Creates a scheduled task that installes Veeam Backup & Replication patch on a server with the specified UID.
      operationId: SchedulePatchBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Patch configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VbrScheduledPatchConfiguration'
            example:
              configuration:
                allowAutoReboot: true
                stopAllActivities: true
              schedule:
                dateTime: '2023-11-19T04:00:08.2424862+01:00'
        required: true
      responses:
        '200':
          description: Resource representation of a scheduled task.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ScheduledDeployTaskResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  scheduledTaskUid: 35a1346a-7633-4c13-a4ec-752d2eb91354
                  taskUid: 05e8e863-06d5-4748-983d-f5f905d6213a
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /infrastructure/backupServers/agents:
    get:
      tags:
        - Backup Servers
      summary: Get Veeam Backup Agents Managed by All Veeam Backup & Replication Servers
      description: Returns a collection resource representation of all Veeam backup agents managed by connected Veeam Backup & Replication servers.
      operationId: GetBackupServersAgents
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0c399c26-1f05-41f5-af32-65cbdff68450
                    name: r2vaw3.tech.local
                    machineName: r2vaw3.tech.local
                    guestOs: 'Microsoft Windows 10 (21H2, 64-bit)'
                    version: 6.0.0.953
                    biosUid: 42c03b42-96f9-ad8a-5277-ca43a693cbf0
                    ipAddresses:
                      - 172.24.159.126
                    protectionGroups:
                      - a0da4cdd-26ab-4b3d-a888-34405768df53
                    backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                    isUnmanaged: false
                    installationStatus: Installed
                    license: Server
                    licenseStatus: Licensed
                    osType: Windows
                  - instanceUid: 7d58c7c7-8362-40b0-82a2-fd1f8c8c7067
                    name: r2valVBR.tech.local
                    machineName: r2valVBR.tech.local
                    guestOs: Ubuntu 18.04.1 LTS
                    version: 6.0.0.1053
                    biosUid: 4211a8e8-1f9c-3da5-6972-4b1a6f4b8c6a
                    ipAddresses:
                      - 172.24.152.24
                    protectionGroups:
                      - bfb30a81-eb05-4f3f-bd8f-bd93a93576f2
                    backupServerUid: a6305f3c-46be-4c06-9bc4-97f2449d881f
                    isUnmanaged: false
                    installationStatus: Installed
                    license: Limited
                    licenseStatus: Unlicensed
                    osType: Linux
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/agents':
    get:
      tags:
        - Backup Servers
      summary: Get All Veeam Backup Agents Managed by Veeam Backup & Replication Server
      description: Returns a collection resource representation of all Veeam backup agents managed by a connected Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerAgentsByServer
      parameters:
        - name: backupServerUid
          in: path
          description: Veeam Backup & Replication server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0c399c26-1f05-41f5-af32-65cbdff68450
                    name: r2vaw3.tech.local
                    machineName: r2vaw3.tech.local
                    guestOs: 'Microsoft Windows 10 (21H2, 64-bit)'
                    version: 6.0.0.953
                    biosUid: 42c03b42-96f9-ad8a-5277-ca43a693cbf0
                    ipAddresses:
                      - 172.24.233.126
                    protectionGroups:
                      - a0da4cdd-26ab-4b3d-a888-34405768df53
                    backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                    isUnmanaged: false
                    installationStatus: Installed
                    license: Server
                    licenseStatus: Licensed
                    osType: Windows
                  - instanceUid: 7d58c7c7-8362-40b0-82a2-fd1f8c8c7067
                    name: r2valVBR.tech.local
                    machineName: r2valVBR.tech.local
                    guestOs: Ubuntu 18.04.1 LTS
                    version: 6.0.0.1053
                    biosUid: 4211a8e8-1f9c-3da5-6972-4b1a6f4b8c6a
                    ipAddresses:
                      - 172.24.136.24
                    protectionGroups:
                      - bfb30a81-eb05-4f3f-bd8f-bd93a93576f2
                    backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                    isUnmanaged: false
                    installationStatus: Installed
                    license: Limited
                    licenseStatus: Unlicensed
                    osType: Linux
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/agents/{agentUid}':
    get:
      tags:
        - Backup Servers
      summary: Get Veeam Backup Agent Managed by Veeam Backup & Replication Server
      description: Returns a resource representation of a Veeam backup agent with the specified UID managed by a Veeam Backup & Replication server.
      operationId: GetBackupServerAgent
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: agentUid
          in: path
          description: Veeam backup agent UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 0c399c26-1f05-41f5-af32-65cbdff68450
                  name: r2vaw3.tech.local
                  machineName: r2vaw3.tech.local
                  guestOs: 'Microsoft Windows 10 (21H2, 64-bit)'
                  version: 6.0.0.953
                  biosUid: 42c03b42-96f9-ad8a-5277-ca43a693cbf0
                  ipAddresses:
                    - 172.24.233.126
                  protectionGroups:
                    - a0da4cdd-26ab-4b3d-a888-34405768df53
                  backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                  isUnmanaged: false
                  installationStatus: Installed
                  license: Server
                  licenseStatus: Licensed
                  osType: Windows
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/publicCloud/appliances/{applianceUid}/mapping':
    get:
      tags:
        - Public Cloud
      summary: Get Veeam Backup for Public Clouds Appliance Mapping
      description: Returns a resource representation of organization mapping of a Veeam Backup for Public Clouds appliance with the specified UID.
      operationId: GetPublicCloudMapping
      parameters:
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudMapping'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  applianceUid: f654663b-f348-492c-adb6-785244ee93ca
                  companyUid: 6eb51175-0421-4d72-bc5b-f4ebb137eb40
                  guestOsCredentialsUid: bfdcd0bb-97b1-4c24-ad82-2f2a2496bd8b
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    post:
      tags:
        - Public Cloud
      summary: Create Veeam Backup for Public Clouds Appliance Mapping
      description: Maps a Veeam Backup for Public Clouds appliance to an organization.
      operationId: CreatePublicCloudMapping
      parameters:
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudMappingInput'
            example:
              companyUid: 6eb51175-0421-4d72-bc5b-f4ebb137eb40
              guestOsCredentialsUid: bfdcd0bb-97b1-4c24-ad82-2f2a2496bd8b
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudMapping'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  applianceUid: f654663b-f348-492c-adb6-785244ee93ca
                  companyUid: 6eb51175-0421-4d72-bc5b-f4ebb137eb40
                  guestOsCredentialsUid: bfdcd0bb-97b1-4c24-ad82-2f2a2496bd8b
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Public Cloud
      summary: Delete Veeam Backup for Public Clouds Appliance Mapping
      description: Deletes an organization mapping of a Veeam Backup for Public Clouds appliance with the specified UID.
      operationId: RemovePublicCloudMapping
      parameters:
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/publicCloud/appliances/{applianceUid}/certificate':
    get:
      tags:
        - Public Cloud
      summary: Get Veeam Backup for Public Clouds Appliance Certificate
      description: Returns a resource representation of a security certificate of a Veeam Backup for Public Clouds appliance with the specified UID.
      operationId: GetPublicCloudApplianceCertificate
      parameters:
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Certificate'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  issuedTo: OU=AWS Backup
                  issuedBy: 'OU=AWS Backup, O=Veeam Software, E=support@veeam.com, C=CH, S=Zug, CN=Veeam AWS Backup Local CA f98a8c72-b989-4f3b-ae0e-8e935ad6342b'
                  friendlyName: ''
                  thumbprint: 4D55401A6BE5D2B5098A3FC8C782B47DCA56C3E5
                  serialNumber: '0477281895'
                  expirationDate: '2026-02-08T18:39:01.0000000+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/publicCloud/appliances/{applianceUid}/certificate/verify':
    post:
      tags:
        - Public Cloud
      summary: Verify Veeam Backup for Public Clouds Appliance Certificate
      description: Verifies a security certificate of a Veeam Backup for Public Clouds appliance with the specified UID.
      operationId: VerifyPublicCloudApplianceCertificate
      parameters:
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudApplianceCertificateCredentials'
            example:
              username: s.smith
              password: Password1
              certificateThumbprint: 4D55401A6BE5D2B5098A3FC8C782B47DCA56C3E5
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /infrastructure/sites/publicCloud/accounts/sync:
    post:
      tags:
        - Public Cloud
      summary: Synchronize Public Cloud Accounts
      description: Initiates synchronization of public cloud account data between Veeam Service Provider Console and Veeam Backup for Public Cloud.
      operationId: SyncPublicCloudAccounts
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/timeZones':
    get:
      tags:
        - Public Cloud
      summary: Get Public Cloud Time Zones
      description: Returns a collection resource representation of all time zones of public cloud VMs registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudTimeZones
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: publicCloudType
          in: query
          description: Platform type of public cloud VMs.
          required: true
          schema:
            enum:
              - AWS
              - Azure
              - Google
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudTimeZone'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - timeZoneId: Pacific/Midway
                    displayName: Pacific/Midway -11:00
                    offset: '-11:00:00'
                  - timeZoneId: Pacific/Niue
                    displayName: Pacific/Niue -11:00
                    offset: '-11:00:00'
                  - timeZoneId: Pacific/Pago_Pago
                    displayName: Pacific/Pago_Pago -11:00
                    offset: '-11:00:00'
                  - timeZoneId: America/Adak
                    displayName: America/Adak -10:00
                    offset: '-10:00:00'
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /infrastructure/sites/publicCloud/guestOsCredentials:
    post:
      tags:
        - Public Cloud
      summary: Create Guest OS Credentials
      description: Creates guest OS credentials for public cloud VMs.
      operationId: CreatePublicCloudGuestOsCredentials
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudGuestOsCredentialsInput'
            example:
              role: serviceProviderAdministrator
              username: admin
              description: Service Provider Admin Credentials
              password: Password1
              siteUid: e5d94dfc-0861-42ef-b929-7265eead92cc
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudGuestOsCredentials'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  guestOsCredentialsUid: 9d8ac737-5ca0-44b8-8195-890a66f93606
                  role: serviceProviderAdministrator
                  username: admin
                  description: string
                  password: ••••••
                  organizationUid: 507e9b59-a73d-489d-ab0c-e34d23ded114
                  siteUid: e5d94dfc-0861-42ef-b929-7265eead92cc
                  appliances: 
                  lastChangeTimestamp: '2024-07-26T12:39:04.4690000+00:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    get:
      tags:
        - Public Cloud
      summary: Get All Guest OS Credentials
      description: Returns a collection resource representation of all guest OS credentials for public cloud VMs.
      operationId: GetPublicCloudGuestOsCredentials
      parameters:
        - name: siteUid
          in: query
          description: Veeam Cloud Connect site UID. Limits returned guest OS credentials to those used to access VMs registered on the specified Veeam Cloud Connect site.
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudGuestOsCredentials'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - guestOsCredentialsUid: 7466a1a1-1881-42b6-8f42-3758ccca133b
                    role: serviceProviderAdministrator
                    username: administrator
                    description: ''
                    password: ������
                    organizationUid: 507e9b59-a73d-489d-ab0c-e34d23ded114
                    siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                    appliances: 
                    lastChangeTimestamp: '2023-03-18T15:51:12.4400000+01:00'
                  - guestOsCredentialsUid: ed38845b-0e3d-45e3-aca6-1a589482b5ce
                    role: serviceProviderAdministrator
                    username: administratort2
                    description: ''
                    password: ������
                    organizationUid: 507e9b59-a73d-489d-ab0c-e34d23ded114
                    siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                    appliances: 
                    lastChangeTimestamp: '2023-11-07T18:35:09.6900000+01:00'
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/publicCloud/guestOsCredentials/{guestOsCredentialsUid}':
    get:
      tags:
        - Public Cloud
      summary: Get Guest OS Credentials Record
      description: Returns a resource representation of public cloud guest OS credentials record with the specified UID.
      operationId: GetPublicCloudGuestOsCredentialsById
      parameters:
        - name: guestOsCredentialsUid
          in: path
          description: Guest OS credentials record UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudGuestOsCredentials'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  guestOsCredentialsUid: ed38845b-0e3d-45e3-aca6-1a589482b5ce
                  role: serviceProviderAdministrator
                  username: administratort2
                  description: ''
                  password: ������
                  organizationUid: 507e9b59-a73d-489d-ab0c-e34d23ded114
                  siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                  appliances: 
                  lastChangeTimestamp: '2023-11-07T18:35:09.6900000+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PublicCloudGuestOsCredentials'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    patch:
      tags:
        - Public Cloud
      summary: Modify Guest OS Credentials Record
      description: Modifies public cloud guest OS credentials record with the specified UID.
      operationId: PatchPublicCloudGuestOsCredentials
      parameters:
        - name: guestOsCredentialsUid
          in: path
          description: Guest OS credentials record UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Public Cloud administrator2 credentials
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudGuestOsCredentials'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  guestOsCredentialsUid: ed38845b-0e3d-45e3-aca6-1a589482b5ce
                  role: serviceProviderAdministrator
                  username: administratort2
                  description: Public Cloud administrator2 credentials
                  password: ������
                  organizationUid: 507e9b59-a73d-489d-ab0c-e34d23ded114
                  siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                  appliances: 
                  lastChangeTimestamp: '2023-11-07T18:35:09.6900000+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PublicCloudGuestOsCredentials'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Public Cloud
      summary: Delete Guest OS Credentials Record
      description: Deletes public cloud guest OS credentials record with the specified UID.
      operationId: RemovePublicCloudGuestOsCredentials
      parameters:
        - name: guestOsCredentialsUid
          in: path
          description: Guest OS credentials record UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /infrastructure/sites/publicCloud/guestOsCredentials/sync:
    post:
      tags:
        - Public Cloud
      summary: Synchronize Public Cloud Guest OS Credentials
      description: Initiates synchronization of public cloud guest OS credentials data in Veeam Service Provider Console with Veeam Backup for Public Cloud.
      operationId: SyncPublicCloudGuestOsCredentials
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/accounts':
    post:
      tags:
        - Public Cloud AWS
      summary: Create AWS Account
      description: Creates an AWS account in a Veeam Cloud Connect site with the specified UID.
      operationId: CreatePublicCloudAwsAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAwsAccountInput'
            example:
              accessKey: AKIAIOSYFWMCY6EPFODNN
              secretKey: IARGqk4zm1W0CILr3BMu2y9ylvtI6OkGq7Vc9jVw
              description: 'Created by Veeam Service Provider Console. My Company: BM-1\Administrator'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAwsAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: f854a9fc-df97-40c9-8c32-c5fab9ad13d5
                  credentialTag: def65448-3bdb-493e-8111-709f502a962f
                  accessKey: AKIAIOSYFWMCY6EPFODNN
                  secretKey: 
                  description: 'Created by Veeam Service Provider Console. My Company: BM-1\Administrator'
                  createdBy: BM-1\Administrator
                  siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                  organizationUid: 507e9b59-a73d-489d-ab0c-e34d23ded114
                  appliances: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    get:
      tags:
        - Public Cloud AWS
      summary: Get All AWS Accounts
      description: Returns a collection resource representation of all AWS accounts managed by a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAwsAccounts
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAwsAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - accountUid: f854a9fc-df97-40c9-8c32-c5fab9ad13d5
                    credentialTag: def65448-3bdb-493e-8111-709f502a962f
                    accessKey: AKIAIOSYFWMCY6EPFODNN
                    secretKey: 
                    description: 'Created by Veeam Service Provider Console. My Company: BM-1\Administrator'
                    createdBy: BM-1\Administrator
                    siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                    organizationUid: 507e9b59-a73d-489d-ab0c-e34d23ded114
                    appliances: [ ]
                  - accountUid: 1d491e23-0e06-4b8f-9712-eef688d46c3f
                    credentialTag: f531a544-c83f-4b7d-82ab-97d288b1ec57
                    accessKey: AKIA3MQHXVRWSTY5KPZJ
                    secretKey: 
                    description: 'Created at [1:18:29 PM] by [PortalAdministrator]; Created by Veeam Service Provider Console. My Company: VSPC\Administrator'
                    createdBy: VSPC\Administrator
                    siteUid: 2938682b-42e2-47a0-b3f5-9dc4d40e933c
                    organizationUid: 28dd164b-1f9c-4b71-b226-de78a8cc3436
                    appliances:
                      - b88bb6b9-d265-4b88-a1d3-744e476c4ed7
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/accounts/{accountUid}':
    get:
      tags:
        - Public Cloud AWS
      summary: Get AWS Account
      description: Returns a resource representation of an AWS account with the specified UID.
      operationId: GetPublicCloudAwsAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: AWS account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAwsAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: f854a9fc-df97-40c9-8c32-c5fab9ad13d5
                  credentialTag: def65448-3bdb-493e-8111-709f502a962f
                  accessKey: AKIAIOSYFWMCY6EPFODNN
                  secretKey: 
                  description: 'Created by Veeam Service Provider Console. My Company: BM-1\Administrator'
                  createdBy: BM-1\Administrator
                  siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                  organizationUid: 507e9b59-a73d-489d-ab0c-e34d23ded114
                  appliances: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PublicCloudAwsAccount'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    patch:
      tags:
        - Public Cloud AWS
      summary: Modify AWS Account
      description: Modifies an AWS account with the specified UID.
      operationId: PatchPublicCloudAwsAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: AWS account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: AKIAIOSYFWMCY6EPFODNN
                path: /accessKey
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAwsAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: f854a9fc-df97-40c9-8c32-c5fab9ad13d5
                  credentialTag: def65448-3bdb-493e-8111-709f502a962f
                  accessKey: AKIAIOSYFWMCY6EPFODNN
                  secretKey: 
                  description: 'Created by Veeam Service Provider Console. My Company: BM-1\Administrator'
                  createdBy: BM-1\Administrator
                  siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                  organizationUid: 507e9b59-a73d-489d-ab0c-e34d23ded114
                  appliances: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PublicCloudAwsAccount'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Public Cloud AWS
      summary: Delete AWS Account
      description: Delete an AWS account with the specified UID.
      operationId: RemovePublicCloudAwsAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: AWS account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/accounts/{accountUid}/grantPermissionsForMigration':
    post:
      tags:
        - Public Cloud AWS
      summary: Grant Permissions to Update Veeam Backup for AWS Appliance
      description: Grants permissions necessary to update an Veeam Backup for AWS appliance to an account with the specified UID.
      operationId: GrantPublicCloudAppliancePlatformCredentialsForMigration
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: AWS account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudGrantPermissionsForMigrationInput'
            example:
              accessKey: AKIAIOSYFWMCY6EPFODNN
              secretKey: IARGqk4zm1W0CILr3BMu2y9ylvtI6OkGq7Vc9jVw
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/GrantPublicCloudCredentialsForMigrationResult'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: f854a9fc-df97-40c9-8c32-c5fab9ad13d5
                  success: true
                  message: ''
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/accounts/{accountUid}/validateCloudCredentialsForMigration':
    post:
      tags:
        - Public Cloud AWS
      summary: Validate Veeam Backup for AWS Appliance Credentials
      description: Verifies that account used to access a backup device with the specified UID has permissions to install backup device update.
      operationId: ValidatePublicCloudAppliancePlatformCredentialsForMigration
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: AWS account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ValidatePublicCloudCredentialsForMigrationResult'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: f854a9fc-df97-40c9-8c32-c5fab9ad13d5
                  success: true
                  insufficientRights: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/dataCenters':
    get:
      tags:
        - Public Cloud AWS
      summary: Get AWS Datacenters
      description: Returns a collection resource representation of all AWS datacenters registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAwsDataCenters
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: regionId
          in: query
          description: AWS region ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAwsDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - OperationId: GetPublicCloudAwsDataCenters
                    RequestBodyExample: 
                    RequestBodyExampleType: 
                    ResponseExample:
                      - dataCenterId: us-east-1
                        dataCenterName: US East (N. Virginia) (us-east-1)
                      - dataCenterId: us-east-2
                        dataCenterName: US East (Ohio) (us-east-2)
                      - dataCenterId: us-west-1
                        dataCenterName: US West (N. California) (us-west-1)
                      - dataCenterId: us-west-2
                        dataCenterName: US West (Oregon) (us-west-2)
                    ResponseExampleType: 1
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/connection':
    post:
      tags:
        - Public Cloud AWS
      summary: Add Amazon Connection
      description: Adds Amazon connection in a Veeam Cloud Connect site with the specified UID.
      operationId: CreatePublicCloudAwsConnection
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: query
          description: AWS account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: dataCenterId
          in: query
          description: AWS datacenter ID.
          required: true
          schema:
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAwsConnection'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  connectionUid: f854a9fc-df97-40c9-8c32-c5fab9ad13d5
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/connection/{connectionUid}':
    delete:
      tags:
        - Public Cloud AWS
      summary: Delete Amazon Connection
      description: Deletes Amazon connection with the specified UID.
      operationId: DeletePublicCloudAwsConnection
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: path
          description: Amazon connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/virtualMachines':
    get:
      tags:
        - Public Cloud AWS
      summary: Get All AWS VMs
      description: Returns a collection resource representation of all AWS VMs registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAwsVirtualMachines
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Amazon connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: dataCenterId
          in: query
          description: AWS datacenter ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAwsVirtualMachine'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - virtualMachineId: i-06b9db74f814d9272
                    virtualMachineName: vb-aws-1
                  - virtualMachineId: i-072a706e97a8152fb
                    virtualMachineName: vb-aws-2
                  - virtualMachineId: i-0120715cc592ef054
                    virtualMachineName: vb-aws-3
                  - virtualMachineId: i-0636185fb7c5b174d
                    virtualMachineName: vb-aws-4
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/regions':
    get:
      tags:
        - Public Cloud AWS
      summary: Get All AWS Regions
      description: Returns a collection resource representation of all AWS regions.
      operationId: GetPublicCloudAwsRegions
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAwsRegion'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - regionId: Global
                    regionName: Global
                  - regionId: Government
                    regionName: GovCloud (US)
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/networks':
    get:
      tags:
        - Public Cloud AWS
      summary: Get All AWS Networks
      description: Returns a collection resource representation of all AWS networks registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAwsNetworks
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Amazon connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAwsNetwork'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - networkId: vpc-09ae9e55dd75a5f6b
                    networkName: vpc-09ae9e55dd75a5f6b (default)
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/subnets':
    get:
      tags:
        - Public Cloud AWS
      summary: Get All AWS Subnets
      description: Returns a collection resource representation of all AWS subnets registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAwsSubNetworks
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Amazon connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: networkId
          in: query
          description: AWS network ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAwsSubnet'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - subnetId: subnet-035eb5d59d4de6b05
                    subnetName: eu-central-1c
                    range: 173.42.0.0/20
                    displayName: subnet-035eb5d59d4de6b05 (eu-central-1c)
                  - subnetId: subnet-0b2131c783c96c1f9
                    subnetName: eu-central-1a
                    range: 173.42.27.0/20
                    displayName: subnet-0b2131c783c96c1f9 (eu-central-1a)
                  - subnetId: subnet-00872f03cdd80880d
                    subnetName: eu-central-1b
                    range: 173.42.43.0/20
                    displayName: subnet-00872f03cdd80880d (eu-central-1b)
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/ipAddresses':
    get:
      tags:
        - Public Cloud AWS
      summary: Get AWS Elastic IP Addresses
      description: Returns a collection resource representation of all Elastic IP addresses available to AWS accounts registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAwsElasticIpAddresses
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Amazon connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAppliancePublicAddress'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - applianceIpAddressId: 
                    ipAddress: 173.42.0.0
                    name: awsa1
                  - applianceIpAddressId: 
                    ipAddress: 173.42.43.0
                    name: awsa2
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/backupServerIpAddresses':
    get:
      tags:
        - Public Cloud AWS
      summary: Get Veeam Cloud Connect Site IP Adresses
      description: Returns a collection resource representation of IP addresses assigned in AWS to a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAwsBackupServerIpAddresses
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudBackupServerPublicAddress'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupServerIpAddresses: 89.296.226.14/32
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/keys':
    get:
      tags:
        - Public Cloud AWS
      summary: Get All Amazon Encryption Keys
      description: Returns a collection resource representation of all Amazon encryption keys.
      operationId: GetPublicCloudAwsKeys
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Amazon connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAwsKey'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - keyPairName: DefaultKeyPair
                  - keyPairName: '[PortalAdministrator]_keyPair'
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    post:
      tags:
        - Public Cloud AWS
      summary: Create Amazon Encryption Key
      description: Creates an Amazon encryption key.
      operationId: CreatePublicCloudAwsKey
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAwsKeyPairInput'
            example:
              connectionUid: f854a9fc-df97-40c9-8c32-c5fab9ad13d5
              name: '[PortalAdministrator]_keyPair'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAwsNewKeyPair'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  keyPairName: '[PortalAdministrator]_keyPair'
                  privateKey: '-----BEGIN RSA PRIVATE KEY-----MIICXAIBAAKBgQDaU+LpGlbcac2oLrp11sTSOYCAVyGbC9xoZ4+DrCRQnjY50GchPSuVM6G2lkN2v8yXf9UJEWRlBJvMF+ggdORC8QU5WKjGRJ2r85QYt1TCcjHa6s8WIbFvZmlMcveMd7qKWjFH4DRgYG1Lwm7xY4OD5I+ADWFoNGd9c6tOKNC8QIDAQABAoGADSzwzaZ0RXrxGUwwnnnmiNVFhvk7IvM1SuutAoI58s+JcDW+c4gQgEGMactpqNnsS9xAC/sLtvjvOgLbVFIZkEAYN67kFOcAKUVWozygXXNdb7TQGa5eW8xVBy2evYZo7W+OVTvMm1uJHWcNMjFjw4xlRTlRKgCqiZwOJfcIM20CQQDucLC2qgDCTjiirNlMBUhJ6e5tj7vAV1wxGfoBDroEBzTGuu71jQyESZRLucOMARDUdGdRAgjwe8F01ii27mEvAkEA6mgD3kW6HI2zjwxdTnerG/1qwgBXLaGnU4yWLGWLPcCto8nsz93RjYdm7ln2EqyG3ALptJIJrYRiEH0k9MhV3wJAXXSv3ridWYs9KY2kEebUIZxeBnVaupXDHb+3vKhgAmospmPoezgQmt0YEeI6oepdBVimkhrBFDj9Z2T1SlX+owJBAIC7jyRK9uMnjy1IhRXK8tX0XuUcesQ8u0BPPUo0mjvXzYTeKIggMi2f5w+PqGypA4dgsijQ6y+4PIMBt4IXY9ECQE3j0kdvxF66n7VUFm5LTCNqKkkU1EyCU+yC5wLd3Xf7jRHZWV9vKrbFn5jNxz+u1rOMkKx4MrPf+Tvt+SWb0nI=-----END RSA PRIVATE KEY-----'
                  fileName: admin_aws_keys
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/securityGroups':
    get:
      tags:
        - Public Cloud AWS
      summary: Get All AWS Security Groups
      description: Returns a collection resource representation of all AWS security groups registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAwsSecurityGroups
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Amazon connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: networkId
          in: query
          description: Network ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAwsSecurityGroup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - securityGroupId: sg-0ad0a345b8059c199
                    securityGroupName: default
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /infrastructure/sites/publicCloud/repositories:
    get:
      tags:
        - Public Cloud
      summary: Get All Public Cloud Repositories
      description: Returns a collection resource representation of all public cloud repositories.
      operationId: GetPublicCloudRepositories
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudRepository'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 568f43f7-24a6-4c9c-b755-3294a5e4fd41
                    repositoryName: rt2-rep
                    description: ''
                    platform: Amazon Web Services
                    applianceName: BM-v6-AWS
                    applianceUid: f654663b-f348-492c-adb6-785244ee93ca
                    bucket: az-bucket-002
                    folder: rt2-tenant
                    region: EU (Frankfurt) (eu-central-1)
                    storageClass: S3
                    isEncrypted: true
                    immutabilityEnabled: false
                    organizationName: rt2
                    organizationUid: 6eb51175-0421-4d72-bc5b-f4ebb137eb40
                    siteName: WIN-TUCSQEMDMG6
                    siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                    creatingState: 
                  - instanceUid: 41bc79a2-0502-4768-83af-c71aee912643
                    repositoryName: rt2-rep2
                    description: ''
                    platform: Amazon Web Services
                    applianceName: BM-v6-AWS
                    applianceUid: f654663b-f348-492c-adb6-785244ee93ca
                    bucket: bmb-bucket-bm
                    folder: rt2-reseller
                    region: EU (Frankfurt) (eu-central-1)
                    storageClass: S3
                    isEncrypted: true
                    immutabilityEnabled: false
                    organizationName: rt2
                    organizationUid: 6eb51175-0421-4d72-bc5b-f4ebb137eb40
                    siteName: WIN-TUCSQEMDMG6
                    siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                    creatingState: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/accounts/existing':
    post:
      tags:
        - Public Cloud Azure
      summary: Add Existing Microsoft Azure Account
      description: Registers an existing Microsoft Azure on a Veeam Cloud Connect site with the specified UID.
      operationId: AddExistingPublicCloudAzureAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudExistingAzureAccountInput'
            example:
              accountName: 'a_[b142487f-05d6-416a-8a03-c95cbcfed149]'
              description: 'Created at [1:46:54 PM] by [PortalAdministrator]'
              environment: Global
              applicationId: 09a9bc28-77fd-43c7-ab60-6f8ddc4fffca
              tenantId: 070e5135-0c8b-4598-9a4d-8258e941fcd9
              secret: uXU9S~HkIG.4ENKZIZE_BwqDd15hfsSkTbwSVa0a
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: 91bd2d80-e9ba-4a62-9b3a-2f6ee26a40ba
                  credentialTag: c9d3fd05-00cb-49e2-b0db-75746c42f442
                  accountName: 'a_[b142487f-05d6-416a-8a03-c95cbcfed149]'
                  description: 'Created at [1:46:54 PM] by [PortalAdministrator]; Created by Veeam Service Provider Console. My Company: VSPC\Administrator'
                  environment: Global
                  tenantId: 070e5135-0c8b-4598-9a4d-8258e941fcd9
                  secret: 
                  applicationId: 09a9bc28-77fd-43c7-ab60-6f8ddc4fffca
                  createdBy: VSPC\Administrator
                  siteUid: 2938682b-42e2-47a0-b3f5-9dc4d40e933c
                  organizationUid: 28dd164b-1f9c-4b71-b226-de78a8cc3436
                  appliances: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/accounts':
    post:
      tags:
        - Public Cloud Azure
      summary: Create Microsoft Azure Account
      description: Creates a new Microsoft Azure account registered on a Veeam Cloud Connect site with the specified UID.
      operationId: CreatePublicCloudAzureAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAzureAccountInput'
            example:
              accountName: 'a_[b142487f-05d6-416a-8a03-c95cbcfed149]'
              description: 'Created at [1:46:54 PM] by [PortalAdministrator]'
              environment: Global
              userCode: GPSCNGW9V
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: 91bd2d80-e9ba-4a62-9b3a-2f6ee26a40ba
                  credentialTag: c9d3fd05-00cb-49e2-b0db-75746c42f442
                  accountName: 'a_[b142487f-05d6-416a-8a03-c95cbcfed149]'
                  description: 'Created at [1:46:54 PM] by [PortalAdministrator]; Created by Veeam Service Provider Console. My Company: VSPC\Administrator'
                  environment: Global
                  tenantId: 070e5135-0c8b-4598-9a4d-8258e941fcd9
                  secret: 
                  applicationId: 09a9bc28-77fd-43c7-ab60-6f8ddc4fffca
                  createdBy: VSPC\Administrator
                  siteUid: 2938682b-42e2-47a0-b3f5-9dc4d40e933c
                  organizationUid: 28dd164b-1f9c-4b71-b226-de78a8cc3436
                  appliances: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    get:
      tags:
        - Public Cloud Azure
      summary: Get All Microsoft Azure Accounts
      description: Returns a collection resource representation of all Microsoft Azure accounts registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureAccounts
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAzureAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - accountUid: 07e5070f-f170-4a89-8e44-206b56692624
                    credentialTag: 18e64d1b-a85c-497a-9e02-5520efab962e
                    accountName: 'a_[e1a2c104-9906-4440-8e5c-7c4831651c82]'
                    description: 'Created at [1:43:46 PM] by [PortalAdministrator]; Created by Veeam Service Provider Console. My Company: VSPC\Administrator'
                    environment: Global
                    tenantId: 070e5135-0c8b-4598-9a4d-8258e941fcd9
                    secret: 
                    applicationId: 09a9bc28-77fd-43c7-ab60-6f8ddc4fffca
                    createdBy: VSPC\Administrator
                    siteUid: 2938682b-42e2-47a0-b3f5-9dc4d40e933c
                    organizationUid: 28dd164b-1f9c-4b71-b226-de78a8cc3436
                    appliances:
                      - 9fc49f82-046d-469f-8b20-13fafe771046
                  - accountUid: e67851a6-4ae3-4881-aaa1-d35aa9b67409
                    credentialTag: 84387470-e9f1-4240-a17a-3651c50dff78
                    accountName: 'a_[c073eac7-d143-4f17-9a7d-0e454fb234f5]'
                    description: 'Created at [2:04:20 PM] by [PortalAdministrator]; Created by Veeam Service Provider Console. My Company: VSPC\Administrator'
                    environment: Global
                    tenantId: 070e5135-0c8b-4598-9a4d-8258e941fcd9
                    secret: 
                    applicationId: 09a9bc28-77fd-43c7-ab60-6f8ddc4fffca
                    createdBy: VSPC\Administrator
                    siteUid: 2938682b-42e2-47a0-b3f5-9dc4d40e933c
                    organizationUid: 28dd164b-1f9c-4b71-b226-de78a8cc3436
                    appliances: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/accounts/{accountUid}':
    get:
      tags:
        - Public Cloud Azure
      summary: Get Microsoft Azure Account
      description: Returns a resource representation of a Microsoft Azure account with the specified UID.
      operationId: GetPublicCloudAzureAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: Microsoft Azure account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: e67851a6-4ae3-4881-aaa1-d35aa9b67409
                  credentialTag: 84387470-e9f1-4240-a17a-3651c50dff78
                  accountName: 'a_[c073eac7-d143-4f17-9a7d-0e454fb234f5]'
                  description: 'Created at [2:04:20 PM] by [PortalAdministrator]; Created by Veeam Service Provider Console. My Company: VSPC\Administrator'
                  environment: Global
                  tenantId: 070e5135-0c8b-4598-9a4d-8258e941fcd9
                  secret: 
                  applicationId: 09a9bc28-77fd-43c7-ab60-6f8ddc4fffca
                  createdBy: VSPC\Administrator
                  siteUid: 2938682b-42e2-47a0-b3f5-9dc4d40e933c
                  organizationUid: 28dd164b-1f9c-4b71-b226-de78a8cc3436
                  appliances: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PublicCloudAzureAccount'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    patch:
      tags:
        - Public Cloud Azure
      summary: Modify Microsoft Azure Account
      description: Modifies a Microsoft Azure account with the specified UID.
      operationId: PatchPublicCloudAzureAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: Microsoft Azure account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 070e5135-0c8b-4598-9a4d-8258e941fcd9
                path: /tenantId
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: e67851a6-4ae3-4881-aaa1-d35aa9b67409
                  credentialTag: 84387470-e9f1-4240-a17a-3651c50dff78
                  accountName: 'a_[c073eac7-d143-4f17-9a7d-0e454fb234f5]'
                  description: 'Created at [2:04:20 PM] by [PortalAdministrator]; Created by Veeam Service Provider Console. My Company: VSPC\Administrator'
                  environment: Global
                  tenantId: 070e5135-0c8b-4598-9a4d-8258e941fcd9
                  secret: 
                  applicationId: 09a9bc28-77fd-43c7-ab60-6f8ddc4fffca
                  createdBy: VSPC\Administrator
                  siteUid: 2938682b-42e2-47a0-b3f5-9dc4d40e933c
                  organizationUid: 28dd164b-1f9c-4b71-b226-de78a8cc3436
                  appliances: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PublicCloudAzureAccount'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Public Cloud Azure
      summary: Delete Microsoft Azure Account
      description: Deletes a Microsoft Azure account with the specified UID.
      operationId: RemovePublicCloudAzureAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: Microsoft Azure account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/accounts/{accountUid}/renew':
    post:
      tags:
        - Public Cloud Azure
      summary: Renew Microsoft Azure Account Secret
      description: Renews client secret of a Microsoft Azure account with the specified UID.
      operationId: RenewPublicCloudAzureAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: Microsoft Azure account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAzureAccountRenew'
            example:
              userCode: GPSCNGW9V
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountUid: 91bd2d80-e9ba-4a62-9b3a-2f6ee26a40ba
                  credentialTag: c9d3fd05-00cb-49e2-b0db-75746c42f442
                  accountName: 'a_[b142487f-05d6-416a-8a03-c95cbcfed149]'
                  description: 'Created at [1:46:54 PM] by [PortalAdministrator]; Created by Veeam Service Provider Console. My Company: VSPC\Administrator'
                  environment: Global
                  tenantId: 070e5135-0c8b-4598-9a4d-8258e941fcd9
                  secret: 
                  applicationId: 09a9bc28-77fd-43c7-ab60-6f8ddc4fffca
                  createdBy: VSPC\Administrator
                  siteUid: 2938682b-42e2-47a0-b3f5-9dc4d40e933c
                  organizationUid: 28dd164b-1f9c-4b71-b226-de78a8cc3436
                  appliances: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/accounts/deviceCode':
    get:
      tags:
        - Public Cloud Azure
      summary: Get Device Authentication Code
      description: Returns a resource representation of a Microsoft Azure device authentication code.
      operationId: GetPublicCloudAzureDeviceCode
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: environment
          in: query
          description: Type of a Microsoft Azure cloud environment.
          required: true
          schema:
            enum:
              - Global
              - Germany
              - China
              - UsGovernment
            type: string
            x-ms-enum:
              name: EAzureEnvironmentIdQuery
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureDeviceCode'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  userCode: GPSCNGW9V
                  verificationUrl: https://microsoft.com/devicelogin
                  deviceCodeToken: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/subscriptions':
    get:
      tags:
        - Public Cloud Azure
      summary: Get All Microsoft Azure Subscriptions
      description: Returns a collection resource representation of all Microsoft Azure subscriptions registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureSubscriptions
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Microsoft Azure connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAzureSubscription'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - subscriptionId: 3a485c0d-3911-48a9-94ff-fe325503e892
                    subscriptionName: Enterprise - Data Management - EMEA
                    environment: Global
                    tenantId: 070e5135-0c8b-4598-9a4d-8258e941fcd9
                  - subscriptionId: a15da0de-9c68-4650-b910-175160f89567
                    subscriptionName: Enterprise - Data Management - USA
                    environment: Global
                    tenantId: d873d97c-20bf-49f8-a047-e21e2591e412
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/connection':
    post:
      tags:
        - Public Cloud Azure
      summary: Create Microsoft Azure Connection
      description: Creates a new Microsoft Azure connection registered on a Veeam Cloud Connect site with the specified UID.
      operationId: CreatePublicCloudAzureConnection
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: query
          description: Microsoft Azure account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: environment
          in: query
          description: Type of a Microsoft Azure cloud environment.
          required: true
          schema:
            enum:
              - Global
              - Germany
              - China
              - UsGovernment
            type: string
            x-ms-enum:
              name: EAzureEnvironmentIdQuery
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureConnection'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  connectionUid: de26c441-b776-4aff-bcc3-9f8336d06b1a
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/connection/{connectionUid}':
    delete:
      tags:
        - Public Cloud Azure
      summary: Delete Microsoft Azure Connection
      description: Deletes a Microsoft Azure connection with the specified UID.
      operationId: DeletePublicCloudAzureConnection
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: path
          description: Microsoft Azure connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/networks':
    get:
      tags:
        - Public Cloud Azure
      summary: Get All Microsoft Azure Networks
      description: Returns a collection resource representation of all Microsoft Azure virtual networks registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureNetworks
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Microsoft Azure connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: subscriptionId
          in: query
          description: Microsoft Azure subscription ID.
          required: true
          schema:
            type: string
        - name: dataCenterId
          in: query
          description: Microsoft Azure datacenter ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAzureNetwork'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - networkId: /subscriptions/3a485c0d-3911-48a9-94ff-fe325503e892/resourcegroups/dm-vspc-pc/providers/microsoft.network/virtualnetworks/dm-vspc-pc-net
                    networkName: dm-vspc-pc-net
                    subnets:
                      - addressSpace: 10.0.0.0/24
                        subnetName: default
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/ipAddresses':
    get:
      tags:
        - Public Cloud Azure
      summary: Get Microsoft Azure IP Addresses
      description: Returns a collection resource representation of all existing IP addresses available to Microsoft Azure accounts registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureExistingIpAddresses
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Microsoft Azure connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: subscriptionId
          in: query
          description: Microsoft Azure subscription ID.
          required: true
          schema:
            type: string
        - name: dataCenterId
          in: query
          description: Microsoft Azure datacenter ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAppliancePublicAddress'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - applianceIpAddressId: 
                    ipAddress: 89.296.226.25
                    name: aza1
                  - applianceIpAddressId: 
                    ipAddress: 89.296.231.31
                    name: aza2
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/backupServerIpAddresses':
    get:
      tags:
        - Public Cloud Azure
      summary: Get Veeam Cloud Connect Site IP Addresses
      description: Returns a resource representation of all IP addresses assigned in Microsoft Azure to a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureBackupServerIpAddresses
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudBackupServerPublicAddress'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupServerIpAddresses: 89.296.231.31
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/keys':
    get:
      tags:
        - Public Cloud Azure
      summary: Get All Microsoft Azure Cryptographic Keys
      description: Returns a collection resource representation of all Microsoft Azure cryptographic keys registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureKeys
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Microsoft Azure connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: subscriptionId
          in: query
          description: Microsoft Azure subscription ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAzureKey'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - keyPairName: dma-vspc-azure-pc-plugin
                  - keyPairName: dma-vspc-azure-pc-plugin2
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    post:
      tags:
        - Public Cloud Azure
      summary: Create Microsoft Azure Cryptographic Key
      description: Creates a Microsoft Azure cryptographic key registered on a Veeam Cloud Connect site with the specified UID.
      operationId: CreatePublicCloudAzureKey
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAzureKeyPairInput'
            example:
              connectionUid: da21b612-7f14-46cd-b32f-ec9407212147
              subscriptionId: 8126721b-6b4a-4647-bbd2-259ebf802ff7
              dataCenterId: 997c5444-8786-48ec-be2a-c3f80a535dfd
              resourceGroupName: rg-ct-management
              keyPairName: dma-vspc-azure-pc-plugin
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureNewKeyPair'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  keyPairName: dma-vspc-azure-pc-plugin
                  privateKey: '-----BEGIN RSA PRIVATE KEY-----MIICXAIBAAKBgQDaU+LpGlbcac2oLrp11sTSOYCAVyGbC9xoZ4+DrCRQnjY50GchPSuVM6G2lkN2v8yXf9UJEWRlBJvMF+ggdORC8QU5WKjGRJ2r85QYt1TCcjHa6s8WIbFvZmlMcveMd7qKWjFH4DRgYG1Lwm7xY4OD5I+ADWFoNGd9c6tOKNC8QIDAQABAoGADSzwzaZ0RXrxGUwwnnnmiNVFhvk7IvM1SuutAoI58s+JcDW+c4gQgEGMactpqNnsS9xAC/sLtvjvOgLbVFIZkEAYN67kFOcAKUVWozygXXNdb7TQGa5eW8xVBy2evYZo7W+OVTvMm1uJHWcNMjFjw4xlRTlRKgCqiZwOJfcIM20CQQDucLC2qgDCTjiirNlMBUhJ6e5tj7vAV1wxGfoBDroEBzTGuu71jQyESZRLucOMARDUdGdRAgjwe8F01ii27mEvAkEA6mgD3kW6HI2zjwxdTnerG/1qwgBXLaGnU4yWLGWLPcCto8nsz93RjYdm7ln2EqyG3ALptJIJrYRiEH0k9MhV3wJAXXSv3ridWYs9KY2kEebUIZxeBnVaupXDHb+3vKhgAmospmPoezgQmt0YEeI6oepdBVimkhrBFDj9Z2T1SlX+owJBAIC7jyRK9uMnjy1IhRXK8tX0XuUcesQ8u0BPPUo0mjvXzYTeKIggMi2f5w+PqGypA4dgsijQ6y+4PIMBt4IXY9ECQE3j0kdvxF66n7VUFm5LTCNqKkkU1EyCU+yC5wLd3Xf7jRHZWV9vKrbFn5jNxz+u1rOMkKx4MrPf+Tvt+SWb0nI=-----END RSA PRIVATE KEY-----'
                  fileName: admin_azure_keys
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/securityGroups':
    get:
      tags:
        - Public Cloud Azure
      summary: Get All Microsoft Azure Security Groups
      description: Returns a collection resource representation of all Microsoft Azure network security groups registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureSecurityGroups
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Microsoft Azure connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: subscriptionId
          in: query
          description: Microsoft Azure subscription ID.
          required: true
          schema:
            type: string
        - name: dataCenterId
          in: query
          description: Microsot Azure datacenter ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAzureSecurityGroup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - securityGroupId: /subscriptions/3a496c0d-3911-48a9-94ff-fe325503e892/resourcegroups/dma-vspc-pc/providers/microsoft.network/networksecuritygroups/dma-vspc-pc-sg
                    securityGroupName: dma-vspc-pc-sg
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/dataCenters':
    get:
      tags:
        - Public Cloud Azure
      summary: Get All Microsoft Azure Datacenters
      description: Returns a collection resource representation of all Microsoft Azure datacenters registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureDataCenters
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Microsoft Azure connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: subscriptionId
          in: query
          description: Microsoft Azure subscription ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAzureDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - dataCenterId: eastus
                    dataCenterName: East US
                  - dataCenterId: eastus2
                    dataCenterName: East US 2
                  - dataCenterId: westus
                    dataCenterName: West US
                  - dataCenterId: centralus
                    dataCenterName: Central US
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/resourceGroups':
    get:
      tags:
        - Public Cloud Azure
      summary: Get All Microsoft Azure Resource Groups
      description: Returns a collection resource representation of all Microsoft Azure resource groups registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureResourceGroups
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Microsoft Azure connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: subscriptionId
          in: query
          description: Microsoft Azure subscription ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAzureResourceGroup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - resourceGroupName: rg-ct-management
                    environment: Global
                    subscriptionId: 3a485c0d-3911-48a9-94ff-fe325503e892
                    dataCenterId: northeurope
                  - resourceGroupName: NetworkWatcherRG
                    environment: Global
                    subscriptionId: 3a485c0d-3911-48a9-94ff-fe325503e892
                    dataCenterId: westeurope
                  - resourceGroupName: dmaupdate
                    environment: Global
                    subscriptionId: 3a485c0d-3911-48a9-94ff-fe325503e892
                    dataCenterId: westeurope
                  - resourceGroupName: dma-vspc
                    environment: Global
                    subscriptionId: 3a485c0d-3911-48a9-94ff-fe325503e892
                    dataCenterId: westeurope
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/virtualMachines':
    get:
      tags:
        - Public Cloud Azure
      summary: Get All Microsoft Azure VMs
      description: Returns a collection resource representation of all Microsoft Azure VMs registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAzureVirtualMachines
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: connectionUid
          in: query
          description: Microsoft Azure connection UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: subscriptionId
          in: query
          description: Microsoft Azure subscription ID.
          required: true
          schema:
            type: string
        - name: dataCenterId
          in: query
          description: Microsoft Azure datacenter ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAzureVirtualMachine'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - virtualMachineId: /subscriptions/3a496c0d-3911-48a9-94ff-fe325503e892/resourcegroups/dma-vspc-pc/providers/microsoft.compute/virtualmachines/dmavspcazurepluginpermanent
                    virtualMachineName: dmaVspcAzurePluginPermanent
                  - virtualMachineId: /subscriptions/13e8e398-9860-4de9-9a0c-290d9724c6bf/resourcegroups/dma-vspc-pc2/providers/microsoft.compute/virtualmachines/dmavspcazurepluginproduction
                    virtualMachineName: dmaVspcAzurePluginProduction
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/appliances/deploy':
    post:
      tags:
        - Public Cloud AWS
      summary: Create Veeam Backup for AWS Appliance
      description: Creates a new Veeam Backup for AWS appliance registered on a Veeam Cloud Connect site with the specified UID.
      operationId: CreateNewPublicCloudAwsAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAwsNewApplianceInput'
            example:
              account:
                connectionUid: c0300e84-e8c0-40df-97f1-cbdbdcecafa9
                accountUid: 73f86291-d5ff-423c-88da-9b60be21964d
                dataCenterId: eu-central-1
                regionId: Global
              virtualMachine:
                virtualMachineName: dma12
                description: 'Created at [1:19:55 PM] by [PortalAdministrator]'
              network:
                networkId: vpc-09ae9e55dd75a5f6b
                subnetId: subnet-0b2131c783c96c1f9
                securityGroupId: sg-0ad0a345b8059c199
              ipAddress:
                applianceIp:
                  applianceIpAddressId: 
                  newIpAddressType: dynamic
                backupServerIpAddresses: 89.185.226.14/32
              guestOsCredentials:
                guestOsCredentialsUid: 18f0a96a-16e1-4b27-ace3-307fd65da25a
                keyPairName: VeeamDefaultKeyPair
                timeZoneId: Europe/Prague
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudApplianceDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: 3718f965-ba77-49b7-bc54-ce1819b737b5
                  managementAgentUid: 8467eb32-3398-4229-b151-11edfe89e9d7
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/appliances/connect':
    post:
      tags:
        - Public Cloud AWS
      summary: Connect Veeam Backup for AWS Appliance
      description: Connects an existing Veeam Backup for AWS appliance registered on a Veeam Cloud Connect site with the specified UID.
      operationId: AddExistingPublicCloudAwsAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAwsAddExistingApplianceInput'
            example:
              account:
                connectionUid: 9dca8c1d-a46b-4412-b51b-93fe528cb270
                dataCenterId: eu-central-1
                regionId: Global
                accountUid: 1d491e23-0e06-4b8f-9712-eef688d46c3f
              virtualMachine:
                virtualMachineId: i-0636185fb7c5b174d
                description: Existing appliance.
              network: 
              guestOsCredentials:
                guestOsCredentialsUid: 8955f416-917e-48e5-95ba-954524d19831
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudApplianceDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: 73decc97-a8a0-4c23-aeb9-41bc78a3dd29
                  managementAgentUid: 8467eb32-3398-4229-b151-11edfe89e9d7
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/appliances/validate':
    post:
      tags:
        - Public Cloud AWS
      summary: Validate Veeam Backup for AWS Appliance
      description: Validates an existing Veeam Backup for AWS appliance connection registered on a Veeam Cloud Connect site with the specified UID.
      operationId: ValidateExistingPublicCloudAwsApplianceConnection
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAwsAddExistingApplianceInput'
            example:
              account:
                connectionUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                dataCenterId: eu-central-1
                regionId: Global
                accountUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
              virtualMachine:
                virtualMachineId: i-3583285fb7c5b174d
                description: Existing appliance.
              network: 
              guestOsCredentials:
                guestOsCredentialsUid: 6f213654-b538-4695-ac69-aa677e41862e
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudApplianceConnectionValidationResult'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  errorMessage: 'To perform this action, verify the appliance deployment settings.'
                  errorType: Certificate
                  certificateThumbprint: 1C112D7F5A4BDA6A4AF2754997025F8CA1E18275
                  certificate:
                    issuedTo: OU=AWS Backup
                    issuedBy: 'OU=AWS Backup, O=Veeam Software, E=support@veeam.com, C=CH, S=Zug, CN=Veeam AWS Backup Local CA 57356e51-c550-4f06-ac1d-fc39d376ea52'
                    friendlyName: ''
                    thumbprint: 1C112D7F5A4BDA6A4AF2754997025F8CA1E18275
                    serialNumber: '0330255790'
                    expirationDate: '2026-06-24T15:49:00.0000000+02:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/appliances/connect':
    post:
      tags:
        - Public Cloud Azure
      summary: Connect Veeam Backup for Microsoft Azure Appliance
      description: Connect an existing Veeam Backup for Microsoft Azure appliance registered on a Veeam Cloud Connect site with the specified UID.
      operationId: AddExistingPublicCloudAzureAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAzureAddExistingApplianceInput'
            example:
              account:
                accountUid: 07e5070f-f170-4a89-8e44-206b56692624
                subscriptionId: 3a485c0d-3911-48a9-94ff-fe325503e892
                dataCenterId: westeurope
                connectionUid: eefa8303-cf95-4912-9ba6-3ba635d2ba86
                environment: Global
              virtualMachine:
                virtualMachineId: /subscriptions/13e8e398-9860-4de9-9a0c-290d9724c6bf/resourcegroups/dma-vspc-pc/providers/microsoft.compute/virtualmachines/dmavspcazurepluginpermanent
                description: Existing appliance added.
              network: 
              guestOsCredentials:
                guestOsCredentialsUid: e2cfa41f-bc14-41e1-b6a0-2fdb04178e37
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudApplianceDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: f7a75a1d-204f-472e-a90f-8f2ef863c29b
                  managementAgentUid: 8467eb32-3398-4229-b151-11edfe89e9d7
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/appliances/deploy':
    post:
      tags:
        - Public Cloud Azure
      summary: Create Veeam Backup for Microsoft Azure Appliance
      description: Creates a new Veeam Backup for Microsoft Azure appliance regitered on a Veeam Cloud Connect site with the specified UID.
      operationId: CreateNewPublicCloudAzureAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudAzureNewApplianceInput'
            example:
              account:
                connectionUid: de26c441-b776-4aff-bcc3-9f8336d06b1a
                environment: Global
                resourceGroupName: dma-vspc-pc
                subscriptionId: 0381fa98-9d97-4b9a-923a-4746bdd9fbcb
                dataCenterId: westeurope
                accountUid: 91bd2d80-e9ba-4a62-9b3a-2f6ee26a40ba
              virtualMachine:
                virtualMachineName: dmaVspcAzurePluginTemporary
                description: 'Created at [1:47:35 PM] by [PortalAdministrator]'
              network:
                networkId: /subscriptions/0381fa98-9d97-4b9a-923a-4746bdd9fbcb/resourcegroups/dma-vspc-pc/providers/microsoft.network/virtualnetworks/dma-vspc-pc-net
                subnetName: default
                securityGroupId: /subscriptions/0381fa98-9d97-4b9a-923a-4746bdd9fbcb/resourcegroups/dma-vspc-pc/providers/microsoft.network/networksecuritygroups/dma-vspc-pc-sg
              ipAddress:
                backupServerIpAddresses: 89.296.226.25
                applianceIp:
                  applianceIpAddressId: 
                  newIpAddressType: dynamic
              guestOsCredentials:
                guestOsCredentialsUid: f7d20bb9-4c56-46d6-aedc-738e77d104a2
                keyPairName: dma-vspc-azure-plugin
                timeZoneId: Etc/GMT+2
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudApplianceDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: 8375961c-f392-4d0f-a850-05aa66ad7c9c
                  managementAgentUid: 8467eb32-3398-4229-b151-11edfe89e9d7
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/aws/appliances/{applianceUid}':
    get:
      tags:
        - Public Cloud AWS
      summary: Get Veeam Backup for AWS Appliance
      description: Returns a resource representation of an Veeam Backup for AWS appliance with the specified UID.
      operationId: GetPublicCloudAwsAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for AWS appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAwsAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  managementAgentUid: 0381fa98-9d97-4b9a-923a-4746bdd9fbcb
                  instanceUid: 10ac5271-1a53-4d1a-9677-06d2dece4ae3
                  accountUid: 472119cc-8425-4764-8c91-8b20f2d539b5
                  description: My Company backup appliance
                  publicAddress: ec3-4-53-28.eu-central-1.compute.amazonaws.com
                  privateNetworkAddress: 
                  guestOsCredentialsUid: 59816328-d5c8-41f2-8147-f2fbb44a1aa8
                  certificateThumbprint: 25033869D0169378BD6C0E7C325E05CH39C6G8B5
                  dataCenterId: us-east-1
                  regionId: Global
                  resourceId: i-0ff45f5bed8712ad1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PublicCloudAwsAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    patch:
      tags:
        - Public Cloud AWS
      summary: Modify Veeam Backup for AWS Appliance
      description: Modifies an Veeam Backup for AWS appliance with the specified UID.
      operationId: PatchPublicCloudAwsAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for AWS appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: My Company backup appliance
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAwsAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  managementAgentUid: 0381fa98-9d97-4b9a-923a-4746bdd9fbcb
                  instanceUid: 10ac5271-1a53-4d1a-9677-06d2dece4ae3
                  accountUid: 472119cc-8425-4764-8c91-8b20f2d539b5
                  description: My Company backup appliance
                  publicAddress: ec3-4-53-28.eu-central-1.compute.amazonaws.com
                  privateNetworkAddress: 
                  guestOsCredentialsUid: 59816328-d5c8-41f2-8147-f2fbb44a1aa8
                  certificateThumbprint: 25033869D0169378BD6C0E7C325E05CH39C6G8B5
                  dataCenterId: us-east-1
                  regionId: Global
                  resourceId: i-0ff45f5bed8712ad1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PublicCloudAwsAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/azure/appliances/{applianceUid}':
    get:
      tags:
        - Public Cloud Azure
      summary: Get Veeam Backup for Microsoft Azure Appliance
      description: Returns a resource representation of a Veeam Backup for Microsoft Azure appliance with the specified UID.
      operationId: GetPublicCloudAzureAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for Microsoft Azure appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: a9440e08-d2d4-49e5-ba2e-03ff2036e12f
                  managementAgentUid: 4f7605ff-8084-426c-b11b-47e139e5e800
                  guestOsCredentialsUid: 87d43a4a-d31a-4b12-99b7-cdf7245ff268
                  accountUid: a23d2fdb-06c4-4d8d-86c8-377960adf1ee
                  environment: Global
                  subscriptionId: 280921a2-220d-45c9-92dd-82b6d5a3a78f
                  tenantId: 97438793-c913-4a51-8485-d33056db7b9b
                  description: 
                  publicAddress: az-bvd-807.westeurope.cloudapp.azure.com
                  privateNetworkAddress: 
                  virtualMachineId: /subscriptions/d873d97c-20bf-49f8-a047-e21e2591e41/resourcegroups/az-azure/providers/microsoft.compute/virtualmachines/tech4
                  certificateThumbprint: 77CC668G483A2BB323844400D7A7AFC642E9D2EF
                  dataCenterId: westeurope
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PublicCloudAzureAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    patch:
      tags:
        - Public Cloud Azure
      summary: Modify Veeam Backup for Microsoft Azure Appliance
      description: Modifies a Veeam Backup for Microsoft Azure appliance with the specified UID.
      operationId: PatchPublicCloudAzureAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for Microsoft Azure appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Patched Azure appliance
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudAzureAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: a9440e08-d2d4-49e5-ba2e-03ff2036e12f
                  managementAgentUid: 4f7605ff-8084-426c-b11b-47e139e5e800
                  guestOsCredentialsUid: 87d43a4a-d31a-4b12-99b7-cdf7245ff268
                  accountUid: a23d2fdb-06c4-4d8d-86c8-377960adf1ee
                  environment: Global
                  subscriptionId: 280921a2-220d-45c9-92dd-82b6d5a3a78f
                  tenantId: 97438793-c913-4a51-8485-d33056db7b9b
                  description: Patched Azure appliance
                  publicAddress: az-bvd-807.westeurope.cloudapp.azure.com
                  privateNetworkAddress: 
                  virtualMachineId: /subscriptions/d873d97c-20bf-49f8-a047-e21e2591e412/resourcegroups/az-azure/providers/microsoft.compute/virtualmachines/tech4
                  certificateThumbprint: 77CC668G483A2BB323844400D7A7AFC642E9D2EF
                  dataCenterId: westeurope
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PublicCloudAzureAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /infrastructure/sites/publicCloud/appliances:
    get:
      tags:
        - Public Cloud
      summary: Get Veeam Backup for Public Clouds Appliances Registered on All Veeam Cloud Connect Sites
      description: Returns a collection resource representation of Veeam Backup for Public Clouds appliances registered on all Veeam Cloud Connect sites.
      operationId: GetPublicCloudAppliances
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SitePublicCloudAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 65207396-e42c-48e8-b8b5-691482da92e7
                    siteUid: d7be45c1-cb7f-4bb9-adad-1bc9be5448c3
                    publicAddress: 3.88.182.363
                    applianceName: BM-v6-AWS
                    description: ''
                    region: eu-1
                    certificateThumbprint: 4D5546274EC142D3D61FA3FC8C782B47DCA56C3E
                    remoteUiAccessEnabled: false
                    selfServicePortalUrl: https://3.88.182.363/
                    organizationUid: 507e9b59-b83d-489d-ab0c-e34d23ded114
                    mappedOrganizationUid: 6eb51175-1521-4d72-bc5b-f4ebb137eb40
                    managementAgentUid: 7d66a63f-bb55-4013-8402-7a29a5387527
                    version: 7.1.0.8
                    status: Healthy
                    statusMessage: ''
                    platform: Amazon
                    deploymentStatus: Success
                  - instanceUid: 7026a7fc-59bc-468e-9cd8-b585f5fff01a
                    siteUid: d7be45c1-cb7f-4bb9-adad-1bc9be5448c3
                    publicAddress: bm-v5-azure.westeurope.cloudapp.azure.com
                    applianceName: BM-v5-Azure
                    description: Existing appliance added in rest test.
                    region: westeurope
                    certificateThumbprint: 1C112D7F5A4BDA6A4AF2754997025F8CA1E18275
                    remoteUiAccessEnabled: false
                    selfServicePortalUrl: https://bm-v5-azure.westeurope.cloudapp.azure.com/
                    organizationUid: 0c5fb43b-50b7-4aa7-8efc-7bc5dbdcc81c
                    mappedOrganizationUid: 004ba723-a789-4525-ac8e-777a8dd692c7
                    managementAgentUid: 7d66a63f-bb55-4013-8402-7a29a5387527
                    version: 6.0.1.267
                    status: Healthy
                    statusMessage: ''
                    platform: Azure
                    deploymentStatus: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/{siteUid}/publicCloud/appliances':
    get:
      tags:
        - Public Cloud
      summary: Get All Veeam Backup for Public Clouds Appliances Registered on Veeam Cloud Connect Site
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds appliances registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudAppliancesByServer
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SitePublicCloudAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 65207396-e42c-48e8-b8b5-691482da92e7
                    siteUid: d7be45c1-cb7f-4bb9-adad-1bc9be5448c3
                    publicAddress: 3.88.182.363
                    applianceName: BM-v6-AWS
                    description: ''
                    region: eu-1
                    certificateThumbprint: 4D5546274EC142D3D61FA3FC8C782B47DCA56C3E
                    remoteUiAccessEnabled: false
                    selfServicePortalUrl: https://3.88.182.363/
                    organizationUid: 507e9b59-b83d-489d-ab0c-e34d23ded114
                    mappedOrganizationUid: 6eb51175-1521-4d72-bc5b-f4ebb137eb40
                    managementAgentUid: 7d66a63f-bb55-4013-8402-7a29a5387527
                    version: 7.1.0.8
                    status: Healthy
                    statusMessage: ''
                    platform: Amazon
                    deploymentStatus: Success
                  - instanceUid: 7026a7fc-59bc-468e-9cd8-b585f5fff01a
                    siteUid: d7be45c1-cb7f-4bb9-adad-1bc9be5448c3
                    publicAddress: bm-v5-azure.westeurope.cloudapp.azure.com
                    applianceName: BM-v5-Azure
                    description: ''
                    region: westeurope
                    certificateThumbprint: 1C112D7F5A4BDA6A4AF2754997025F8CA1E18275
                    remoteUiAccessEnabled: false
                    selfServicePortalUrl: https://bm-v5-azure.westeurope.cloudapp.azure.com/
                    organizationUid: 0c5fb43b-50b7-4aa7-8efc-7bc5dbdcc81c
                    mappedOrganizationUid: 004ba723-a789-4525-ac8e-777a8dd692c7
                    managementAgentUid: 7d66a63f-bb55-4013-8402-7a29a5387527
                    version: 6.0.1.267
                    status: Healthy
                    statusMessage: ''
                    platform: Azure
                    deploymentStatus: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/{siteUid}/publicCloud/appliances/{applianceUid}':
    get:
      tags:
        - Public Cloud
      summary: Get Veeam Backup for Public Clouds Appliance Registered on Veeam Cloud Connect Site
      description: Returns a resource representation of a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect site.
      operationId: GetPublicCloudAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SitePublicCloudAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 7026a7fc-59bc-468e-9cd8-b585f5fff01a
                  siteUid: d7be45c1-cb7f-4bb9-adad-1bc9be5448c3
                  publicAddress: bm-v5-azure.westeurope.cloudapp.azure.com
                  applianceName: BM-v5-Azure
                  description: ''
                  region: westeurope
                  certificateThumbprint: 1C112D7F5A4BDA6A4AF2754997025F8CA1E18275
                  remoteUiAccessEnabled: false
                  selfServicePortalUrl: https://bm-v5-azure.westeurope.cloudapp.azure.com/
                  organizationUid: 0c5fb43b-50b7-4aa7-8efc-7bc5dbdcc81c
                  mappedOrganizationUid: 004ba723-a789-4525-ac8e-777a8dd692c7
                  managementAgentUid: 7d66a63f-bb55-4013-8402-7a29a5387527
                  version: 6.0.1.267
                  status: Healthy
                  statusMessage: ''
                  platform: Azure
                  deploymentStatus: Success
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Public Cloud
      summary: Delete Veeam Backup for Public Clouds Appliance Registered on Veeam Cloud Connect Site
      description: Removes a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect site.
      operationId: DeletePublicCloudAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: withCloudResources
          in: query
          description: Defines whether cloud resources must be deleted along with Veeam Backup for Public Clouds appliance data.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/sites/{siteUid}/publicCloud/appliances/{applianceUid}/upgrade':
    post:
      tags:
        - Public Cloud
      summary: Upgrade Veeam Backup for Public Clouds Appliance Registered on Veeam Cloud Connect Site
      description: Upgrades a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect site.
      operationId: UpgradePublicCloudAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/appliances/patches/upload/multipart/create':
    post:
      tags:
        - Preview Operations
      summary: Starts Patch Upload to Veeam Backup for Public Clouds Appliances registered on Veeam Cloud Connect Site
      description: Initiates an upload of a patch to Veeam Backup for Public Clouds appliances registered on a Veeam Cloud Connect site with the specified UID.
      operationId: CreatePublicCloudMultipartPatch
      parameters:
        - name: siteUid
          in: path
          description: Veeam Cloud Connect site UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePublicCloudMultipartPatchInput'
            example:
              fileName: veeamazurebackup_6.0.1.269_amd64.deb
              platform: Azure
              fileSize: 164106630
        required: true
      responses:
        '200':
          description: Upload UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: 97530cc6-56ec-4939-9252-5f36733b5ec5
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/appliances/patches/upload/multipart/uploadPart':
    post:
      tags:
        - Preview Operations
      summary: Upload Patch File Chunk to Veeam Backup for Public Clouds Appliances Registered on Veeam Cloud Connect Site
      description: Uploads a patch file chunk to Veeam Backup for Public Clouds appliances registered on a Veeam Cloud Connect site with the specified UID.
      operationId: UploadPublicCloudMultipartPatch
      parameters:
        - name: siteUid
          in: path
          description: Veeam Cloud Connect site UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: uploadUid
          in: query
          description: Upload UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: partNumber
          in: query
          description: File chunk ordinal number.
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        description: "File chunk.\n> Maximum size is 5 MB. Sending a bigger file chunk can return an unexpected error response.\n"
        content:
          application/octet-stream:
            schema:
              maxLength: 5242880
              minLength: 1
              type: string
              format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/appliances/patches/upload/multipart/complete':
    post:
      tags:
        - Preview Operations
      summary: Complete Patch Upload to Veeam Backup for Public Clouds Appliances registered on Veeam Cloud Connect Site
      description: Finalizes an upload of a patch to Veeam Backup for Public Clouds appliances registered on a Veeam Cloud Connect site with the specified UID.
      operationId: CompletePublicCloudMultipartPatch
      parameters:
        - name: siteUid
          in: path
          description: Veeam Cloud Connect site UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: uploadUid
          in: query
          description: Upload UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/appliances/patches/upload/multipart/abort':
    post:
      tags:
        - Preview Operations
      summary: Abort Patch Upload to Veeam Backup for Public Clouds Appliances registered on Veeam Cloud Connect Site
      description: Aborts an upload of a patch to Veeam Backup for Public Clouds appliances registered on a Veeam Cloud Connect site with the specified UID.
      operationId: AbortPublicCloudMultipartPatch
      parameters:
        - name: siteUid
          in: path
          description: Veeam Cloud Connect site UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: uploadUid
          in: query
          description: Upload UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/appliances/{applianceUid}/collect':
    post:
      tags:
        - Public Cloud
      summary: Collect Data From Veeam Backup for Public Clouds Appliance Registered on Veeam Cloud Connect Site.
      description: Initiates data collection from a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect site.
      operationId: ForceCollectDataFromPublicCloudAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: fullRecollect
          in: query
          description: Indicates whether full data recollect must be performed.
          schema:
            type: boolean
            default: false
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/appliances/{applianceUid}/repositories':
    get:
      tags:
        - Public Cloud
      summary: Get Veeam Backup for Public Clouds Appliance Repositories Registered on Veeam Cloud Connect Site
      description: Returns a collection resource representation of repositories created by a Veeam Backup for Public Clouds appliance with the specified UID registered on a Veeam Cloud Connect Site.
      operationId: GetPublicCloudRepositoriesByApplianceUid
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudRepository'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 568f43f7-24a6-4c9c-b755-3294a5e4fd41
                    repositoryName: rt2-rep
                    description: ''
                    platform: Amazon Web Services
                    applianceName: BM-v6-AWS
                    applianceUid: f654663b-f348-492c-adb6-785244ee93ca
                    bucket: az-bucket-002
                    folder: rt2-tenant
                    region: EU (Frankfurt) (eu-central-1)
                    storageClass: S3
                    isEncrypted: true
                    immutabilityEnabled: false
                    organizationName: rt2
                    organizationUid: 6eb51175-0421-4d72-bc5b-f4ebb137eb40
                    siteName: WIN-TUCSQEMDMG6
                    siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                    creatingState: 
                  - instanceUid: 41bc79a2-0502-4768-83af-c71aee912643
                    repositoryName: rt2-rep2
                    description: ''
                    platform: Amazon Web Services
                    applianceName: BM-v6-AWS
                    applianceUid: f654663b-f348-492c-adb6-785244ee93ca
                    bucket: bmb-bucket-bm
                    folder: rt2-reseller
                    region: EU (Frankfurt) (eu-central-1)
                    storageClass: S3
                    isEncrypted: true
                    immutabilityEnabled: false
                    organizationName: rt2
                    organizationUid: 6eb51175-0421-4d72-bc5b-f4ebb137eb40
                    siteName: WIN-TUCSQEMDMG6
                    siteUid: b2e721fc-82ef-4ca6-a1b2-5452bc4399b6
                    creatingState: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /infrastructure/backupServers/publicCloud/appliances:
    get:
      tags:
        - Public Cloud
      summary: Get All Veeam Backup for Public Clouds Appliances.
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds appliances.
      operationId: GetBackupServerPublicCloudAppliances
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerPublicCloudAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    resourceId: /subscriptions/280921a2-330d-45c9-92dd-82b6d5a3a78f/resourcegroups/az-azure/providers/microsoft.compute/virtualmachines/az-dvb-333-ks
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    publicAddress: az-dvb-333-ks
                    description: ''
                    region: westeurope
                    certificateThumbprint: 1C112D7F5A4BDA6A4AF2754997025F8CA1E18275
                    remoteUiAccessEnabled: true
                    selfServicePortalUrl: https://az-dvb-333-ks.westeurope.cloudapp.azure.com/
                    organizationUid: 4ad3b7cb-41fb-4d28-be92-092fe61f287a
                    mappedOrganizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 6d2180b7-6f8b-4351-a21b-9a07d0e57786
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    version: 7.0.0.467
                    status: Healthy
                    statusMessage: ''
                    platform: Azure
                    managementType: ByConsole
                  - instanceUid: b83c432b-98e5-4502-9c00-711b164ec818
                    resourceId: /subscriptions/b146ebc9-73ac-497a-ae84-f9e5db1e08ba/resourcegroups/az-azure/providers/microsoft.compute/virtualmachines/az-dvb-412-ks2
                    backupServerUid: 106f22c7-ce4c-480c-82e8-35b434438302
                    publicAddress: az-dvb-412-ks2
                    description: ''
                    region: europe-1
                    certificateThumbprint: 4D5546274EC142D3D61FA3FC8C782B47DCA56C3E
                    remoteUiAccessEnabled: true
                    selfServicePortalUrl: https://az-dvb-412-ks2.westeurope.cloudapp.azure.com/
                    organizationUid: 482ba6ba-888a-4c1e-ab6f-df58c8c3b590
                    mappedOrganizationUid: 211785a4-cbe0-4ffc-b5f4-df221b21bd89
                    locationUid: 5f55ce0a-5dac-4797-89eb-bee41e60c018
                    managementAgentUid: bb532346-392a-4c80-be26-dc659a5e1534
                    version: 7.0.0.467
                    status: Healthy
                    statusMessage: ''
                    platform: Azure
                    managementType: ByConsole
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/appliances':
    get:
      tags:
        - Public Cloud
      summary: Get All Veeam Backup for Public Clouds Appliances Registered on Veeam Backup & Replication Server
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds appliances connected to a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerPublicCloudAppliancesByServer
      parameters:
        - name: backupServerUid
          in: path
          description: Veeam Backup & Replication server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerPublicCloudAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    resourceId: /subscriptions/280921a2-330d-45c9-92dd-82b6d5a3a78f/resourcegroups/az-azure/providers/microsoft.compute/virtualmachines/az-dvb-333-ks
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    publicAddress: az-dvb-333-ks
                    description: ''
                    region: westeurope
                    certificateThumbprint: 1C112D7F5A4BDA6A4AF2754997025F8CA1E18275
                    remoteUiAccessEnabled: true
                    selfServicePortalUrl: https://az-dvb-333-ks.westeurope.cloudapp.azure.com/
                    organizationUid: 4ad3b7cb-41fb-4d28-be92-092fe61f287a
                    mappedOrganizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 6d2180b7-6f8b-4351-a21b-9a07d0e57786
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    version: 7.0.0.467
                    status: Healthy
                    statusMessage: ''
                    platform: Azure
                    managementType: ByConsole
                  - instanceUid: b83c432b-98e5-4502-9c00-711b164ec818
                    resourceId: /subscriptions/b146ebc9-73ac-497a-ae84-f9e5db1e08ba/resourcegroups/az-azure/providers/microsoft.compute/virtualmachines/az-dvb-412-ks2
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    publicAddress: az-dvb-412-ks2
                    description: ''
                    region: europe-1
                    certificateThumbprint: 4D5546274EC142D3D61FA3FC8C782B47DCA56C3E
                    remoteUiAccessEnabled: true
                    selfServicePortalUrl: https://az-dvb-412-ks2.westeurope.cloudapp.azure.com/
                    organizationUid: 482ba6ba-888a-4c1e-ab6f-df58c8c3b590
                    mappedOrganizationUid: 211785a4-cbe0-4ffc-b5f4-df221b21bd89
                    locationUid: 5f55ce0a-5dac-4797-89eb-bee41e60c018
                    managementAgentUid: bb532346-392a-4c80-be26-dc659a5e1534
                    version: 7.0.0.467
                    status: Healthy
                    statusMessage: ''
                    platform: Azure
                    managementType: ByConsole
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/appliances/{applianceUid}':
    get:
      tags:
        - Public Cloud
      summary: Get Veeam Backup for Public Clouds Appliance
      description: Returns a resource representation of a Veeam Backup for Public Clouds appliance with the specified UID.
      operationId: GetBackupServerPublicCloudAppliance
      parameters:
        - name: backupServerUid
          in: path
          description: Veeam Backup & Replication server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerPublicCloudAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: b83c432b-98e5-4502-9c00-711b164ec818
                  resourceId: /subscriptions/b146ebc9-73ac-497a-ae84-f9e5db1e08ba/resourcegroups/az-azure/providers/microsoft.compute/virtualmachines/az-dvb-412-ks2
                  backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                  publicAddress: az-dvb-412-ks2
                  description: ''
                  region: europe-1
                  certificateThumbprint: 4D5546274EC142D3D61FA3FC8C782B47DCA56C3E
                  remoteUiAccessEnabled: true
                  selfServicePortalUrl: https://az-dvb-412-ks2.westeurope.cloudapp.azure.com/
                  organizationUid: 482ba6ba-888a-4c1e-ab6f-df58c8c3b590
                  mappedOrganizationUid: 211785a4-cbe0-4ffc-b5f4-df221b21bd89
                  locationUid: 5f55ce0a-5dac-4797-89eb-bee41e60c018
                  managementAgentUid: bb532346-392a-4c80-be26-dc659a5e1534
                  version: 7.0.0.467
                  status: Healthy
                  statusMessage: ''
                  platform: Azure
                  managementType: ByConsole
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/appliances/{applianceUid}/collect':
    post:
      tags:
        - Public Cloud
      summary: Collect Data From Veeam Backup for Public Clouds Appliance
      description: Initiates data collection from a Veeam Backup for Public Clouds appliance with the specified UID.
      operationId: ForceCollectDataFromBackupServerPublicCloudAppliance
      parameters:
        - name: backupServerUid
          in: path
          description: Veeam Backup & Replication server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: applianceUid
          in: path
          description: Veeam Backup for Public Clouds appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: fullRecollect
          in: query
          description: Indicates whether full data recollect must be performed.
          schema:
            type: boolean
            default: false
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/sites/{siteUid}/publicCloud/google/accounts':
    get:
      tags:
        - Preview Operations
      summary: Get All Google Cloud Accounts
      description: Returns a collection resource representation of all Google Cloud accounts managed by a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudGoogleAccounts
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudGoogleAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 2da9c28b-6034-440b-b529-313d02bb48aa
                    credentialTag: 65f52e3d-d579-4945-81e6-7a54aa6350b8
                    name: alpha cloud provider
                    description: 'Description; Created by Veeam Service Provider Console. My Company: BM160\Administrator'
                    projectId: vspc1
                    createdBy: BM160\Administrator
                    siteUid: 56b9928e-4874-4c8d-b554-1df01966496c
                    organizationUid: 7920f175-ab2f-404b-b85b-482f6466e192
                    appliances:
                      - 6d6e647e-4cac-4218-ba1a-9257f758d736
                    jsonConfiguration: 
                  - instanceUid: d2601b33-b307-4ca4-a17b-b758ad3c7f9b
                    credentialTag: 0df068bb-c932-43cf-bb2f-23553ecdd4b7
                    name: beta cloud provider
                    description: 'Description; Created by Veeam Service Provider Console. My Company: BM160\Administrator'
                    projectId: vspc1
                    createdBy: BM160\Administrator
                    siteUid: 56b9928e-4874-4c8d-b554-1df01966496c
                    organizationUid: ba5ceb1a-c695-4c3a-855d-e7a0cc2f7dee
                    appliances:
                      - 96ad4407-38a6-47a0-bfe9-92edfebd80ad
                    jsonConfiguration: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    post:
      tags:
        - Preview Operations
      summary: Create Google Cloud Account
      description: Creates a Google Cloud account in a Veeam Cloud Connect site with the specified UID.
      operationId: CreatePublicCloudGoogleAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Google Cloud account parameters.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudGoogleAccountInput'
            example:
              name: Provider
              description: Provider Account
              jsonConfiguration: '{"type":"service_account","project_id":"vspc","private_key_id":"4a79cbf96aa94266407fa1a8fd39d6983989fd8","private_key":"-----BEGINPRIVATEKEY-----\nMIIEowIBAAKCAQEAsUyvEXIzY2iHzUwtNCUTUDEGeEaWt667b8tbbehcmJmieP42T5bh0lIWvET9h03LGutYD4f0lH74EihHaBHt45B4ei9EiJGATPgLfdc4MOsiQcbf6HjrkuVzru4SDnesUEkDYczXNh/int7Uvuhafv0hKu3ZOfQPtPmJKBc+fQCBt6ZgSxQ1BqOR+p8MCkxxVr4zUphsQCU+kCWzilyPlFHSKtb/JggDGMnLiZiY1MnU1FkC4rTY2COlcNzq8PtEF6BuAO1L1788eh+h2oesG78kttuNmtTrXFlaCFzwOGmoKg2aAPIJVYNt5V3Vevm9kzcx5BAjeiKUZipGH8XQIDAQABAoIBABlUflJ8wVC7d2NiNbcUcOztBCKc2x2E7ixrnjVWlBwNHwQwNWwrfznAFpVxOdNhztmas+sMHmo0tZZKgOEiZp0zX7L9G8pzFyRn76Rb4iBDB5LkKcsZs3Y6J8vfIV9Fw614sO4BCOInrgXKihR4N62a1mk+r+EyuCe/2tOKdpf/BKjGLX9hhEglMFpscsCK6vMya+Eo1mpjTlqsTCQQEs031kRCcRFq4VBaLx/xgCAVLA0vTBUeGV7hx/VpGU3yy+flI+O3ny6lwaThe6ulkh3Y7S/dAyp6JYt/kmi6ZD0My8xTiOd4fw+zqDrt5UtROGAVMKHpCT7g9ElyGTLsTUCgYEA1sxtK2U/PVWsjq/ZK388zuSJ2QXMch+65xM+JZkPtbohzjlIFmGGyTN+kkMC3H1/xe+/y0GrB9OdzqLqiQQhOkXkzHuMAbqGoGKcywO1KqrKeD1C3Z4/ha4yLALF5M/ihCvCZ2k5mmfwCKX+5+kPhaqUOeJoO0C4DxLwdiI508CgYEA007jZqvy/3ct2LtREZgqsHggoyZOtYwtL8bvNuIMX/Z/fDlsdhjqFJCmYzgmVzpGpruac9dSBdPbOIs6cnkdnvdttwPgX9lrlW7DXFNCiXWdCTN7UlVDIKRCDjIlVKgsoI7EKewT6oGzjfhgejTRp4a8XvQfxqUWVOx4cIy9tpMCgYEAl2h5+4De1ukxPVMPDe4eeuf1kxjXSAq9wGx8dqPL/c+XENo2CFuSgEetOaOL7fVipXGjnFOsxF88/CY0lLXfPxDfIU6sywXUtuJhKVYBDj9Pb7G2iWH1X4W8sxoEd5W/0B56g5ivyArkJJc98oxRRcLMQ0MybFElGdLmw7lSp1kCgYB08nE6jqnTJ3ORQsJwWWYu+p0djoL7SVRs383e8yZkKfmOl/1mMw3CSfg8a4QUvKUDfErUF/RGU2U9mxjC6DMzmr73Dkcs5Rj8wCuROmdVymkaAYscGyImu6HvV2N/wf/I8JqylPzEyfnE9hT3Lapm7FPuvW+kshN09tcFe283zwKBgBg/NFAjO0CniYina6FM9KH4uk//5JZ9nXV9nkBRiykIzeWURcf1WfbpPIeQgIcx6/CKb/Peay41OIvN2gegyhLFaPbylN1xkBq9Yc5xkxKapReH+yIoiwO86Cc4QJVjLp3pQBy0+lXRwyRMg5sEcBQeQGBu5JpJh0hQTQ0Drj+i\n-----ENDPRIVATEKEY-----\n","client_email":"provider@mycompany.iam.gserviceaccount.com","client_id":"218140769437899532786","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_x509_cert_url":"https://www.googleapis.com/robot/v1/metadata/x509/provider%40mycompany.iam.gserviceaccount.com","universe_domain":"googleapis.com"}'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudGoogleAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 2da9c28b-6034-550b-b529-313d02bb48aa
                  credentialTag: 65f52e3d-e679-4945-81e6-7a54aa6350b8
                  name: Provider
                  description: Provider Account
                  projectId: vspc
                  createdBy: mycompany\Administrator
                  siteUid: 56b9928e-4874-4c8d-b554-1df01076496c
                  organizationUid: 7920f175-ab2f-404b-b85b-482f6466e192
                  appliances:
                    - 6d7f647e-4cac-4218-ba1a-9257f758d736
                  jsonConfiguration: '{"type":"service_account","project_id":"vspc","private_key_id":"4a79cbf96aa94266407fa1a8fd39d6983989fd8","private_key":"-----BEGINPRIVATEKEY-----\nMIIEowIBAAKCAQEAsUyvEXIzY2iHzUwtNCUTUDEGeEaWt667b8tbbehcmJmieP42T5bh0lIWvET9h03LGutYD4f0lH74EihHaBHt45B4ei9EiJGATPgLfdc4MOsiQcbf6HjrkuVzru4SDnesUEkDYczXNh/int7Uvuhafv0hKu3ZOfQPtPmJKBc+fQCBt6ZgSxQ1BqOR+p8MCkxxVr4zUphsQCU+kCWzilyPlFHSKtb/JggDGMnLiZiY1MnU1FkC4rTY2COlcNzq8PtEF6BuAO1L1788eh+h2oesG78kttuNmtTrXFlaCFzwOGmoKg2aAPIJVYNt5V3Vevm9kzcx5BAjeiKUZipGH8XQIDAQABAoIBABlUflJ8wVC7d2NiNbcUcOztBCKc2x2E7ixrnjVWlBwNHwQwNWwrfznAFpVxOdNhztmas+sMHmo0tZZKgOEiZp0zX7L9G8pzFyRn76Rb4iBDB5LkKcsZs3Y6J8vfIV9Fw614sO4BCOInrgXKihR4N62a1mk+r+EyuCe/2tOKdpf/BKjGLX9hhEglMFpscsCK6vMya+Eo1mpjTlqsTCQQEs031kRCcRFq4VBaLx/xgCAVLA0vTBUeGV7hx/VpGU3yy+flI+O3ny6lwaThe6ulkh3Y7S/dAyp6JYt/kmi6ZD0My8xTiOd4fw+zqDrt5UtROGAVMKHpCT7g9ElyGTLsTUCgYEA1sxtK2U/PVWsjq/ZK388zuSJ2QXMch+65xM+JZkPtbohzjlIFmGGyTN+kkMC3H1/xe+/y0GrB9OdzqLqiQQhOkXkzHuMAbqGoGKcywO1KqrKeD1C3Z4/ha4yLALF5M/ihCvCZ2k5mmfwCKX+5+kPhaqUOeJoO0C4DxLwdiI508CgYEA007jZqvy/3ct2LtREZgqsHggoyZOtYwtL8bvNuIMX/Z/fDlsdhjqFJCmYzgmVzpGpruac9dSBdPbOIs6cnkdnvdttwPgX9lrlW7DXFNCiXWdCTN7UlVDIKRCDjIlVKgsoI7EKewT6oGzjfhgejTRp4a8XvQfxqUWVOx4cIy9tpMCgYEAl2h5+4De1ukxPVMPDe4eeuf1kxjXSAq9wGx8dqPL/c+XENo2CFuSgEetOaOL7fVipXGjnFOsxF88/CY0lLXfPxDfIU6sywXUtuJhKVYBDj9Pb7G2iWH1X4W8sxoEd5W/0B56g5ivyArkJJc98oxRRcLMQ0MybFElGdLmw7lSp1kCgYB08nE6jqnTJ3ORQsJwWWYu+p0djoL7SVRs383e8yZkKfmOl/1mMw3CSfg8a4QUvKUDfErUF/RGU2U9mxjC6DMzmr73Dkcs5Rj8wCuROmdVymkaAYscGyImu6HvV2N/wf/I8JqylPzEyfnE9hT3Lapm7FPuvW+kshN09tcFe283zwKBgBg/NFAjO0CniYina6FM9KH4uk//5JZ9nXV9nkBRiykIzeWURcf1WfbpPIeQgIcx6/CKb/Peay41OIvN2gegyhLFaPbylN1xkBq9Yc5xkxKapReH+yIoiwO86Cc4QJVjLp3pQBy0+lXRwyRMg5sEcBQeQGBu5JpJh0hQTQ0Drj+i\n-----ENDPRIVATEKEY-----\n","client_email":"provider@mycompany.iam.gserviceaccount.com","client_id":"218140769437899532786","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_x509_cert_url":"https://www.googleapis.com/robot/v1/metadata/x509/provider%40mycompany.iam.gserviceaccount.com","universe_domain":"googleapis.com"}'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/accounts/{accountUid}':
    get:
      tags:
        - Preview Operations
      summary: Get Google Cloud Account
      description: Returns a resource representation of a Google Cloud account with the specified UID.
      operationId: GetPublicCloudGoogleAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudGoogleAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d2601b33-b307-4ca4-a17b-b758ad3c7f9b
                  credentialTag: 0df068bb-c932-43cf-bb2f-23553ecdd4b7
                  name: beta cloud provider
                  description: 'Description; Created by Veeam Service Provider Console. My Company: BM160\Administrator'
                  projectId: vspc1
                  createdBy: BM160\Administrator
                  siteUid: 56b9928e-4874-4c8d-b554-1df01966496c
                  organizationUid: ba5ceb1a-c695-4c3a-855d-e7a0cc2f7dee
                  appliances:
                    - 96ad4407-38a6-47a0-bfe9-92edfebd80ad
                  jsonConfiguration: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PublicCloudGoogleAccount'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    patch:
      tags:
        - Preview Operations
      summary: Modify Google Cloud Account
      description: Modifies a Google Cloud account with the specified UID.
      operationId: PatchPublicCloudGoogleAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Provider Account
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudGoogleAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 2da9c28b-6034-550b-b529-313d02bb48aa
                  credentialTag: 65f52e3d-e679-4945-81e6-7a54aa6350b8
                  name: Provider
                  description: Provider Account
                  projectId: vspc
                  createdBy: mycompany\Administrator
                  siteUid: 56b9928e-4874-4c8d-b554-1df01076496c
                  organizationUid: 7920f175-ab2f-404b-b85b-482f6466e192
                  appliances:
                    - 6d7f647e-4cac-4218-ba1a-9257f758d736
                  jsonConfiguration: '{"type":"service_account","project_id":"vspc","private_key_id":"4a79cbf96aa94266407fa1a8fd39d6983989fd8","private_key":"-----BEGINPRIVATEKEY-----\nMIIEowIBAAKCAQEAsUyvEXIzY2iHzUwtNCUTUDEGeEaWt667b8tbbehcmJmieP42T5bh0lIWvET9h03LGutYD4f0lH74EihHaBHt45B4ei9EiJGATPgLfdc4MOsiQcbf6HjrkuVzru4SDnesUEkDYczXNh/int7Uvuhafv0hKu3ZOfQPtPmJKBc+fQCBt6ZgSxQ1BqOR+p8MCkxxVr4zUphsQCU+kCWzilyPlFHSKtb/JggDGMnLiZiY1MnU1FkC4rTY2COlcNzq8PtEF6BuAO1L1788eh+h2oesG78kttuNmtTrXFlaCFzwOGmoKg2aAPIJVYNt5V3Vevm9kzcx5BAjeiKUZipGH8XQIDAQABAoIBABlUflJ8wVC7d2NiNbcUcOztBCKc2x2E7ixrnjVWlBwNHwQwNWwrfznAFpVxOdNhztmas+sMHmo0tZZKgOEiZp0zX7L9G8pzFyRn76Rb4iBDB5LkKcsZs3Y6J8vfIV9Fw614sO4BCOInrgXKihR4N62a1mk+r+EyuCe/2tOKdpf/BKjGLX9hhEglMFpscsCK6vMya+Eo1mpjTlqsTCQQEs031kRCcRFq4VBaLx/xgCAVLA0vTBUeGV7hx/VpGU3yy+flI+O3ny6lwaThe6ulkh3Y7S/dAyp6JYt/kmi6ZD0My8xTiOd4fw+zqDrt5UtROGAVMKHpCT7g9ElyGTLsTUCgYEA1sxtK2U/PVWsjq/ZK388zuSJ2QXMch+65xM+JZkPtbohzjlIFmGGyTN+kkMC3H1/xe+/y0GrB9OdzqLqiQQhOkXkzHuMAbqGoGKcywO1KqrKeD1C3Z4/ha4yLALF5M/ihCvCZ2k5mmfwCKX+5+kPhaqUOeJoO0C4DxLwdiI508CgYEA007jZqvy/3ct2LtREZgqsHggoyZOtYwtL8bvNuIMX/Z/fDlsdhjqFJCmYzgmVzpGpruac9dSBdPbOIs6cnkdnvdttwPgX9lrlW7DXFNCiXWdCTN7UlVDIKRCDjIlVKgsoI7EKewT6oGzjfhgejTRp4a8XvQfxqUWVOx4cIy9tpMCgYEAl2h5+4De1ukxPVMPDe4eeuf1kxjXSAq9wGx8dqPL/c+XENo2CFuSgEetOaOL7fVipXGjnFOsxF88/CY0lLXfPxDfIU6sywXUtuJhKVYBDj9Pb7G2iWH1X4W8sxoEd5W/0B56g5ivyArkJJc98oxRRcLMQ0MybFElGdLmw7lSp1kCgYB08nE6jqnTJ3ORQsJwWWYu+p0djoL7SVRs383e8yZkKfmOl/1mMw3CSfg8a4QUvKUDfErUF/RGU2U9mxjC6DMzmr73Dkcs5Rj8wCuROmdVymkaAYscGyImu6HvV2N/wf/I8JqylPzEyfnE9hT3Lapm7FPuvW+kshN09tcFe283zwKBgBg/NFAjO0CniYina6FM9KH4uk//5JZ9nXV9nkBRiykIzeWURcf1WfbpPIeQgIcx6/CKb/Peay41OIvN2gegyhLFaPbylN1xkBq9Yc5xkxKapReH+yIoiwO86Cc4QJVjLp3pQBy0+lXRwyRMg5sEcBQeQGBu5JpJh0hQTQ0Drj+i\n-----ENDPRIVATEKEY-----\n","client_email":"provider@mycompany.iam.gserviceaccount.com","client_id":"218140769437899532786","auth_uri":"https://accounts.google.com/o/oauth2/auth","token_uri":"https://oauth2.googleapis.com/token","auth_provider_x509_cert_url":"https://www.googleapis.com/oauth2/v1/certs","client_x509_cert_url":"https://www.googleapis.com/robot/v1/metadata/x509/provider%40mycompany.iam.gserviceaccount.com","universe_domain":"googleapis.com"}'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PublicCloudGoogleAccount'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Preview Operations
      summary: Delete Google Cloud Account
      description: Delete a Google Cloud account with the specified UID.
      operationId: RemovePublicCloudGoogleAccount
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: path
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/datacenters':
    get:
      tags:
        - Preview Operations
      summary: Get All Google Cloud Datacenters
      description: Returns a collection resource representation of all Google Cloud datacenters managed by Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudGoogleDataCenters
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: query
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudGoogleDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - dataCenterId: africa-south1
                    dataCenterName: africa-south1
                  - dataCenterId: asia-east1
                    dataCenterName: asia-east1 (Taiwan)
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/availabilityZones':
    get:
      tags:
        - Preview Operations
      summary: Get Google Cloud Zones
      description: Returns a collection resource representation of all Google Cloud zones.
      operationId: GetPublicCloudGoogleAvailabilityZones
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: query
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: dataCenterId
          in: query
          description: Google Cloud datacenter ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudGoogleAvailabilityZone'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - availabilityZoneId: africa-south1-a
                  - availabilityZoneId: africa-south1-b
                  - availabilityZoneId: africa-south1-c
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/networks':
    get:
      tags:
        - Preview Operations
      summary: Get All Google Cloud Networks
      description: Returns a collection resource representation of all Google Cloud networks managed by a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudGoogleNetworks
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: query
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudGoogleNetworks'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - networkId: '8659479131493062359'
                    networkName: at1
                    projectId: vspc1
                    networkType: Standalone
                  - networkId: '7239576279309251859'
                    networkName: az1
                    projectId: vspc1
                    networkType: Standalone
                  - networkId: '5018651621160436123'
                    networkName: bm2
                    projectId: vspc1
                    networkType: Standalone
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/subnets':
    get:
      tags:
        - Preview Operations
      summary: Get All Google Cloud Subnets
      description: Returns a collection resource representation of all Google Cloud subnets registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudGoogleSubNetworks
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: query
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: dataCenterId
          in: query
          description: Google Cloud datacenter ID.
          required: true
          schema:
            type: string
        - name: networkId
          in: query
          description: Google Cloud network ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudGoogleSubNetworks'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - subNetworkId: '7239576279309251859'
                    name: az1
                    range: 10.107.0.0/20
                  - subNetworkId: '5018651621160436123'
                    name: default
                    range: 10.107.0.0/20
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/networkTags':
    get:
      tags:
        - Preview Operations
      summary: Get All Google Cloud Network Tags
      description: Returns a collection resource representation of all Google Cloud network tags registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudGoogleNetworkTags
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: query
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: networkId
          in: query
          description: Google Cloud network ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudGoogleNetworkTag'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - networkTagId: '7239576279309251859'
                    networkTagName: az1-ntag1
                  - networkTagId: '5018651621160436123'
                    networkTagName: az1-ntag2
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/backupServerIpAddresses':
    get:
      tags:
        - Preview Operations
      summary: Get Veeam Cloud Connect Site IP Adresses in Google Cloud
      description: Returns a collection resource representation of IP addresses specified in Google Cloud for a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudGoogleBackupServerIpAddresses
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudBackupServerPublicAddress'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupServerIpAddresses: 40.79.101.52;13.24.76.112
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/ipAddresses':
    get:
      tags:
        - Preview Operations
      summary: Get Google Cloud Account IP Addresses
      description: Returns a collection resource representation of all existing IP addresses available to Google Cloud accounts registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudGoogleExistingIpAddresses
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: query
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: dataCenterId
          in: query
          description: Google Cloud datacenter ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudAppliancePublicAddress'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - applianceIpAddressId: '7239576279309251859'
                    ipAddress: 34.162.236.121
                    name: az1-ip1-static
                  - applianceIpAddressId: '5018651621160436123'
                    ipAddress: 13.24.76.112
                    name: az1-ip2-static
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/virtualMachines':
    get:
      tags:
        - Preview Operations
      summary: Get All Google Cloud VMs
      description: Returns a collection resource representation of all Google Cloud VMs registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetPublicCloudGoogleVirtualMachines
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: accountUid
          in: query
          description: Google Cloud account UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: dataCenterId
          in: query
          description: Google Cloud datacenter ID.
          required: true
          schema:
            type: string
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudGoogleVirtualMachine'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - virtualMachineName: winvm2
                    virtualMachineId: '7239576279309251859'
                    availabilityZoneId: africa-south1-a
                  - virtualMachineName: winvm7
                    virtualMachineId: '5018651621160436123'
                    availabilityZoneId: asia-east1-a
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/appliances/deploy':
    post:
      tags:
        - Preview Operations
      summary: Create Veeam Backup for Google Cloud Appliance
      description: Creates a new Veeam Backup for Google Cloud appliance registered on a Veeam Cloud Connect site with the specified UID.
      operationId: CreateNewPublicCloudGoogleAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudGoogleNewApplianceInput'
            example:
              account:
                accountUid: 69d70dc2-25d4-4e82-a0fc-d89c1d847ec7
                dataCenterId: europe4
                availabilityZoneId: europe4-a
              virtualMachine:
                virtualMachineName: vba1
                description: Backup appliance VM
              network: 
              ipAddress:
                applianceIp:
                  applianceIpAddressId: 34.90.208.126
                  newIpAddressType: dynamic
                backupServerIpAddresses: 172.24.147.188
              guestOsCredentials:
                guestOsCredentialsUid: 9d8ac737-5ca0-44b8-8195-890a66f93606
                sshPublicKey: '-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAsUyvEXIzY2iHzUwtNCUTUDEGeEaWt667b8tbbehcmJmieP42T5bh0lIWvET9h03LGutYD4f0lH74EihHaBHt45B4ei9EiJGATPgLfdc4MOsiQcbf6HjrkuVzru4SDnesUEkDYczXNh/int7Uvuhafv0hKu3ZOfQPtPmJKBc+fQCBt6ZgSxQ1BqOR+p8MCkxxVr4zUphsQCU+2kCWzilyPlFHSKtb/JggDGMnLiZiY1MnU1FkC4rTY2COlcNzq8+PtEF6BuAO1L1788eh+h2oesG78kttuNmtTrXFlaCFzwOGmoKg2aAPIJVYNt5V3Vevm9kzcx5BAjeiKUZipGH8XQIDAQAB-----END PUBLIC KEY-----'
                timeZoneId: Pacific Standard Time
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudApplianceDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: 144dbd70-6d72-43a2-9348-81a96c95a346
                  managementAgentUid: fa3b3739-e420-4d5b-8791-be369838c170
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/appliances/connect':
    post:
      tags:
        - Preview Operations
      summary: Connect Veeam  Backup for Google Cloud Appliance
      description: Connects an existing Veeam Backup for Google Cloud appliance registered on a Veeam Cloud Connect site with the specified UID.
      operationId: AddExistingPublicCloudGoogleAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PublicCloudGoogleAddExistingApplianceInput'
            example:
              account:
                accountUid: 69d70dc2-25d4-4e82-a0fc-d89c1d847ec7
                dataCenterId: europe4
              virtualMachine:
                virtualMachineId: '2867594120803406076'
                description: Backup appliance VM
              network: 
              guestOsCredentials:
                guestOsCredentialsUid: 9d8ac737-5ca0-44b8-8195-890a66f93606
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudApplianceDeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  taskUid: 144dbd70-6d72-43a2-9348-81a96c95a346
                  managementAgentUid: fa3b3739-e420-4d5b-8791-be369838c170
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/sites/{siteUid}/publicCloud/google/appliances/{applianceUid}':
    get:
      tags:
        - Preview Operations
      summary: Get Veeam Backup for Google Cloud Appliance
      description: Returns a resource representation of a Veeam Backup for Google Cloud appliance with the specified UID.
      operationId: GetPublicCloudGoogleAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for Google Cloud appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudGoogleAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 6d6e647e-5dac-4218-ba1a-9257f758d736
                  name: bm-v5
                  description: Description
                  managementAgentUid: 4fc916ce-c15a-4224-ba79-ade52ef79b9a
                  accountUid: 2da9c28b-7134-440b-b529-313d02bb48aa
                  guestOsCredentialsUid: 9ab2e3b0-6a92-4e8b-b6bc-addcfe884286
                  certificateThumbprint: 25767A5E4506907D419C14D4D72EC09DB99BDD99
                  publicAddress: 34.13.208.126
                  privateNetworkAddress: 
                  virtualMachineId: '3693819955941358334'
                  dataCenterId: europe-west3
                  availabilityZoneId: europe-west3-a
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PublicCloudGoogleAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    patch:
      tags:
        - Preview Operations
      summary: Modify Veeam Backup for Google Cloud Appliance
      description: Modifies a Veeam Backup for Google Cloud appliance with the specified UID.
      operationId: PatchPublicCloudGoogleAppliance
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: applianceUid
          in: path
          description: Veeam Backup for Google Cloud appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Backup Appliance
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudGoogleAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 7e7e647e-4cac-4218-ba1a-9257f758d736
                  name: vba1
                  description: Backup Appliance
                  managementAgentUid: 4fc916ce-c15a-4224-ba79-ade52ef79b9a
                  accountUid: 2da9c28b-7134-440b-b529-313d02bb48aa
                  guestOsCredentialsUid: 9ab2f4b0-5f92-4e8b-b6bc-addcfe884286
                  certificateThumbprint: 25767A5E4506907D419C14D4D72EC09DB99BDD99
                  publicAddress: 45.89.208.126
                  privateNetworkAddress: 
                  virtualMachineId: '2867594120803406076'
                  dataCenterId: europe4
                  availabilityZoneId: europe4-a
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PublicCloudGoogleAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /infrastructure/sites/publicCloud/sqlAccounts/appliances:
    get:
      tags:
        - Preview Operations
      summary: Get All Veeam Backup for Public Clouds Appliances to Create SQL Accounts
      description: Returns a collection of resource representation of all Veeam Backup for Public Clouds appliances on which SQL accounts can be created.
      operationId: GetPublicCloudAppliancesForSqlAccounts
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudSqlAccountAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - applianceUid: 6d6e647e-5dac-4218-ba1a-9257f758d736
                    applianceName: bm-v5
                    siteUid: 56b9928e-5974-4c8d-b554-1df01966496c
                    managementAgentUid: 4fc916ce-c65a-4224-ba79-ade52ef79b9a
                  - applianceUid: 14014d2e-54dd-4dbe-b4b3-ac5951934967
                    applianceName: bm-v7
                    siteUid: 56b9928e-5974-4c8d-b554-1df01966496c
                    managementAgentUid: a55f4ba2-6cd3-41f0-b328-5711aa255c78
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  /infrastructure/sites/publicCloud/sqlAccounts:
    get:
      tags:
        - Preview Operations
      summary: Get All Available Public Cloud SQL accounts.
      description: Returns a collection resource representation of all available public cloud SQL accounts.
      operationId: GetPublicCloudSqlAccounts
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudSqlAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - accountId: 72963529-e35b-447f-8891-8611709dc34d:cb74d5c1-d359-4745-b95d-ed69b2f184e1:4e7409a0-805b-4c21-a3fc-2d820561dddf
                    accountName: IAM
                    userName: ''
                    password: 
                    description: Default IAM credentials
                    status: Available
                    applianceUid: 6d6e647e-5dac-4218-ba1a-9257f758d736
                    siteUid: 56b9928e-5974-4c8d-b554-1df01966496c
                    managementAgentUid: 72963529-e35b-447f-8891-8611709dc34d
                  - accountId: 72963529-e35b-447f-8891-8611709dc34d:3f14bdbd-7c9f-4f52-80fa-db53d46c2d8d:5e667f5d-022d-4b8c-b8d6-7462f2d40b19
                    accountName: Csql
                    userName: admin
                    password: 
                    description: Default Csql credentials
                    status: Available
                    applianceUid: 6d6e647e-5dac-4218-ba1a-9257f758d736
                    siteUid: 56b9928e-5974-4c8d-b554-1df01966496c
                    managementAgentUid: 72963529-e35b-447f-8891-8611709dc34d
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
    post:
      tags:
        - Preview Operations
      summary: Create Public Cloud SQL Account.
      description: Creates a new public cloud SQL account.
      operationId: CreatePublicCloudSqlAccount
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Public cloud SQL account parameters.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewPublicCloudSqlAccount'
            example:
              accountName: Admin
              databaseType: AzureSql
              userName: admin
              password: Password1
              description: Admin credentials
              applianceUid: 6d18e5fe-20e5-4248-a87f-29a109a44b80
        required: true
      responses:
        '200':
          description: Resource representation of a created account.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudSqlAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountId: aa7a5025-65c2-4e17-bbc0-79dcaec44010:88e22604-6b71-4075-bfa1-1555099cf661:3e32736b-00b0-475f-b5ec-35d1a5ca91fd
                  accountName: Admin
                  userName: admin
                  password: 
                  description: Admin credentials
                  status: Available
                  applianceUid: 6d18e5fe-20e5-4248-a87f-29a109a44b80
                  siteUid: 56b9928e-5974-4c8d-b554-1df01966496c
                  managementAgentUid: 4fc927ce-b05a-4224-ba79-ade52ef79b9a
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  /infrastructure/sites/publicCloud/sqlAccounts/sync:
    post:
      tags:
        - Preview Operations
      summary: Recollect Public Cloud SQL Account Data
      description: Retrieves and updates data of public cloud SQL accounts.
      operationId: SyncPublicCloudSqlAccounts
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  '/infrastructure/sites/publicCloud/sqlAccounts/{sqlAccountId}':
    get:
      tags:
        - Preview Operations
      summary: Get Public Cloud SQL account
      description: Returns a resource representation of a public cloud SQL account with the specified ID.
      operationId: GetPublicCloudSqlAccount
      parameters:
        - name: sqlAccountId
          in: path
          description: Public cloud SQL account ID.
          required: true
          schema:
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudSqlAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountId: 72963529-e35b-447f-8891-8611709dc34d:cb74d5c1-d359-4745-b95d-ed69b2f184e1:4e7409a0-805b-4c21-a3fc-2d820561dddf
                  accountName: IAM
                  userName: ''
                  password: 
                  description: Default IAM credentials
                  status: Available
                  applianceUid: 6d6e647e-5dac-4218-ba1a-9257f758d736
                  siteUid: 56b9928e-5974-4c8d-b554-1df01966496c
                  managementAgentUid: 72963529-e35b-447f-8891-8611709dc34d
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PublicCloudSqlAccount'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
    patch:
      tags:
        - Preview Operations
      summary: Modify Public Cloud SQL Account
      description: Modifies a public cloud SQL account with the specified ID.
      operationId: UpdatePublicCloudSqlAccount
      parameters:
        - name: sqlAccountId
          in: path
          description: Public cloud SQL account ID.
          required: true
          schema:
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Admin credentials
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudSqlAccount'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  accountId: aa7a5025-65c2-4e17-bbc0-79dcaec44010:88e22604-6b71-4075-bfa1-1555099cf661:3e32736b-00b0-475f-b5ec-35d1a5ca91fd
                  accountName: Admin
                  userName: admin
                  password: 
                  description: Admin credentials
                  status: Available
                  applianceUid: 6d18e5fe-20e5-4248-a87f-29a109a44b80
                  siteUid: 56b9928e-5974-4c8d-b554-1df01966496c
                  managementAgentUid: 4fc927ce-b05a-4224-ba79-ade52ef79b9a
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PublicCloudSqlAccount'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
    delete:
      tags:
        - Preview Operations
      summary: Delete Public Cloud SQL Account
      description: Deletes a public cloud SQL account with the specified ID.
      operationId: DeletePublicCloudSqlAccount
      parameters:
        - name: sqlAccountId
          in: path
          description: Public cloud SQL account ID.
          required: true
          schema:
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
  /infrastructure/backupServers/repositories:
    get:
      tags:
        - Backup Servers
      summary: Get All Backup Repositories
      description: Returns a collection resource representation of all backup repositories.
      operationId: GetBackupRepositories
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupRepositoryExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupRepository'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    name: Default Backup Repository
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    _embedded: 
                  - instanceUid: f10a8f5c-419b-475a-9fae-5e6cd2075da3
                    name: Backup Repository 1
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    _embedded: 
                  - instanceUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    name: Default Backup Repository
                    backupServerUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                    _embedded: 
                  - instanceUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    name: Default Backup Repository
                    backupServerUid: 6f33878a-dd1b-4c44-9f4c-b9b1da249b1e
                    _embedded: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/publicCloud/policies:
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get All Veeam Backup for Public Clouds Policies
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds policies.
      operationId: GetPublicCloudPolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 872e407a-456b-47c2-9b93-e90b0bd83157
                    name: dvb555az vm
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Disabled
                    applianceManagementType: ByConsole
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    platformType: Azure
                    policyType: VirtualMachine
                  - instanceUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    name: dvb555az files
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByConsole
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    platformType: Azure
                    policyType: FileShare
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/{policyUid}':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Veeam Backup for Public Clouds Policy
      description: Returns a resource representation of a Veeam Backup for Public Clouds policy with the specified UID.
      operationId: GetPublicCloudPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                  name: dvb555az files
                  applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                  status: Idle
                  state: Enabled
                  applianceManagementType: ByConsole
                  backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                  organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                  platformType: Azure
                  policyType: FileShare
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Backup Server Public Cloud Policies
      summary: Delete Veeam Backup for Public Clouds Policy
      description: Deletes a Veeam Backup for Public Clouds policy with the specified UID.
      operationId: DeletePublicCloudPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/{policyUid}/start':
    post:
      tags:
        - Backup Server Public Cloud Policies
      summary: Start Veeam Backup for Public Clouds Policy
      description: Starts a Veeam Backup for Public Clouds policy with the specified UID.
      operationId: StartPublicCloudPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/{policyUid}/stop':
    post:
      tags:
        - Backup Server Public Cloud Policies
      summary: Stop Veeam Backup for Public Clouds Policy
      description: Stops a Veeam Backup for Public Clouds policy with the specified UID.
      operationId: StopPublicCloudPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/{policyUid}/enable':
    post:
      tags:
        - Backup Server Public Cloud Policies
      summary: Enable Veeam Backup for Public Clouds Policy
      description: Enables a Veeam Backup for Public Clouds policy with the specified UID.
      operationId: EnablePublicCloudPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/{policyUid}/disable':
    post:
      tags:
        - Backup Server Public Cloud Policies
      summary: Disable Veeam Backup for Public Clouds Policy
      description: Disables a Veeam Backup for Public Clouds policy with the specified UID.
      operationId: DisablePublicCloudPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupServers/publicCloud/policies/virtualMachines:
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get All Veeam Backup for Public Clouds VM Policies
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds VM policies.
      operationId: GetPublicCloudVirtualMachinePolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudVirtualMachinePolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 303ab2de-639f-4f4e-b0a5-2af4eaa2d718
                    name: EC2 Policy
                    applianceUid: 5e6bee18-a91e-4b1d-a77e-f9ae815b6730
                    status: Idle
                    state: Disabled
                    applianceManagementType: ByBackupServer
                    managementAgentUid: 19605e1d-1aca-42a9-821d-fa54ee35cb29
                    backupServerUid: 4bc08f55-bb47-4af6-8cba-a9d5be445954
                    organizationUid: 195a057e-828b-4beb-a34a-11d824ba7731
                    locationUid: fe08d7a7-8fcf-4613-a4e7-8c8625f60af0
                    instancesCount: 3
                    nextRun: 
                    platformType: Amazon
                  - instanceUid: 872e407a-456b-47c2-9b93-e90b0bd83157
                    name: dvb555az vm
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Disabled
                    applianceManagementType: ByConsole
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 2
                    nextRun: 
                    platformType: Azure
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/virtualMachines/{policyUid}':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Veeam Backup for Public Clouds VM Policy
      description: Returns a resource representation of a Veeam Backup for Public Clouds VM policy with the specified UID.
      operationId: GetPublicCloudVirtualMachinePolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudVirtualMachinePolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 303ab2de-639f-4f4e-b0a5-2af4eaa2d718
                  name: EC2 Policy
                  applianceUid: 5e6bee18-a91e-4b1d-a77e-f9ae815b6730
                  status: Idle
                  state: Disabled
                  applianceManagementType: ByBackupServer
                  managementAgentUid: 19605e1d-1aca-42a9-821d-fa54ee35cb29
                  backupServerUid: 4bc08f55-bb47-4af6-8cba-a9d5be445954
                  organizationUid: 195a057e-828b-4beb-a34a-11d824ba7731
                  locationUid: fe08d7a7-8fcf-4613-a4e7-8c8625f60af0
                  instancesCount: 3
                  nextRun: 
                  platformType: Amazon
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/policies/virtualMachines':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get All Veeam Backup for Public Clouds VM Policies Configured on Veeam Backup & Replication Server
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds VM policies configured on a Veeam Backup & Replication server with the spicified UID.
      operationId: GetPublicCloudVirtualMachinePoliciesByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudVirtualMachinePolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 303ab2de-639f-4f4e-b0a5-2af4eaa2d718
                    name: EC2 Policy
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Disabled
                    applianceManagementType: ByBackupServer
                    managementAgentUid: 19605e1d-1aca-42a9-821d-fa54ee35cb29
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 3
                    nextRun: 
                    platformType: Amazon
                  - instanceUid: 872e407a-456b-47c2-9b93-e90b0bd83157
                    name: dvb555az vm
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Disabled
                    applianceManagementType: ByConsole
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 2
                    nextRun: 
                    platformType: Azure
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/publicCloud/policies/virtualMachines/objects:
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Objects of All Veeam Backup for Public Clouds VM Policies
      description: Returns a collection resource representation of objects of all Veeam Backup for Public Clouds VM policies.
      operationId: GetPublicCloudVirtualMachinePoliciesObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudVirtualMachinePolicyObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0d685e42-b81a-4020-89ab-00ca7c26fc1d
                    instanceName: az-azure-fk002
                    policyUid: 872e407a-456b-47c2-9b93-e90b0bd83157
                    policyName: dvb555az vm
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: fqsguqr8ytp3asj545zw3ryrmtuirbw8uwotoyxjomsztjrjixo5
                    lastBackup:
                      endTime: '2024-07-18T15:03:50.4390580+02:00'
                      failureMessage: 
                      status: Success
                    lastArchive:
                      endTime: '2024-07-18T15:06:45.4109800+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastSnapshot:
                      endTime: '2024-07-18T15:00:46.7966700+02:00'
                      failureMessage: 
                      status: Success
                  - instanceUid: d002a962-d866-41c0-b5af-471b69ddaab4
                    instanceName: az-azure-fk001
                    policyUid: 872e407a-456b-47c2-9b93-e90b0bd83157
                    policyName: dvb555az vm
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: pynmb6apqhu79gkn8z8uciz6epwfezqczf2r5bqzppjc3hbe8i8o
                    lastBackup:
                      endTime: '2024-07-18T15:03:35.9142820+02:00'
                      failureMessage: 
                      status: Failed
                    lastArchive:
                      endTime: '2024-07-18T15:03:35.9142820+02:00'
                      failureMessage: 
                      status: Failed
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastSnapshot:
                      endTime: '2024-07-18T15:00:46.7966700+02:00'
                      failureMessage: 
                      status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/virtualMachines/{policyUid}/objects':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Objects of Veeam Backup for Public Clouds VM Policy
      description: Returns a collection resource representation of all objects of a Veeam Backup for Public Clouds VM policy with the specified UID.
      operationId: GetPublicCloudVirtualMachinePolicyObjects
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudVirtualMachinePolicyObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0d685e42-b81a-4020-89ab-00ca7c26fc1d
                    instanceName: az-azure-fk002
                    policyUid: 872e407a-456b-47c2-9b93-e90b0bd83157
                    policyName: dvb555az vm
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: fqsguqr8ytp3asj545zw3ryrmtuirbw8uwotoyxjomsztjrjixo5
                    lastBackup:
                      endTime: '2024-07-18T15:03:50.4390580+02:00'
                      failureMessage: 
                      status: Success
                    lastArchive:
                      endTime: '2024-07-18T15:06:45.4109800+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastSnapshot:
                      endTime: '2024-07-18T15:00:46.7966700+02:00'
                      failureMessage: 
                      status: Success
                  - instanceUid: d002a962-d866-41c0-b5af-471b69ddaab4
                    instanceName: az-azure-fk001
                    policyUid: 872e407a-456b-47c2-9b93-e90b0bd83157
                    policyName: dvb555az vm
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: pynmb6apqhu79gkn8z8uciz6epwfezqczf2r5bqzppjc3hbe8i8o
                    lastBackup:
                      endTime: '2024-07-18T15:03:35.9142820+02:00'
                      failureMessage: 
                      status: Failed
                    lastArchive:
                      endTime: '2024-07-18T15:03:35.9142820+02:00'
                      failureMessage: 
                      status: Failed
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastSnapshot:
                      endTime: '2024-07-18T15:00:46.7966700+02:00'
                      failureMessage: 
                      status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/policies/virtualMachines/objects':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Objects of Veeam Backup for Public Clouds VM Policies Configured on Veeam Backup & Replication Server
      description: Returns a collection resource representation of objects of all Veeam Backup for Public Clouds VM policies configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetPublicCloudVirtualMachinePoliciesObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudVirtualMachinePolicyObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0d685e42-b81a-4020-89ab-00ca7c26fc1d
                    instanceName: az-azure-fk002
                    policyUid: 872e407a-456b-47c2-9b93-e90b0bd83157
                    policyName: dvb555az vm
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: fqsguqr8ytp3asj545zw3ryrmtuirbw8uwotoyxjomsztjrjixo5
                    lastBackup:
                      endTime: '2024-07-18T15:03:50.4390580+02:00'
                      failureMessage: 
                      status: Success
                    lastArchive:
                      endTime: '2024-07-18T15:06:45.4109800+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastSnapshot:
                      endTime: '2024-07-18T15:00:46.7966700+02:00'
                      failureMessage: 
                      status: Success
                  - instanceUid: d002a962-d866-41c0-b5af-471b69ddaab4
                    instanceName: az-azure-fk001
                    policyUid: 872e407a-456b-47c2-9b93-e90b0bd83157
                    policyName: dvb555az vm
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: pynmb6apqhu79gkn8z8uciz6epwfezqczf2r5bqzppjc3hbe8i8o
                    lastBackup:
                      endTime: '2024-07-18T15:03:35.9142820+02:00'
                      failureMessage: 
                      status: Failed
                    lastArchive:
                      endTime: '2024-07-18T15:03:35.9142820+02:00'
                      failureMessage: 
                      status: Failed
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastSnapshot:
                      endTime: '2024-07-18T15:00:46.7966700+02:00'
                      failureMessage: 
                      status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/publicCloud/policies/fileShares:
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get All Veeam Backup for Public Clouds File Share Policies
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds file share policies.
      operationId: GetPublicCloudFileSharePolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudFileSharePolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    name: dvb555az files
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByConsole
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 1
                    platformType: Azure
                    nextRun: '2025-08-01T22:00:00.0000000+02:00'
                    backupTargetVaultName: '-'
                    backupCopyTargetVaultName: '-'
                  - instanceUid: 19a3fdd3-a3b8-4fc2-8d12-503bf906963e
                    name: dvb555az files2
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByConsole
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 1
                    platformType: Azure
                    nextRun: '2025-08-01T22:00:00.0000000+02:00'
                    backupTargetVaultName: '-'
                    backupCopyTargetVaultName: '-'
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/fileShares/{policyUid}':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Veeam Backup for Public Clouds File Share Policy
      description: Returns a resource representation of a Veeam Backup for Public Clouds file share policy.
      operationId: GetPublicCloudFileSharePolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudFileSharePolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                  name: dvb555az files
                  applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                  status: Idle
                  state: Enabled
                  applianceManagementType: ByConsole
                  managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                  backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                  organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                  locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                  instancesCount: 1
                  platformType: Azure
                  nextRun: '2025-08-01T22:00:00.0000000+02:00'
                  backupTargetVaultName: '-'
                  backupCopyTargetVaultName: '-'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/policies/fileShares':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get All Veeam Backup for Public Clouds File Share Policies Configured on Veeam Backup & Replication Server
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds file share policies configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetPublicCloudFileSharePoliciesByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudFileSharePolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    name: dvb555az files
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByConsole
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 1
                    platformType: Azure
                    nextRun: '2025-08-01T22:00:00.0000000+02:00'
                    backupTargetVaultName: '-'
                    backupCopyTargetVaultName: '-'
                  - instanceUid: 19a3fdd3-a3b8-4fc2-8d12-503bf906963e
                    name: dvb555az files2
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByConsole
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 1
                    platformType: Azure
                    nextRun: '2025-08-01T22:00:00.0000000+02:00'
                    backupTargetVaultName: '-'
                    backupCopyTargetVaultName: '-'
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/publicCloud/policies/fileShares/objects:
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Objects of All Veeam Backup for Public Clouds File Share Policies
      description: Returns a collection resource representation of objects of all Veeam Backup for Public Clouds file share policies.
      operationId: GetPublicCloudFileSharePoliciesObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudFileSharePolicyObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 3a064e57-ff09-417a-ba08-83fceac41d2f
                    instanceName: fs555az
                    policyUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    policyName: dvb555az files
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: pynmb6apqhu79gkn8z8uciz6epwfezqczf2r5bqzppjc3hbe8i8o
                    lastSnapshot:
                      endTime: '2024-07-31T22:00:53.0000000+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    fileShareType: AzureFiles
                  - instanceUid: 11ab183f-9d80-469a-aa40-2281617a12d2
                    instanceName: fs412az
                    policyUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    policyName: dvb555az files
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: fqsguqr8ytp3asj545zw3ryrmtuirbw8uwotoyxjomsztjrjixo5
                    lastSnapshot:
                      endTime: '2024-07-31T22:00:53.0000000+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    fileShareType: AzureFiles
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/fileShares/{policyUid}/objects':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Objects of Veeam Backup for Public Clouds File Share Policy
      description: Returns a collection resource representation of all objects of a Veeam Backup for Public Clouds file share policy with the specified UID.
      operationId: GetPublicCloudFileSharePolicyObjects
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudFileSharePolicyObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 3a064e57-ff09-417a-ba08-83fceac41d2f
                    instanceName: fs555az
                    policyUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    policyName: dvb555az files
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: pynmb6apqhu79gkn8z8uciz6epwfezqczf2r5bqzppjc3hbe8i8o
                    lastSnapshot:
                      endTime: '2024-07-31T22:00:53.0000000+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    fileShareType: AzureFiles
                  - instanceUid: 11ab183f-9d80-469a-aa40-2281617a12d2
                    instanceName: fs412az
                    policyUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    policyName: dvb555az files
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: fqsguqr8ytp3asj545zw3ryrmtuirbw8uwotoyxjomsztjrjixo5
                    lastSnapshot:
                      endTime: '2024-07-31T22:00:53.0000000+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    fileShareType: AzureFiles
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/policies/fileShares/objects':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Objects of All Veeam Backup for Public Clouds File Share Policies Configured on Veeam Backup & Replication Server
      description: Returns a collection resource representation of objects of all Veeam Backup for Public Clouds file share policies configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetPublicCloudFileSharePoliciesObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudFileSharePolicyObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 3a064e57-ff09-417a-ba08-83fceac41d2f
                    instanceName: fs555az
                    policyUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    policyName: dvb555az files
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: pynmb6apqhu79gkn8z8uciz6epwfezqczf2r5bqzppjc3hbe8i8o
                    lastSnapshot:
                      endTime: '2024-07-31T22:00:53.0000000+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    fileShareType: AzureFiles
                  - instanceUid: 11ab183f-9d80-469a-aa40-2281617a12d2
                    instanceName: fs412az
                    policyUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    policyName: dvb555az files
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    resourceId: fqsguqr8ytp3asj545zw3ryrmtuirbw8uwotoyxjomsztjrjixo5
                    lastSnapshot:
                      endTime: '2024-07-31T22:00:53.0000000+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    fileShareType: AzureFiles
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/publicCloud/policies/databases:
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get All Veeam Backup for Public Clouds Database Policies
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds database policies.
      operationId: GetPublicCloudDatabasePolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudDatabasePolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    name: RDS Policy
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByBackupServer
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 1
                    nextRun: '2025-08-12T04:00:00.0000000+02:00'
                    platformType: Amazon
                  - instanceUid: 19a3fdd3-a3b8-4fc2-8d12-503bf906963e
                    name: DynamoDB Policy
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByBackupServer
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 1
                    nextRun: '2025-08-15T05:00:00.0000000+02:00'
                    platformType: Amazon
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/databases/{policyUid}':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Veeam Backup for Public Clouds Database Policy
      description: Returns a resource representation of a Veeam Backup for Public Clouds database policy with the specified UID.
      operationId: GetPublicCloudDatabasePolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudDatabasePolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                  name: RDS Policy
                  applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                  status: Idle
                  state: Enabled
                  applianceManagementType: ByBackupServer
                  managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                  backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                  organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                  locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                  instancesCount: 1
                  nextRun: '2025-08-12T04:00:00.0000000+02:00'
                  platformType: Amazon
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/policies/databases':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Veeam Backup for Public Clouds Database Policies Configured on Veeam Backup & Replication Server
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds database policies configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetPublicCloudDatabasePoliciesByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudDatabasePolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 890e5f89-8c54-49a8-aa3e-95be50ddfeec
                    name: RDS Policy
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByBackupServer
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 1
                    nextRun: '2025-08-12T04:00:00.0000000+02:00'
                    platformType: Amazon
                  - instanceUid: 19a3fdd3-a3b8-4fc2-8d12-503bf906963e
                    name: DynamoDB Policy
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByBackupServer
                    managementAgentUid: 6e81abcb-72d8-45bc-a9ca-07cba0186f0f
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    locationUid: 3537f0af-45a0-42c3-8fbb-5017c55ddeb4
                    instancesCount: 1
                    nextRun: '2025-08-15T05:00:00.0000000+02:00'
                    platformType: Amazon
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/publicCloud/policies/databases/objects:
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Objects of All Veeam Backup for Public Clouds Database Policies
      description: Returns a collection resource representation of objects of all Veeam Backup for Public Clouds database policies.
      operationId: GetPublicCloudDatabasePoliciesObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudDatabasePolicyObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: a9bebe60-c74b-47f7-9039-66d255eb8e69
                    instanceName: azdb002
                    policyUid: 9d1cd99b-9c35-4835-bfb9-4822dc79ff59
                    policyName: azdb-job
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    databaseType: AzureSql
                    engineType: MsSql
                    resourceId: pynmb6apqhu79gkn8z8uciz6epwfezqczf2r5bqzppjc3hbe8i8o
                    lastBackup:
                      endTime: '2024-07-18T15:09:41.8619250+02:00'
                      failureMessage: 
                      status: Success
                    lastSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastArchive:
                      endTime: '2024-07-18T15:12:22.5729150+02:00'
                      failureMessage: 
                      status: Success
                  - instanceUid: a577ebea-0a80-4498-8e48-e7da3ee9ebe0
                    instanceName: azdb001
                    policyUid: d6164a65-e8b9-43a6-b5cd-6dc42dc7d18a
                    policyName: azdb-job
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    databaseType: AzureCosmosDb
                    engineType: Postgres
                    resourceId: fqsguqr8ytp3asj545zw3ryrmtuirbw8uwotoyxjomsztjrjixo5
                    lastBackup:
                      endTime: '2024-07-18T15:04:47.8843800+02:00'
                      failureMessage: 
                      status: Success
                    lastSnapshot:
                      endTime: '2024-07-19T11:41:34.5950400+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastArchive:
                      endTime: '2024-07-18T15:07:37.9276580+02:00'
                      failureMessage: 
                      status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/databases/{policyUid}/objects':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get All Objects of Veeam Backup for Public Clouds Database Policy
      description: Returns a collection resource representation of all objects of a Veeam Backup for Public Clouds database policy with the specified UID.
      operationId: GetPublicCloudDatabasePolicyObjects
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudDatabasePolicyObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: a9bebe60-c74b-47f7-9039-66d255eb8e69
                    instanceName: azdb002
                    policyUid: 9d1cd99b-9c35-4835-bfb9-4822dc79ff59
                    policyName: azdb-job
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    databaseType: AzureSql
                    engineType: MsSql
                    resourceId: pynmb6apqhu79gkn8z8uciz6epwfezqczf2r5bqzppjc3hbe8i8o
                    lastBackup:
                      endTime: '2024-07-18T15:09:41.8619250+02:00'
                      failureMessage: 
                      status: Success
                    lastSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastArchive:
                      endTime: '2024-07-18T15:12:22.5729150+02:00'
                      failureMessage: 
                      status: Success
                  - instanceUid: a577ebea-0a80-4498-8e48-e7da3ee9ebe0
                    instanceName: azdb001
                    policyUid: 9d1cd99b-9c35-4835-bfb9-4822dc79ff59
                    policyName: azdb-job
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    databaseType: AzureCosmosDb
                    engineType: Postgres
                    resourceId: fqsguqr8ytp3asj545zw3ryrmtuirbw8uwotoyxjomsztjrjixo5
                    lastBackup:
                      endTime: '2024-07-18T15:04:47.8843800+02:00'
                      failureMessage: 
                      status: Success
                    lastSnapshot:
                      endTime: '2024-07-19T11:41:34.5950400+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastArchive:
                      endTime: '2024-07-18T15:07:37.9276580+02:00'
                      failureMessage: 
                      status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/policies/databases/objects':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Objects of All Veeam Backup for Public Clouds Database Policies Configured on Veeam Backup & Replication Server
      description: Returns a collection resource representation of objects of all Veeam Backup for Public Clouds database policies configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetPublicCloudDatabasePoliciesObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudDatabasePolicyObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: a9bebe60-c74b-47f7-9039-66d255eb8e69
                    instanceName: azdb002
                    policyUid: 9d1cd99b-9c35-4835-bfb9-4822dc79ff59
                    policyName: azdb-job
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    databaseType: AzureSql
                    engineType: MsSql
                    resourceId: pynmb6apqhu79gkn8z8uciz6epwfezqczf2r5bqzppjc3hbe8i8o
                    lastBackup:
                      endTime: '2024-07-18T15:09:41.8619250+02:00'
                      failureMessage: 
                      status: Success
                    lastSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastArchive:
                      endTime: '2024-07-18T15:12:22.5729150+02:00'
                      failureMessage: 
                      status: Success
                  - instanceUid: a577ebea-0a80-4498-8e48-e7da3ee9ebe0
                    instanceName: azdb001
                    policyUid: 9d1cd99b-9c35-4835-bfb9-4822dc79ff59
                    policyName: azdb-job
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    databaseType: AzureCosmosDb
                    engineType: Postgres
                    resourceId: fqsguqr8ytp3asj545zw3ryrmtuirbw8uwotoyxjomsztjrjixo5
                    lastBackup:
                      endTime: '2024-07-18T15:04:47.8843800+02:00'
                      failureMessage: 
                      status: Success
                    lastSnapshot:
                      endTime: '2024-07-19T11:41:34.5950400+02:00'
                      failureMessage: 
                      status: Success
                    lastReplicaSnapshot:
                      endTime: 
                      failureMessage: 
                      status: None
                    lastArchive:
                      endTime: '2024-07-18T15:07:37.9276580+02:00'
                      failureMessage: 
                      status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/publicCloud/policies/networks:
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get All Veeam Backup for Public Clouds Network Policies
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds network policies.
      operationId: GetPublicCloudNetworkPolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudNetworkPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 303ab2de-639f-4f4e-b0a5-2af4eaa2d718
                    name: VPC Configuration Backup
                    applianceUid: 5e6bee18-a91e-4b1d-a77e-f9ae815b6730
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByBackupServer
                    organizationUid: 19605e1d-1aca-42a9-821d-fa54ee35cb29
                    backupServerUid: 4bc08f55-bb47-4af6-8cba-a9d5be445954
                    vnetType: AwsVpc
                    platformType: Amazon
                    subscriptionsCount: 0
                    regionsCount: 2
                    lastBackup:
                      endTime: '2025-08-08T16:00:36.3859310+02:00'
                      failureMessage: 
                      status: Success
                  - instanceUid: 70bef64b-3611-413a-99e8-b40802cbae32
                    name: Azure Virtual Network backup 1
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByConsole
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    vnetType: AzureVnet
                    platformType: Azure
                    subscriptionsCount: 1
                    regionsCount: 0
                    lastBackup:
                      endTime: '2025-08-01T12:00:29.3499450+02:00'
                      failureMessage: 
                      status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/publicCloud/policies/networks/{policyUid}':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get Veeam Backup for Public Clouds Network Policy
      description: Returns a resource representation of a Veeam Backup for Public Clouds network policy with the specified UID.
      operationId: GetPublicCloudNetworkPolicy
      parameters:
        - name: policyUid
          in: path
          description: Policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PublicCloudNetworkPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 70bef64b-3611-413a-99e8-b40802cbae32
                  name: Azure Virtual Network backup 1
                  applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                  status: Idle
                  state: Enabled
                  applianceManagementType: ByConsole
                  organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                  backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                  vnetType: AzureVnet
                  platformType: Azure
                  subscriptionsCount: 1
                  regionsCount: 0
                  lastBackup:
                    endTime: '2025-08-01T12:00:29.3499450+02:00'
                    failureMessage: 
                    status: Success
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/publicCloud/policies/networks':
    get:
      tags:
        - Backup Server Public Cloud Policies
      summary: Get All Veeam Backup for Public Clouds Network Policies Configured on Veeam Backup & Replication Server
      description: Returns a collection resource representation of all Veeam Backup for Public Clouds network policies configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetPublicCloudNetworkPoliciesByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PublicCloudNetworkPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 303ab2de-639f-4f4e-b0a5-2af4eaa2d718
                    name: VPC Configuration Backup
                    applianceUid: 5e6bee18-a91e-4b1d-a77e-f9ae815b6730
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByBackupServer
                    organizationUid: 19605e1d-1aca-42a9-821d-fa54ee35cb29
                    backupServerUid: 4bc08f55-bb47-4af6-8cba-a9d5be445954
                    vnetType: AwsVpc
                    platformType: Amazon
                    subscriptionsCount: 0
                    regionsCount: 2
                    lastBackup:
                      endTime: '2025-08-08T16:00:36.3859310+02:00'
                      failureMessage: 
                      status: Success
                  - instanceUid: 70bef64b-3611-413a-99e8-b40802cbae32
                    name: Azure Virtual Network backup 1
                    applianceUid: ba32446f-d91c-4be2-b793-bd5d0b056cdb
                    status: Idle
                    state: Enabled
                    applianceManagementType: ByConsole
                    organizationUid: cec838f7-e252-4cc8-9ad3-f63989e4924e
                    backupServerUid: c9336ea0-50d6-4be8-baa2-23b007f0ca71
                    vnetType: AzureVnet
                    platformType: Azure
                    subscriptionsCount: 1
                    regionsCount: 0
                    lastBackup:
                      endTime: '2025-08-01T12:00:29.3499450+02:00'
                      failureMessage: 
                      status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/repositories':
    get:
      tags:
        - Backup Servers
      summary: Get All Backup Repositories Connected to Backup Server
      description: Returns a collection resource representation of all backup repositories connected to a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupRepositoriesByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: companyUid
          in: query
          description: "UID of a company that owns a Veeam Backup & Replication server.\n> If you provide this parameter, only the repositories that available to the company will be returned.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupRepositoryExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupRepository'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    name: Default Backup Repository
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    _embedded: 
                  - instanceUid: f10a8f5c-419b-475a-9fae-5e6cd2075da3
                    name: Backup Repository 1
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    _embedded: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/repositories/{repositoryUid}':
    get:
      tags:
        - Backup Servers
      summary: Get Backup Repository
      description: Returns a resource representation of a backup repository with the specified UID.
      operationId: GetBackupRepository
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: repositoryUid
          in: path
          description: Backup repository.
          required: true
          schema:
            type: string
            format: uuid
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupRepositoryExpand'
          x-veeam-expand: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupRepository'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                  name: Default Backup Repository
                  backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  _embedded: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/proxies:
    get:
      tags:
        - Backup Servers
      summary: Get All Backup Proxies
      description: Returns a collection resource representation of all backup proxies.
      operationId: GetBackupProxies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupProxy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 50cbf622-129e-482a-9197-d67e5bb1fb1f
                    name: Backup Proxy
                    version: 12.1.0.2067
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isOutOfDate: false
                    isDisabled: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: VSPC1
                    status: Healthy
                    type: File
                  - instanceUid: 18b661c1-d9dc-4233-90a0-7e7b10dc2d09
                    name: VMware Backup Proxy
                    version: 12.1.0.2067
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isOutOfDate: false
                    isDisabled: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: VSPC1
                    status: Healthy
                    type: vSphere
                  - instanceUid: 50cbf622-129e-482a-9197-d67e5bb1fb1f
                    name: Backup Proxy
                    version: 12.1.0.2067
                    backupServerUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    isOutOfDate: false
                    isDisabled: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: R2SECONDCC
                    status: Healthy
                    type: File
                  - instanceUid: 18b661c1-d9dc-4233-90a0-7e7b10dc2d09
                    name: VMware Backup Proxy
                    version: 12.1.0.2067
                    backupServerUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    isOutOfDate: false
                    isDisabled: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: R2SECONDCC
                    status: Healthy
                    type: vSphere
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/proxies':
    get:
      tags:
        - Backup Servers
      summary: Get All Backup Proxies Connected to Backup Server
      description: Returns a collection resource representation of all backup proxies connected to a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupProxiesByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupProxy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 50cbf622-129e-482a-9197-d67e5bb1fb1f
                    name: Backup Proxy
                    version: 12.1.0.2067
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isOutOfDate: false
                    isDisabled: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: VSPC1
                    status: Healthy
                    type: File
                  - instanceUid: 18b661c1-d9dc-4233-90a0-7e7b10dc2d09
                    name: VMware Backup Proxy
                    version: 12.1.0.2067
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isOutOfDate: false
                    isDisabled: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: VSPC1
                    status: Healthy
                    type: vSphere
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/proxies/{proxyUid}':
    get:
      tags:
        - Backup Servers
      summary: Get Backup Proxy
      description: Returns a resource representation of a backup proxy with the specified UID.
      operationId: GetBackupProxy
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: proxyUid
          in: path
          description: Backup proxy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupProxy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 50cbf622-129e-482a-9197-d67e5bb1fb1f
                  name: Backup Proxy
                  version: 12.1.0.2067
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  isOutOfDate: false
                  isDisabled: false
                  hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                  hostName: VSPC1
                  status: Healthy
                  type: File
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/wanaccelerators:
    get:
      tags:
        - Backup Servers
      summary: Get All WAN Accelerators
      description: Returns a collection resource representation of all WAN accelerators.
      operationId: GetBackupWanAccelerators
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupWanAccelerator'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 00bdb123-c35a-43d6-ad03-7ba78e156ac4
                    name: VSPC1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    version: 12.0.0.1379
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: VSPC1
                    isOutOfDate: false
                    status: Healthy
                    isCloud: true
                  - instanceUid: bb323093-3e67-43a1-a692-b11d192829cd
                    name: R2THIRDVBR
                    backupServerUid: e48b073a-cf2e-42d2-bf3d-3eb8d2c32429
                    version: 11.0.0.837
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: R2THIRDVBR
                    isOutOfDate: false
                    status: Healthy
                    isCloud: false
                  - instanceUid: fe9af477-6771-4169-8261-9c1488515a9a
                    name: r2vbr
                    backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                    version: 12.0.0.1379
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: R2VBR
                    isOutOfDate: false
                    status: Healthy
                    isCloud: false
                  - instanceUid: ae996830-d7f3-452f-bf2d-2d9c3787093d
                    name: r2SecondVBR
                    backupServerUid: a6305f3c-46be-4c06-9bc4-97f2449d881f
                    version: 12.0.0.1379
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: R2SECONDVBR
                    isOutOfDate: false
                    status: Healthy
                    isCloud: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/wanaccelerators':
    get:
      tags:
        - Backup Servers
      summary: Get All WAN Accelerators Connected to Backup Server
      description: Returns a collection resource representation of all WAN accelerators connected to a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupWanAcceleratorsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupWanAccelerator'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 00bdb123-c35a-43d6-ad03-7ba78e156ac4
                    name: VSPC1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    version: 12.0.0.1379
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: VSPC1
                    isOutOfDate: false
                    status: Healthy
                    isCloud: true
                  - instanceUid: ae996830-d7f3-452f-bf2d-2d9c3787093d
                    name: r2SecondVBR
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    version: 12.0.0.1379
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    hostName: R2SECONDVBR
                    isOutOfDate: false
                    status: Healthy
                    isCloud: false
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/wanaccelerators/{wanAcceleratorUid}':
    get:
      tags:
        - Backup Servers
      summary: Get WAN Accelerator
      description: Returns a resource representation of a WAN accelerator with the specified UID.
      operationId: GetBackupWanAccelerator
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: wanAcceleratorUid
          in: path
          description: WAN accelerator UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupWanAccelerator'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 00bdb123-c35a-43d6-ad03-7ba78e156ac4
                  name: VSPC1
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  version: 12.0.0.1379
                  hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                  hostName: VSPC1
                  isOutOfDate: false
                  status: Healthy
                  isCloud: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/servers':
    get:
      tags:
        - Backup Servers
      summary: Get All Hosts Connected to Backup Server
      description: Returns a collection resource representation of all servers connected to a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerHostsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerHost'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e6cbe2c2-899b-431d-aaba-2853cdd50f1b
                    name: production.tech.local
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    type: ESXi
                  - instanceUid: e452c52a-5323-4454-b3d1-7cb389b2f9b5
                    name: ProductionCluster
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    type: ESX
                  - instanceUid: e00d8da1-aad9-4180-979e-33dc7ae964db
                    name: vcd103.tech.local
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    type: VcdSystem
                  - instanceUid: d9f4914a-c321-4436-a6ba-160a8f26e2db
                    name: vsrv.tech.local
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    type: ESXi
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/servers:
    get:
      tags:
        - Backup Servers
      summary: Get All Hosts Connected to Backup Servers
      description: Returns a collection resource representation of all servers connected to all Veeam Backup & Replication servers.
      operationId: GetBackupServerHosts
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerHost'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e6cbe2c2-899b-431d-aaba-2853cdd50f1b
                    name: production.tech.local
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    type: ESXi
                  - instanceUid: e452c52a-5323-4454-b3d1-7cb389b2f9b5
                    name: ProductionCluster
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    type: ESX
                  - instanceUid: e00d8da1-aad9-4180-979e-33dc7ae964db
                    name: vcd103.tech.local
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    type: VcdSystem
                  - instanceUid: d9f4914a-c321-4436-a6ba-160a8f26e2db
                    name: vsrv.tech.local
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    type: ESXi
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/servers/{serverUid}':
    get:
      tags:
        - Backup Servers
      summary: Get Host Connected to Backup Server
      description: Returns a resource representation of a server with the specified UID connected to a Veeam Backup & Replication server.
      operationId: GetBackupServerHost
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: serverUid
          in: path
          description: Server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerHost'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: e6cbe2c2-899b-431d-aaba-2853cdd50f1b
                  name: production.tech.local
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  type: ESXi
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/servers/virtualCenter/{virtualCenterUid}/tags':
    get:
      tags:
        - Backup Servers
      summary: Get Tags From Connected vCenter Server
      description: Returns a collection resource representation of tags collected from a vCenter Server with the specified UID connected to a Veeam Backup & Replication server.
      operationId: GetBackupServerVirtualServerTags
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: virtualCenterUid
          in: path
          description: vCenter Server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: companyUid
          in: query
          description: "Company UID.\n>If you provide UID of a company with hosted resources, the operation returns only the tags that are available to that company.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: nameFilter
          in: query
          description: "Name or part of a name of tags that must be returned by the operation.\n> This parameter is recommended over the `filter` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            type: string
            nullable: true
        - name: nameSortingDirection
          in: query
          description: "Type of resource alphabetical sorting by tag name.\n> This parameter is recommended over the `sort` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            enum:
              - ascending
              - descending
            type: string
            default: ascending
            x-ms-enum:
              name: SortDirection
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VirtualServerTag'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - urn: urn:vmomi:InventoryServiceTag:bb44fef1-fa74-4fd9-a952-307baa4ed61c:GLOBAL
                    name: lis-tag2
                    size: 
                  - urn: urn:vmomi:InventoryServiceTag:45132e4a-85f5-4906-9dd0-e42c7e4b966d:GLOBAL
                    name: lsm-tag
                    size: 
                  - urn: urn:vmomi:InventoryServiceTag:a4a6a104-557b-4bdf-8e2f-b9921fc5d811:GLOBAL
                    name: mchl
                    size: 
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/servers/virtualCenter/{virtualCenterUid}/tags/{tagUrn}/virtualMachines':
    get:
      tags:
        - Backup Servers
      summary: Get All VMs Marked With vCenter Server Tag
      description: Returns a resource representation of all VMs marked with a vCenter Server tag with the specified URN.
      operationId: GetBackupServerVirtualServerTagVirtualMachines
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: virtualCenterUid
          in: path
          description: vCenter Server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: tagUrn
          in: path
          description: Tag URN.
          required: true
          schema:
            type: string
        - name: nameFilter
          in: query
          description: "Name or part of a name of VMs that must be returned by the operation.\n> This parameter is recommended over the `filter` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            type: string
            nullable: true
        - name: nameSortingDirection
          in: query
          description: "Type of resource alphabetical sorting by VM name.\n> This parameter is recommended over the `sort` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            enum:
              - ascending
              - descending
            type: string
            default: ascending
            x-ms-enum:
              name: SortDirection
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVirtualMachine'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - urn: vm-91024
                    name: lis-l1-1
                    size: 63.4 GB
                  - urn: vm-91025
                    name: lis-l1-2
                    size: 62.9 GB
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/servers/virtualCenter/{virtualCenterUid}/objects/expand':
    post:
      tags:
        - Backup Servers
      summary: Get VMs In VMware vSphere VM Containers
      description: "Returns a collection resource representation of VMs included in the specified VMware vSphere VM containers.\n> Currently only VMware vSphere tags are supported. If you specify other VM containers, you will receive resource representations of these containers instead of VMs included in them.\n"
      operationId: ExpandBackupServerVirtualServerObjectContainers
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: virtualCenterUid
          in: path
          description: vCenter Server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of VMs and VM containers.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BackupServerBackupJobVmwareObjectSize'
            example:
              - inventoryObject:
                  hostName: esx01.tech.local
                  name: ProductionVms
                  type: Tag
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerBackupJobVmwareObjectSize'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - inventoryObject:
                      hostName: esx01.tech.local
                      name: winsrv2
                      type: VM
                      objectId: 
                    size: 
                  - inventoryObject:
                      hostName: esx01.tech.local
                      name: winsrv5
                      type: VM
                      objectId: 
                    size: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/credentials':
    get:
      tags:
        - Preview Operations
      summary: Get Veeam Backup & Replication Server Credentials.
      description: Returns a collection resource representation of all credentials stored on Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerCredentialsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: mappedOrganizationUidFilter
          in: query
          description: Value of a `mappedOrganizationUid` property that a resource must have to be included in a response.
          schema:
            type: string
            format: uuid
            nullable: true
        - name: orderColumn
          in: query
          description: Property by whose values the resources in a response must be sorted.
          schema:
            enum:
              - Username
              - Description
            type: string
            nullable: true
            x-ms-enum:
              name: BackupServerCredentialsFiltersOrderColumn
        - name: orderAsc
          in: query
          description: Determines whether resources in a response are retuned in the ascending order based on the `orderColumn` property value.
          schema:
            type: boolean
            nullable: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerCredentialsRecord'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 485966a4-aa17-4dd8-9afa-eb0c1b6dc0c4
                    type: Standard
                    username: .\administrator
                    description: .\administrator
                    creationTime: '2024-01-09T15:30:46.7917800+01:00'
                    mappedOrganizationUid: 
                    mappedOrganizationName: 
                    linuxCredentialsDetails: 
                  - instanceUid: b5ebaf50-2b63-4c48-839f-5f8a5452520b
                    type: Standard
                    username: root
                    description: Tenant-side network extension appliance credentials
                    creationTime: '2024-01-09T13:08:12.2393660+01:00'
                    mappedOrganizationUid: 
                    mappedOrganizationName: 
                    linuxCredentialsDetails: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/credentials/{credentialsUid}':
    delete:
      tags:
        - Preview Operations
      summary: Delete Veeam Backup & Replication Server Credentials Record.
      description: Deletes Veeam Backup & Replication server credentials record with the specified UID.
      operationId: DeleteBackupServerCredentials
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: credentialsUid
          in: path
          description: Credentials record UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/credentials/standard':
    post:
      tags:
        - Preview Operations
      summary: Add Veeam Backup & Replication Server Standard Credentials.
      description: Adds standard credentials for Veeam Backup & Replication server with the specified UID.
      operationId: CreateBackupServerStandardCredentials
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Veeam Backup & Replication server credentials.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupServerCredentialsStandardInput'
            example:
              username: admin
              password: Password1
              description: Credentials for Alpha company administrator
              mappedOrganizationUid: 988c4583-5336-4e20-892d-eabcca0b34ac
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerCredentialsStandard'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 31e02b1f-a290-4977-809b-f99a4704f81e
                  username: admin
                  description: Credentials for Alpha company administrator
                  creationTime: '2024-07-28T14:59:49.9190000+00:00'
                  mappedOrganizationUid: 988c4583-5336-4e20-892d-eabcca0b34ac
                  mappedOrganizationName: Alpha
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/credentials/linux':
    post:
      tags:
        - Preview Operations
      summary: Add Veeam Backup & Replication Server Linux Credentials
      description: Adds Linux credentials for a Veeam Backup & Replication server with the specified UID.
      operationId: CreateBackupServerLinuxCredentials
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Linux credentials.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupServerCredentialsLinuxInput'
            example:
              username: admin
              password: Password1
              description: Credentials for Alpha company administrator
              mappedOrganizationUid: 988c4583-5336-4e20-892d-eabcca0b34ac
              sshPort: 22
              autoElevated: true
              addToSudoers: true
              useSu: false
              privateKey: '-----BEGIN RSA PRIVATE KEY-----MIIEowIBAAKCAQEAmqsrgygo+hDxXAZVB6nyqAL/O8h+SQn/iVcW8wfCsqw7S9KMnRvEQ3PM7ULZvOFDKCoBt1j4kHELVm3HKRtqatEyqCPrB8gBZuTVsi14naNYL40qJqgCuMCsNRosoG6pSUEwddSQ2uELez3eDm/f0H0kuyMf3VRqz5o3mRo0Vujs+xhD8FXQYEuTvEANetdIlA8FrQQAlx0dxTKuKK1tYvbPqASP01eHmj/Vr/nKJX/BoZcSSSbEwpbqS4KlQHhlC0a7x/pfTurLwNKCQJWivhab6hCUanpttac3Hb2hQFdhymoI15j571i9yXam6Ul6i9qkW+M0x7m8Kd6lrOyVnwIDAQABAoIBAFib+9+2IFOzZTNdhVVQre5HWUY8xOy/R6C9Pi6ZoZePSKFVzK0tfTFPpHXBONEXFMxr1HPgCvdlbCNl3RXV2Q+9LhJaEYpxsSvrqencVx+otxr2+tEOrBCAgagiiLKY828+Y679ysc66sL+XLtUqJrfNy3nH5hDhrXNGlEiTB4Fi85f4us4Iqzg3Wc2TdAL6GX8qGmzopHG2PWGjHVeVnPerBfLgXhEtZSng3B57LGs9KQzfOi9kie0Cso3e5yorky10Y4B7cd/hioI34PZMlfSsRuc0UfnQUAtLMiLCSFBejZbyvp8EW3sVLzN/Ho1aKbQWS7A9m0FKKddJyVptdECgYEAx+2WSjaOL9HQMgT+j9U0DfXY321m+F/IRfcDRIBE/4fVeB2sfS5k/4zvgXEAsmoclRea7S8d2gQ81yo87mQbfkseM1SeA7uQzjOTPTiIcdNip/O5kDKUMszaMqckDAVflcD8M+F+mXdoLUgFH13S/UVRHZLJUoK1wP0RmIWqLQUCgYEAxgwM+m1hXfLPQi//D1aPk1ok3n1++aSCkzzucrMQ+pIZOnpE6x0EOBrccc9qkYzuDAj7VTJKhD39OD8+ZIIkICo1m9RVjfP/t+mgycBp4LaFsPaq7hhJOVhU7UvupnqJpOag3VUTKeUWtxbozNS/KqZa1bTq/kCEr4d42wH4mVMCgYAC3hmFvvqTHQNLdF7iWUCB4sDVk5Aih90rg7t8RAq5T410R5itwviX4cGdra1A4dy/FrOWK1LWSbFFtMli8fSi/xjTy6bojswo6Px3qFPsrgeAOTK0KsWNZPrMNzGBKqKQV1BGvjk+okPQQnQwWvwnvdLIBc71bAKHXhnegixKsQKBgQC0pmFgPU3HaKhtc2JxF0A35M4ktMyR4uHIdJf8wCIIriOdF9Kts/YZR0c1+UD4K1koWTkI6arXHcRQ/j9nZt6VCGuGDRVNOvhTRiSIY58wfs1MMnSQYk7IpC4zlkPGT5gmdsjdm7CzUmh58cfAr38A5GWO8kw4R5nAkw5Gl3GwSQKBgCgsVH+KxM4Y1jTyL+p/JK3roQ4wbFPQH3yTOYbQKUcLjzXY9yQ4OecoUoXjrbsaMn6unRdoSgosxP9s4OoTHpUdUfWJhhjr3zvm6/tU3dPc+U0UbUf4DZvto+JzdSVqUtBQlo5T/yYK0OIhQakvHGunaeWnj4cUT86kFzTizeJT-----END RSA PRIVATE KEY-----'
              passphrase: Passphrase1
              rootPassword: Rootpass1
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerCredentialsLinux'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 09267bab-7504-467a-92d0-ae650feb1295
                  username: admin
                  description: Credentials for Alpha company administrator
                  creationTime: '2024-07-28T15:03:23.0960000+00:00'
                  sshPort: 22
                  autoElevated: true
                  addToSudoers: true
                  useSu: false
                  privateKey: '-----BEGIN RSA PRIVATE KEY-----MIIEowIBAAKCAQEAmqsrgygo+hDxXAZVB6nyqAL/O8h+SQn/iVcW8wfCsqw7S9KMnRvEQ3PM7ULZvOFDKCoBt1j4kHELVm3HKRtqatEyqCPrB8gBZuTVsi14naNYL40qJqgCuMCsNRosoG6pSUEwddSQ2uELez3eDm/f0H0kuyMf3VRqz5o3mRo0Vujs+xhD8FXQYEuTvEANetdIlA8FrQQAlx0dxTKuKK1tYvbPqASP01eHmj/Vr/nKJX/BoZcSSSbEwpbqS4KlQHhlC0a7x/pfTurLwNKCQJWivhab6hCUanpttac3Hb2hQFdhymoI15j571i9yXam6Ul6i9qkW+M0x7m8Kd6lrOyVnwIDAQABAoIBAFib+9+2IFOzZTNdhVVQre5HWUY8xOy/R6C9Pi6ZoZePSKFVzK0tfTFPpHXBONEXFMxr1HPgCvdlbCNl3RXV2Q+9LhJaEYpxsSvrqencVx+otxr2+tEOrBCAgagiiLKY828+Y679ysc66sL+XLtUqJrfNy3nH5hDhrXNGlEiTB4Fi85f4us4Iqzg3Wc2TdAL6GX8qGmzopHG2PWGjHVeVnPerBfLgXhEtZSng3B57LGs9KQzfOi9kie0Cso3e5yorky10Y4B7cd/hioI34PZMlfSsRuc0UfnQUAtLMiLCSFBejZbyvp8EW3sVLzN/Ho1aKbQWS7A9m0FKKddJyVptdECgYEAx+2WSjaOL9HQMgT+j9U0DfXY321m+F/IRfcDRIBE/4fVeB2sfS5k/4zvgXEAsmoclRea7S8d2gQ81yo87mQbfkseM1SeA7uQzjOTPTiIcdNip/O5kDKUMszaMqckDAVflcD8M+F+mXdoLUgFH13S/UVRHZLJUoK1wP0RmIWqLQUCgYEAxgwM+m1hXfLPQi//D1aPk1ok3n1++aSCkzzucrMQ+pIZOnpE6x0EOBrccc9qkYzuDAj7VTJKhD39OD8+ZIIkICo1m9RVjfP/t+mgycBp4LaFsPaq7hhJOVhU7UvupnqJpOag3VUTKeUWtxbozNS/KqZa1bTq/kCEr4d42wH4mVMCgYAC3hmFvvqTHQNLdF7iWUCB4sDVk5Aih90rg7t8RAq5T410R5itwviX4cGdra1A4dy/FrOWK1LWSbFFtMli8fSi/xjTy6bojswo6Px3qFPsrgeAOTK0KsWNZPrMNzGBKqKQV1BGvjk+okPQQnQwWvwnvdLIBc71bAKHXhnegixKsQKBgQC0pmFgPU3HaKhtc2JxF0A35M4ktMyR4uHIdJf8wCIIriOdF9Kts/YZR0c1+UD4K1koWTkI6arXHcRQ/j9nZt6VCGuGDRVNOvhTRiSIY58wfs1MMnSQYk7IpC4zlkPGT5gmdsjdm7CzUmh58cfAr38A5GWO8kw4R5nAkw5Gl3GwSQKBgCgsVH+KxM4Y1jTyL+p/JK3roQ4wbFPQH3yTOYbQKUcLjzXY9yQ4OecoUoXjrbsaMn6unRdoSgosxP9s4OoTHpUdUfWJhhjr3zvm6/tU3dPc+U0UbUf4DZvto+JzdSVqUtBQlo5T/yYK0OIhQakvHGunaeWnj4cUT86kFzTizeJT-----END RSA PRIVATE KEY-----'
                  passphrase: Passphrase1
                  mappedOrganizationUid: 988c4583-5336-4e20-892d-eabcca0b34ac
                  mappedOrganizationName: Alpha
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/encryptionPasswords':
    get:
      tags:
        - Preview Operations
      summary: Get Veeam Backup & Replication Server Encryption Passwords
      description: Returns a collection resource representation of all encryption passwords created on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerEncryptionPasswordsByServer
      parameters:
        - name: mappedOrganizationUidFilter
          in: query
          description: Value of a `mappedOrganizationUid` property that a resource must have to be included in a response.
          schema:
            type: string
            format: uuid
            nullable: true
        - name: orderColumn
          in: query
          description: Property by whose values the resources in a response must be sorted.
          schema:
            enum:
              - Hint
              - ModificationTime
            type: string
            nullable: true
            x-ms-enum:
              name: BackupServerEncryptionPasswordsFiltersOrderColumn
        - name: orderAsc
          in: query
          description: Defines whether resources in a response are retuned in the ascending order based on the `orderColumn` property value.
          schema:
            type: boolean
            nullable: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerEncryptionPassword'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e2a204a8-8cee-423b-bd3d-1815f8bcc0db
                    uniqueId: 85690e8b-df4a-446e-8f66-d00ad6e6d2d4
                    hint: Standard password
                    modificationTime: '2024-07-28T15:23:15.1500000+00:00'
                    mappedOrganizationUid: 988c4583-5336-4e20-892d-eabcca0b34ac
                    mappedOrganizationName: Alpha
                  - instanceUid: a6119822-cf4e-4781-a0c5-c5eb777d4169
                    uniqueId: a82b3fb4-0aa9-466b-bdb6-db7f708d4fcc
                    hint: admin credentials
                    modificationTime: '2024-07-28T15:23:15.1500000+00:00'
                    mappedOrganizationUid: 9d1572d6-41e0-400e-8969-b1efee41d786
                    mappedOrganizationName: Beta
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Preview Operations
      summary: Create Veeam Backup & Replication Server Encryption Password
      description: Creates a new encryption password on a Veeam Backup & Replication server with the specified UID.
      operationId: CreateBackupServerEncryptionPassword
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Veeam Backup & Replication server encryption password.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupServerEncryptionPasswordInput'
            example:
              password: Password1
              uniqueId: 85690e8b-df4a-446e-8f66-d00ad6e6d2d4
              hint: Standard password
              mappedOrganizationUid: 988c4583-5336-4e20-892d-eabcca0b34ac
              mappedOrganizationName: Alpha
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerEncryptionPassword'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: e2a204a8-8cee-423b-bd3d-1815f8bcc0db
                  uniqueId: 85690e8b-df4a-446e-8f66-d00ad6e6d2d4
                  hint: Standard password
                  modificationTime: '2024-07-28T15:23:15.1500000+00:00'
                  mappedOrganizationUid: 988c4583-5336-4e20-892d-eabcca0b34ac
                  mappedOrganizationName: Alpha
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    parameters:
      - name: backupServerUid
        in: path
        description: Veeam Backup & Replication server UID.
        required: true
        schema:
          type: string
          format: uuid
  '/infrastructure/backupServers/{backupServerUid}/encryptionPasswords/{passwordUid}':
    delete:
      tags:
        - Preview Operations
      summary: Delete Veeam Backup & Replication Server Encryption Password
      description: Deletes a Veeam Backup & Replication server encryption password with the specified UID.
      operationId: DeleteBackupServerEncryptionPassword
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    parameters:
      - name: backupServerUid
        in: path
        description: Veeam Backup & Replication server UID.
        required: true
        schema:
          type: string
          format: uuid
      - name: passwordUid
        in: path
        description: Veeam Backup & Replication server encryption password UID.
        required: true
        schema:
          type: string
          format: uuid
  /infrastructure/backupServers/jobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Jobs
      description: Returns a collection resource representation of all jobs on all Veeam Backup & Replication servers.
      operationId: GetBackupServerJobs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: cc2b33a6-f11b-6f5f-b297-a5ee7cdbfc84
                    originalUid: 6a4c2357-29f4-4a28-b7a8-1870ea6f4e5a
                    name: CloudReplicaJob
                    description: Created by Powershell at 7/17/2024 6:48:08 PM.
                    createdBy: R2VBR\Administrator
                    creationTime: '2024-07-18T03:48:09.6830000+02:00'
                    backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                    locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                    siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                    mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                    status: Warning
                    type: ReplicationVM
                    lastRun: '2024-07-18T03:48:09.7630000+02:00'
                    lastEndTime: '2024-07-18T03:54:52.4800000+02:00'
                    lastDuration: 402
                    processingRate: 127782020
                    avgDuration: 402
                    transferredData: 16115584998
                    backupChainSize: 0
                    bottleneck: Target
                    isEnabled: true
                    scheduleType: NotScheduled
                    failureMessage: "ivz10_2:\r\nOne or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues.\r\n"
                    targetType: Cloud
                    destination: Hardware plan 1
                    retentionLimit: 7
                    retentionLimitType: RestorePoints
                    isGfsOptionEnabled: false
                    lastSessionTasks:
                      - instanceUid: dc7fc45c-0dfb-4727-b974-87885534c9ce
                        objectUid: 5c60fc5a-c2ea-4544-9703-908eec6ae262
                        objectName: ivz10_2
                        totalObjects: 6
                        processedObjects: 6
                        readDataSize: 24234688512
                        transferredDataSize: 16115584998
                        startTime: '2024-07-18T03:48:21.9030000+02:00'
                        endTime: '2024-07-18T03:54:42.9030000+02:00'
                        duration: 381
                        failureMessages:
                          - One or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues
                        status: Warning
                  - instanceUid: d9971f61-d018-62eb-b3ec-5988e957f8e8
                    originalUid: 890b3563-e468-4c5c-b80e-9f052a63b25d
                    name: BackupJob1
                    description: BackupJob1
                    createdBy: R2SECONDVBR\Administrator
                    creationTime: '2024-07-18T03:32:14.6000000+02:00'
                    backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                    locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                    siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                    organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                    mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                    status: Failed
                    type: BackupVm
                    lastRun: '2024-07-18T07:55:25.0700000+02:00'
                    lastEndTime: '2024-07-18T07:55:40.7570000+02:00'
                    lastDuration: 15
                    processingRate: 0
                    avgDuration: 61
                    transferredData: 0
                    backupChainSize: 1630208
                    bottleneck: None
                    isEnabled: true
                    scheduleType: NotScheduled
                    failureMessage: "Error: Operation was canceled by user SYSTEM.\r\n"
                    targetType: Local
                    destination: Default Backup Repository
                    retentionLimit: 7
                    retentionLimitType: Days
                    isGfsOptionEnabled: false
                    lastSessionTasks:
                      - instanceUid: bfac67d7-8ab8-4576-8013-b228ce1eafa6
                        objectUid: d2b0cbac-8315-4fed-be9f-40790f3b1e12
                        objectName: vm23
                        totalObjects: 
                        processedObjects: 
                        readDataSize: 
                        transferredDataSize: 
                        startTime: '2024-07-18T07:55:30.8800000+02:00'
                        endTime: '2024-07-18T07:55:37.8800000+02:00'
                        duration: 7
                        failureMessages:
                          - Operation was canceled by user SYSTEM
                        status: Failed
                  - instanceUid: bd85b21b-76d7-65cf-9bf7-d40da96696db
                    originalUid: 3f293c3e-0847-4f89-ada7-1c3ec4f94b85
                    name: BackupJob2
                    description: BackupJob2
                    createdBy: R2THIRDVBR\Administrator
                    creationTime: '2024-07-18T03:19:27.3630000+02:00'
                    backupServerUid: 11fcba52-d408-47b7-9b3a-e850257afe85
                    locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                    siteUid: 
                    organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    mappedOrganizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    status: Success
                    type: BackupVm
                    lastRun: '2024-07-18T03:19:27.6770000+02:00'
                    lastEndTime: '2024-07-18T03:20:35.3470000+02:00'
                    lastDuration: 67
                    processingRate: 0
                    avgDuration: 67
                    transferredData: 0
                    backupChainSize: 1630208
                    bottleneck: None
                    isEnabled: true
                    scheduleType: NotScheduled
                    failureMessage: 
                    targetType: Local
                    destination: Default Backup Repository
                    retentionLimit: 7
                    retentionLimitType: Days
                    isGfsOptionEnabled: false
                    lastSessionTasks:
                      - instanceUid: 712cead8-593e-4a9e-91a4-69f33a9e8309
                        objectUid: 2ce156b6-d77a-4e44-bcd3-84593032260c
                        objectName: vm34
                        totalObjects: 4
                        processedObjects: 4
                        readDataSize: 
                        transferredDataSize: 
                        startTime: '2024-07-18T03:19:44.6600000+02:00'
                        endTime: '2024-07-18T03:20:28.6600000+02:00'
                        duration: 44
                        failureMessages: [ ]
                        status: Success
                  - instanceUid: 2e13e257-75b9-6b93-9490-13bde4138a06
                    originalUid: fb5e45d9-2eec-4fe0-8d27-da075d533ff5
                    name: ReplicationJob1
                    description: Created by Powershell at 7/17/2024 6:20:50 PM.
                    createdBy: R2THIRDVBR\Administrator
                    creationTime: '2024-07-18T03:20:54.6270000+02:00'
                    backupServerUid: 11fcba52-d408-47b7-9b3a-e850257afe85
                    locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                    siteUid: 
                    organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    mappedOrganizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    status: Success
                    type: ReplicationVM
                    lastRun: '2024-07-18T03:20:54.7370000+02:00'
                    lastEndTime: '2024-07-18T03:22:23.1270000+02:00'
                    lastDuration: 88
                    processingRate: 0
                    avgDuration: 88
                    transferredData: 0
                    backupChainSize: 0
                    bottleneck: None
                    isEnabled: true
                    scheduleType: NotScheduled
                    failureMessage: 
                    targetType: Local
                    destination: pdc159.tech.local
                    retentionLimit: 7
                    retentionLimitType: RestorePoints
                    isGfsOptionEnabled: false
                    lastSessionTasks:
                      - instanceUid: d59b7e7f-0703-47c3-b960-55552124c260
                        objectUid: 2ce156b6-d77a-4e44-bcd3-84593032260c
                        objectName: vm23
                        totalObjects: 4
                        processedObjects: 4
                        readDataSize: 
                        transferredDataSize: 
                        startTime: '2024-07-18T03:21:06.6600000+02:00'
                        endTime: '2024-07-18T03:22:12.6600000+02:00'
                        duration: 66
                        failureMessages: [ ]
                        status: Success
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Jobs Configured on Backup Server
      description: Returns a collection resource representation of all jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerJobByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: bd85b21b-76d7-65cf-9bf7-d40da96696db
                    originalUid: 3f293c3e-0847-4f89-ada7-1c3ec4f94b85
                    name: BackupJob2
                    description: BackupJob2
                    createdBy: R2THIRDVBR\Administrator
                    creationTime: '2024-07-18T03:19:27.3630000+02:00'
                    backupServerUid: 11fcba52-d408-47b7-9b3a-e850257afe85
                    locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                    siteUid: 
                    organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    mappedOrganizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    status: Success
                    type: BackupVm
                    lastRun: '2024-07-18T03:19:27.6770000+02:00'
                    lastEndTime: '2024-07-18T03:20:35.3470000+02:00'
                    lastDuration: 67
                    processingRate: 0
                    avgDuration: 67
                    transferredData: 0
                    backupChainSize: 1630208
                    bottleneck: None
                    isEnabled: true
                    scheduleType: NotScheduled
                    failureMessage: 
                    targetType: Local
                    destination: Default Backup Repository
                    retentionLimit: 7
                    retentionLimitType: Days
                    isGfsOptionEnabled: false
                    lastSessionTasks:
                      - instanceUid: 712cead8-593e-4a9e-91a4-69f33a9e8309
                        objectUid: 2ce156b6-d77a-4e44-bcd3-84593032260c
                        objectName: vm23
                        totalObjects: 4
                        processedObjects: 4
                        readDataSize: 
                        transferredDataSize: 
                        startTime: '2024-07-18T03:19:44.6600000+02:00'
                        endTime: '2024-07-18T03:20:28.6600000+02:00'
                        duration: 44
                        failureMessages: [ ]
                        status: Success
                  - instanceUid: 2e13e257-75b9-6b93-9490-13bde4138a06
                    originalUid: fb5e45d9-2eec-4fe0-8d27-da075d533ff5
                    name: ReplicationJob1
                    description: Created by Powershell at 7/17/2024 6:20:50 PM.
                    createdBy: R2THIRDVBR\Administrator
                    creationTime: '2024-07-18T03:20:54.6270000+02:00'
                    backupServerUid: 11fcba52-d408-47b7-9b3a-e850257afe85
                    locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                    siteUid: 
                    organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    mappedOrganizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                    status: Success
                    type: ReplicationVM
                    lastRun: '2024-07-18T03:20:54.7370000+02:00'
                    lastEndTime: '2024-07-18T03:22:23.1270000+02:00'
                    lastDuration: 88
                    processingRate: 0
                    avgDuration: 88
                    transferredData: 0
                    backupChainSize: 0
                    bottleneck: None
                    isEnabled: true
                    scheduleType: NotScheduled
                    failureMessage: 
                    targetType: Local
                    destination: pd159.tech.local
                    retentionLimit: 7
                    retentionLimitType: RestorePoints
                    isGfsOptionEnabled: false
                    lastSessionTasks:
                      - instanceUid: d59b7e7f-0703-47c3-b960-55552124c260
                        objectUid: 2ce156b6-d77a-4e44-bcd3-84593032260c
                        objectName: vm23
                        totalObjects: 4
                        processedObjects: 4
                        readDataSize: 
                        transferredDataSize: 
                        startTime: '2024-07-18T03:21:06.6600000+02:00'
                        endTime: '2024-07-18T03:22:12.6600000+02:00'
                        duration: 66
                        failureMessages: [ ]
                        status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get Job
      description: Returns a resource representation of a job with the specified UID.
      operationId: GetBackupServerJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: a7e071d7-c999-67f5-815d-a9d8eb917c5c
                  originalUid: 81c0525e-124f-478e-9343-3d15b9f622ce
                  name: Backup Job 1
                  description: Backup Job 1
                  createdBy: R2VBR\Administrator
                  creationTime: '2024-07-18T03:36:49.1300000+02:00'
                  backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                  locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                  siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                  mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                  status: Starting
                  type: BackupVm
                  lastRun: '2024-07-18T03:36:49.2070000+02:00'
                  lastEndTime: '2024-07-18T03:37:51.8000000+02:00'
                  lastDuration: 62
                  processingRate: 0
                  avgDuration: 62
                  transferredData: 0
                  backupChainSize: 1630208
                  bottleneck: None
                  isEnabled: true
                  scheduleType: NotScheduled
                  failureMessage: 
                  targetType: Cloud
                  destination: Cloud Repository default
                  retentionLimit: 7
                  retentionLimitType: Days
                  isGfsOptionEnabled: false
                  lastSessionTasks:
                    - instanceUid: 6078ce06-b81f-49be-91f4-75633df6cf3f
                      objectUid: 58b00188-daea-48b1-b6f5-db39980b14d3
                      objectName: vm23
                      totalObjects: 4
                      processedObjects: 4
                      readDataSize: 
                      transferredDataSize: 
                      startTime: '2024-07-18T03:37:07.0370000+02:00'
                      endTime: '2024-07-18T03:37:49.0370000+02:00'
                      duration: 42
                      failureMessages: [ ]
                      status: Success
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Backup Server Jobs
      summary: Modify Job
      description: Modifies a job with the specified UID. Returns a positive response when the task is added to the internal queue and not when the task is executed.
      operationId: PatchBackupServerJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /isEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: bf21b419-4f55-6531-b0b7-a21cfefa8a8a
                  originalUid: f97f671f-2dfd-5848-80fa-95e9473adaa0
                  name: NASBackupJob 1
                  description: ''
                  createdBy: R2SECONDVBR\Administrator
                  creationTime: '2024-07-18T03:40:38.1430000+02:00'
                  backupServerUid: 17b0cf5a-c297-4142-974c-745a761362af
                  locationUid: 5d594944-11c6-4468-9b40-5f4a5851a9c0
                  siteUid: 6a467ae9-db57-4c61-ae5e-8c03d8a58a6f
                  organizationUid: e18336ae-f3aa-4254-a7e9-7718d805c3d9
                  mappedOrganizationUid: e18336ae-f3aa-4254-a7e9-7718d805c3d9
                  status: Disabling
                  type: BackupFileCopy
                  lastRun: '2024-07-18T03:41:39.3930000+02:00'
                  lastEndTime: '2024-07-18T03:42:14.2830000+02:00'
                  lastDuration: 34
                  processingRate: 1542364
                  avgDuration: 34
                  transferredData: 1580501
                  backupChainSize: 71728099
                  bottleneck: Proxy
                  isEnabled: true
                  scheduleType: Continuously
                  failureMessage: 
                  targetType: Local
                  destination: Default Backup Repository
                  retentionLimit: 7
                  retentionLimitType: Days
                  isGfsOptionEnabled: false
                  lastSessionTasks:
                    - instanceUid: 91c7ace2-21dc-52e2-bf96-ba29abf020ef
                      objectUid: f1a44a0c-fde1-430c-976d-0b54225aded0
                      objectName: \\r2SecondVBR.tech.local\C$\setup
                      totalObjects: 
                      processedObjects: 
                      readDataSize: 15423644
                      transferredDataSize: 1580501
                      startTime: '2024-07-18T03:41:51.8470000+02:00'
                      endTime: '2024-07-18T03:42:10.8470000+02:00'
                      duration: 19
                      failureMessages: [ ]
                      status: Success
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BackupServerJob'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    delete:
      tags:
        - Backup Server Jobs
      summary: Delete Job
      description: Delete a job with the specified UID.
      operationId: DeleteBackupServerJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/jobs/{jobUid}/assign':
    post:
      tags:
        - Backup Server Jobs
      summary: Assign Job to Company
      description: "Assign a job with the specified UID to a company.\n>Returns a positive response when the task is added to the internal queue and not when the task is executed.\n"
      operationId: AssignBackupServerJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/companyUid_query'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Backup Server Jobs
      summary: Unassign Job from Company
      description: "Unassigns a job with the specified UID from a company.\n>Returns a positive response when the task is added to the internal queue and not when the task is executed.\n"
      operationId: UnassignBackupServerJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/backupServers/jobs/{jobUid}/start':
    post:
      tags:
        - Backup Server Jobs
      summary: Start Job
      description: Starts a job with the specified UID. Returns a positive response when the task is added to the internal queue and not when the task is executed.
      operationId: StartBackupServerJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/jobs/{jobUid}/stop':
    post:
      tags:
        - Backup Server Jobs
      summary: Stop Job
      description: Stops a job with the specified UID. Returns a positive response when the task is added to the internal queue and not when the task is executed.
      operationId: StopBackupServerJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/jobs/{jobUid}/retry':
    post:
      tags:
        - Backup Server Jobs
      summary: Retry Job
      description: Retries a job with the specified UID. Returns a positive response when the retry task is added to the internal queue and not when the task is executed.
      operationId: RetryBackupServerJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupServers/jobs/backupVmJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All VM Backup Jobs
      description: Returns a collection resource representation of all backup jobs that protect VMs.
      operationId: GetBackupServerBackupVmJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerBackupVmJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerBackupVmJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: bd85b21b-76d7-65cf-9bf7-d40da96696db
                    subtype: VSphere
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    protectedVmCount: 1
                    _embedded:
                      backupServerJob:
                        instanceUid: bd85b21b-76d7-65cf-9bf7-d40da96696db
                        originalUid: 3f293c3e-0847-4f89-ada7-1c3ec4f94b85
                        name: VMBackupJob1
                        description: Backup Job 1
                        createdBy: R2THIRDVBR\Administrator
                        creationTime: '2024-07-18T03:19:27.3630000+02:00'
                        backupServerUid: 11fcba52-d408-47b7-9b3a-e850257afe85
                        locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                        siteUid: 
                        organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                        mappedOrganizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                        status: Success
                        type: BackupVm
                        lastRun: '2024-07-18T03:19:27.6770000+02:00'
                        lastEndTime: '2024-07-18T03:20:35.3470000+02:00'
                        lastDuration: 67
                        processingRate: 0
                        avgDuration: 67
                        transferredData: 0
                        backupChainSize: 1630208
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: 712cead8-593e-4a9e-91a4-69f33a9e8309
                            objectUid: 2ce156b6-d77a-4e44-bcd3-84593032260c
                            objectName: vm23
                            totalObjects: 4
                            processedObjects: 4
                            readDataSize: 
                            transferredDataSize: 
                            startTime: '2024-07-18T03:19:44.6600000+02:00'
                            endTime: '2024-07-18T03:20:28.6600000+02:00'
                            duration: 44
                            failureMessages: [ ]
                            status: Success
                  - instanceUid: 5d68dcc8-0c7e-6797-b643-b1cfceeb73ec
                    subtype: VSphere
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    protectedVmCount: 1
                    _embedded:
                      backupServerJob:
                        instanceUid: 5d68dcc8-0c7e-6797-b643-b1cfceeb73ec
                        originalUid: 77d668bf-af3b-44f4-907c-c55cec8d60bd
                        name: VMBackupJob2
                        description: Backup Job 2
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:33:56.7770000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: Success
                        type: BackupVm
                        lastRun: '2024-07-18T03:33:57.0730000+02:00'
                        lastEndTime: '2024-07-18T03:34:58.2270000+02:00'
                        lastDuration: 61
                        processingRate: 0
                        avgDuration: 61
                        transferredData: 0
                        backupChainSize: 1650688
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: 932e80a9-c919-4467-95f9-9d38e96f1784
                            objectUid: e651b9a9-c910-4b60-a9ee-4a84cacd9c13
                            objectName: vm34
                            totalObjects: 5
                            processedObjects: 5
                            readDataSize: 
                            transferredDataSize: 
                            startTime: '2024-07-18T03:34:13.3700000+02:00'
                            endTime: '2024-07-18T03:34:51.3700000+02:00'
                            duration: 38
                            failureMessages: [ ]
                            status: Success
                  - instanceUid: a7e071d7-c999-67f5-815d-a9d8eb917c5c
                    subtype: VSphere
                    targetRepositoryUid: 317054bc-11ff-4967-8afd-ceb3ae42d351
                    protectedVmCount: 1
                    _embedded:
                      backupServerJob:
                        instanceUid: a7e071d7-c999-67f5-815d-a9d8eb917c5c
                        originalUid: 81c0525e-124f-478e-9343-3d15b9f622ce
                        name: BackupJob2
                        description: Backup Job 2
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:36:49.1300000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: Success
                        type: BackupVm
                        lastRun: '2024-07-18T06:54:40.3070000+02:00'
                        lastEndTime: '2024-07-18T06:55:26.5970000+02:00'
                        lastDuration: 46
                        processingRate: 0
                        avgDuration: 54
                        transferredData: 0
                        backupChainSize: 3260416
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Cloud
                        destination: Cloud Repository default
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: 73db0584-5965-4aa0-8c5b-fd930d6b7cf8
                            objectUid: 58b00188-daea-48b1-b6f5-db39980b14d3
                            objectName: vm1
                            totalObjects: 4
                            processedObjects: 4
                            readDataSize: 
                            transferredDataSize: 
                            startTime: '2024-07-18T06:54:55.3530000+02:00'
                            endTime: '2024-07-18T06:55:23.3530000+02:00'
                            duration: 28
                            failureMessages: [ ]
                            status: Success
                  - instanceUid: de6e62f5-944f-61d4-bc7b-6092755adecc
                    subtype: VSphere
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    protectedVmCount: 1
                    _embedded:
                      backupServerJob:
                        instanceUid: de6e62f5-944f-61d4-bc7b-6092755adecc
                        originalUid: f35e2320-20f1-43b3-9423-4902f2c6803e
                        name: VM5BackupJob
                        description: Backup Job VM5
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:35:41.4770000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: Success
                        type: BackupVm
                        lastRun: '2024-07-18T03:35:41.5370000+02:00'
                        lastEndTime: '2024-07-18T03:36:36.3630000+02:00'
                        lastDuration: 54
                        processingRate: 0
                        avgDuration: 54
                        transferredData: 0
                        backupChainSize: 1650688
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: 05998331-da83-46e4-8d18-eab8e5d9486a
                            objectUid: e651b9a9-c910-4b60-a9ee-4a84cacd9c13
                            objectName: vm5
                            totalObjects: 5
                            processedObjects: 5
                            readDataSize: 
                            transferredDataSize: 
                            startTime: '2024-07-18T03:35:55.3330000+02:00'
                            endTime: '2024-07-18T03:36:32.3330000+02:00'
                            duration: 37
                            failureMessages: [ ]
                            status: Success
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/backupVmJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get VM Backup Job
      description: Returns a resource representation of a backup job with the specified UID that protects VMs.
      operationId: GetBackupServerBackupVmJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerBackupVmJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/backupVmJobs/vSphere/{jobUid}/configuration':
    get:
      tags:
        - Backup Server Jobs
      summary: Get VMware vSphere VM Backup Job Configuration
      description: Returns a resource representation of a configuration of a VMware vSphere VM backup job with the specified UID.
      operationId: GetBackupServerBackupVmVSphereJobConfiguration
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerBackupJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 1bcb374f-b346-68b3-bd70-2b40cc7ff6ae
                  originalUid: 7fa501dc-f769-4d71-83b1-4f6859c43925
                  name: Backup Job 23
                  description: Customized Job Configuration
                  isDisabled: false
                  mappedOrganizationUid: 3337e028-55e1-453f-800c-3085a43033c6
                  mappedOrganizationName: hosted
                  backupServerUid: 91d5797e-c80b-48e5-bb97-b9df5707f14f
                  backupServerName: vbr1
                  isHighPriority: false
                  virtualMachines:
                    includes:
                      - inventoryObject:
                          hostName: vc1.tech.local
                          name: lis-l1-1
                          type: VirtualMachine
                          objectId: vm-91024
                        size: 49.4 GB
                      - inventoryObject:
                          hostName: vc1.tech.local
                          name: lis-l1-2
                          type: VirtualMachine
                          objectId: vm-91025
                        size: 49.4 GB
                    excludes:
                      vms: [ ]
                      disks:
                        - vmObject:
                            hostName: vc1.tech.local
                            name: lis-l1-1
                            type: VirtualMachine
                            objectId: vm-91024
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                        - vmObject:
                            hostName: vc1.tech.local
                            name: lis-l1-2
                            type: VirtualMachine
                            objectId: vm-91025
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                      templates:
                        isEnabled: true
                        excludeFromIncremental: true
                  storage:
                    backupRepositoryId: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    backupProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    retentionPolicy:
                      type: Days
                      quantity: 7
                    gfsPolicy:
                      isEnabled: false
                      weekly:
                        isEnabled: false
                        keepForNumberOfWeeks: 1
                        desiredTime: Monday
                      monthly:
                        isEnabled: false
                        keepForNumberOfMonths: 1
                        desiredTime: First
                      yearly:
                        isEnabled: false
                        keepForNumberOfYears: 1
                        desiredTime: Jan
                    advancedSettings:
                      backupModeType: Incremental
                      syntheticFulls:
                        isEnabled: true
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      activeFulls:
                        isEnabled: false
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      backupHealth:
                        isEnabled: false
                        weekly:
                          isEnabled: false
                          days:
                            - Saturday
                        monthly:
                          isEnabled: true
                          dayOfWeek: Saturday
                          dayNumberInMonth: Last
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      fullBackupMaintenance:
                        removeData:
                          isEnabled: false
                          afterDays: 14
                        defragmentAndCompact:
                          isEnabled: false
                          weekly:
                            isEnabled: false
                            days:
                              - Saturday
                          monthly:
                            isEnabled: true
                            dayOfWeek: Saturday
                            dayNumberInMonth: Last
                            dayOfMonths: 1
                            months:
                              - Jan
                              - Feb
                              - Mar
                              - Apr
                              - May
                              - Jun
                              - Jul
                              - Aug
                              - Sep
                              - Oct
                              - Nov
                              - Dec
                      storageData:
                        enableInlineDataDeduplication: true
                        excludeSwapFileBlocks: true
                        excludeDeletedFileBlocks: true
                        compressionLevel: Optimal
                        storageOptimization: LocalTarget
                        encryption:
                          isEnabled: false
                          encryptionType: ByUserPassword
                          encryptionPasswordId: 
                          encryptionPasswordTag: 
                          kmsServerId: 
                      notifications:
                        sendSNMPNotifications: false
                        emailNotifications:
                          isEnabled: false
                          recipients: [ ]
                          notificationType: UseGlobalNotificationSettings
                          customNotificationSettings: 
                        vmAttribute:
                          isEnabled: false
                          notes: Notes
                          appendToExistingValue: true
                      vSphere:
                        enableVMWareToolsQuiescence: false
                        changedBlockTracking:
                          isEnabled: true
                          enableCbtAutomatically: true
                          resetCbtOnActiveFull: true
                      storageIntegration:
                        isEnabled: true
                        limitProcessedVm: false
                        limitProcessedVmCount: 10
                        failoverToStandardBackup: false
                      scripts:
                        preCommand:
                          isEnabled: false
                          command: ''
                        postCommand:
                          isEnabled: false
                          command: ''
                        periodicityType: BackupSessions
                        runScriptEvery: 1
                        dayOfWeek:
                          - Saturday
                  guestProcessing:
                    appAwareProcessing:
                      isEnabled: false
                      appSettings: [ ]
                    guestFSIndexing:
                      isEnabled: false
                      indexingSettings: [ ]
                    guestInteractionProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    guestCredentials: 
                  schedule:
                    runAutomatically: false
                    daily:
                      isEnabled: true
                      localTime: '2025-09-09T10:00:00.0000000+02:00'
                      dailyKind: Everyday
                      days:
                        - Sunday
                        - Monday
                        - Tuesday
                        - Wednesday
                        - Thursday
                        - Friday
                        - Saturday
                    monthly:
                      isEnabled: false
                      localTime: '2025-09-09T10:00:00.0000000+02:00'
                      dayOfWeek: Saturday
                      dayNumberInMonth: Fourth
                      dayOfMonth: 
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                    periodically:
                      isEnabled: false
                      periodicallyKind: Hours
                      frequency: 1
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      startTimeWithinAnHour: 0
                    continuously:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                    afterThisJob:
                      isEnabled: false
                      jobName: 
                    retry:
                      isEnabled: false
                      retryCount: 3
                      awaitMinutes: 10
                    backupWindow:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/BackupServerBackupJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Backup Server Jobs
      summary: Modify VMware vSphere VM Backup Job Configuration
      description: Modifies a configuration of a VMware vSphere VM backup job with the specified UID.
      operationId: PatchBackupServerBackupVmVSphereJobConfiguration
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Customized Job Configuration
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerBackupJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 1bcb374f-b346-68b3-bd70-2b40cc7ff6ae
                  originalUid: 7fa501dc-f769-4d71-83b1-4f6859c43925
                  name: Backup Job 23
                  description: Customized Job Configuration
                  isDisabled: false
                  mappedOrganizationUid: 3337e028-55e1-453f-800c-3085a43033c6
                  mappedOrganizationName: hosted
                  backupServerUid: 91d5797e-c80b-48e5-bb97-b9df5707f14f
                  backupServerName: vbr1
                  isHighPriority: false
                  virtualMachines:
                    includes:
                      - inventoryObject:
                          hostName: vc1.tech.local
                          name: lis-l1-1
                          type: VirtualMachine
                          objectId: vm-91024
                        size: 49.4 GB
                      - inventoryObject:
                          hostName: vc1.tech.local
                          name: lis-l1-2
                          type: VirtualMachine
                          objectId: vm-91025
                        size: 49.4 GB
                    excludes:
                      vms: [ ]
                      disks:
                        - vmObject:
                            hostName: vc1.tech.local
                            name: lis-l1-1
                            type: VirtualMachine
                            objectId: vm-91024
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                        - vmObject:
                            hostName: vc1.tech.local
                            name: lis-l1-2
                            type: VirtualMachine
                            objectId: vm-91025
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                      templates:
                        isEnabled: true
                        excludeFromIncremental: true
                  storage:
                    backupRepositoryId: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    backupProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    retentionPolicy:
                      type: Days
                      quantity: 7
                    gfsPolicy:
                      isEnabled: false
                      weekly:
                        isEnabled: false
                        keepForNumberOfWeeks: 1
                        desiredTime: Monday
                      monthly:
                        isEnabled: false
                        keepForNumberOfMonths: 1
                        desiredTime: First
                      yearly:
                        isEnabled: false
                        keepForNumberOfYears: 1
                        desiredTime: Jan
                    advancedSettings:
                      backupModeType: Incremental
                      syntheticFulls:
                        isEnabled: true
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      activeFulls:
                        isEnabled: false
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      backupHealth:
                        isEnabled: false
                        weekly:
                          isEnabled: false
                          days:
                            - Saturday
                        monthly:
                          isEnabled: true
                          dayOfWeek: Saturday
                          dayNumberInMonth: Last
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      fullBackupMaintenance:
                        removeData:
                          isEnabled: false
                          afterDays: 14
                        defragmentAndCompact:
                          isEnabled: false
                          weekly:
                            isEnabled: false
                            days:
                              - Saturday
                          monthly:
                            isEnabled: true
                            dayOfWeek: Saturday
                            dayNumberInMonth: Last
                            dayOfMonths: 1
                            months:
                              - Jan
                              - Feb
                              - Mar
                              - Apr
                              - May
                              - Jun
                              - Jul
                              - Aug
                              - Sep
                              - Oct
                              - Nov
                              - Dec
                      storageData:
                        enableInlineDataDeduplication: true
                        excludeSwapFileBlocks: true
                        excludeDeletedFileBlocks: true
                        compressionLevel: Optimal
                        storageOptimization: LocalTarget
                        encryption:
                          isEnabled: false
                          encryptionType: ByUserPassword
                          encryptionPasswordId: 
                          encryptionPasswordTag: 
                          kmsServerId: 
                      notifications:
                        sendSNMPNotifications: false
                        emailNotifications:
                          isEnabled: false
                          recipients: [ ]
                          notificationType: UseGlobalNotificationSettings
                          customNotificationSettings: 
                        vmAttribute:
                          isEnabled: false
                          notes: Notes
                          appendToExistingValue: true
                      vSphere:
                        enableVMWareToolsQuiescence: false
                        changedBlockTracking:
                          isEnabled: true
                          enableCbtAutomatically: true
                          resetCbtOnActiveFull: true
                      storageIntegration:
                        isEnabled: true
                        limitProcessedVm: false
                        limitProcessedVmCount: 10
                        failoverToStandardBackup: false
                      scripts:
                        preCommand:
                          isEnabled: false
                          command: ''
                        postCommand:
                          isEnabled: false
                          command: ''
                        periodicityType: BackupSessions
                        runScriptEvery: 1
                        dayOfWeek:
                          - Saturday
                  guestProcessing:
                    appAwareProcessing:
                      isEnabled: false
                      appSettings: [ ]
                    guestFSIndexing:
                      isEnabled: false
                      indexingSettings: [ ]
                    guestInteractionProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    guestCredentials: 
                  schedule:
                    runAutomatically: false
                    daily:
                      isEnabled: true
                      localTime: '2025-09-09T10:00:00.0000000+02:00'
                      dailyKind: Everyday
                      days:
                        - Sunday
                        - Monday
                        - Tuesday
                        - Wednesday
                        - Thursday
                        - Friday
                        - Saturday
                    monthly:
                      isEnabled: false
                      localTime: '2025-09-09T10:00:00.0000000+02:00'
                      dayOfWeek: Saturday
                      dayNumberInMonth: Fourth
                      dayOfMonth: 
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                    periodically:
                      isEnabled: false
                      periodicallyKind: Hours
                      frequency: 1
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      startTimeWithinAnHour: 0
                    continuously:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                    afterThisJob:
                      isEnabled: false
                      jobName: 
                    retry:
                      isEnabled: false
                      retryCount: 3
                      awaitMinutes: 10
                    backupWindow:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BackupServerBackupJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs/vSphere':
    post:
      tags:
        - Backup Server Jobs
      summary: Create VMware vSphere VM Backup Job
      description: Creates a VMware VSphere VM backup job on a Veeam Backup & Replication server with the specified UID.
      operationId: CreateBackupServerBackupVmVSphereJob
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: mappedOrganizationUid
          in: query
          description: UID assigned to an organization that is mapped to a backup job on a hosted Veeam Backup & Replication server.
          schema:
            type: string
            format: uuid
            nullable: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Job configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupServerBackupJobConfiguration'
            example:
              instanceUid: 1bcb374f-b346-68b3-bd70-2b40cc7ff6ae
              originalUid: 7fa501dc-f769-4d71-83b1-4f6859c43925
              name: Backup Job 23
              description: Customized Job Configuration
              isDisabled: false
              mappedOrganizationUid: 3337e028-55e1-453f-800c-3085a43033c6
              mappedOrganizationName: hosted
              backupServerUid: 91d5797e-c80b-48e5-bb97-b9df5707f14f
              backupServerName: vbr1
              isHighPriority: false
              virtualMachines:
                includes:
                  - inventoryObject:
                      hostName: vc1.tech.local
                      name: lis-l1-1
                      type: VirtualMachine
                      objectId: vm-91024
                    size: 49.4 GB
                  - inventoryObject:
                      hostName: vc1.tech.local
                      name: lis-l1-2
                      type: VirtualMachine
                      objectId: vm-91025
                    size: 49.4 GB
                excludes:
                  vms: [ ]
                  disks:
                    - vmObject:
                        hostName: vc1.tech.local
                        name: lis-l1-1
                        type: VirtualMachine
                        objectId: vm-91024
                      disksToProcess: AllDisks
                      disks: [ ]
                      removeFromVMConfiguration: true
                    - vmObject:
                        hostName: vc1.tech.local
                        name: lis-l1-2
                        type: VirtualMachine
                        objectId: vm-91025
                      disksToProcess: AllDisks
                      disks: [ ]
                      removeFromVMConfiguration: true
                  templates:
                    isEnabled: true
                    excludeFromIncremental: true
              storage:
                backupRepositoryId: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                backupProxies:
                  autoSelection: true
                  proxyIds: [ ]
                retentionPolicy:
                  type: Days
                  quantity: 7
                gfsPolicy:
                  isEnabled: false
                  weekly:
                    isEnabled: false
                    keepForNumberOfWeeks: 1
                    desiredTime: Monday
                  monthly:
                    isEnabled: false
                    keepForNumberOfMonths: 1
                    desiredTime: First
                  yearly:
                    isEnabled: false
                    keepForNumberOfYears: 1
                    desiredTime: Jan
                advancedSettings:
                  backupModeType: Incremental
                  syntheticFulls:
                    isEnabled: true
                    weekly:
                      isEnabled: true
                      days:
                        - Saturday
                    monthly:
                      isEnabled: false
                      dayOfWeek: Monday
                      dayNumberInMonth: First
                      dayOfMonths: 1
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                  activeFulls:
                    isEnabled: false
                    weekly:
                      isEnabled: true
                      days:
                        - Saturday
                    monthly:
                      isEnabled: false
                      dayOfWeek: Monday
                      dayNumberInMonth: First
                      dayOfMonths: 1
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                  backupHealth:
                    isEnabled: false
                    weekly:
                      isEnabled: false
                      days:
                        - Saturday
                    monthly:
                      isEnabled: true
                      dayOfWeek: Saturday
                      dayNumberInMonth: Last
                      dayOfMonths: 1
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                  fullBackupMaintenance:
                    removeData:
                      isEnabled: false
                      afterDays: 14
                    defragmentAndCompact:
                      isEnabled: false
                      weekly:
                        isEnabled: false
                        days:
                          - Saturday
                      monthly:
                        isEnabled: true
                        dayOfWeek: Saturday
                        dayNumberInMonth: Last
                        dayOfMonths: 1
                        months:
                          - Jan
                          - Feb
                          - Mar
                          - Apr
                          - May
                          - Jun
                          - Jul
                          - Aug
                          - Sep
                          - Oct
                          - Nov
                          - Dec
                  storageData:
                    enableInlineDataDeduplication: true
                    excludeSwapFileBlocks: true
                    excludeDeletedFileBlocks: true
                    compressionLevel: Optimal
                    storageOptimization: LocalTarget
                    encryption:
                      isEnabled: false
                      encryptionType: ByUserPassword
                      encryptionPasswordId: 
                      encryptionPasswordTag: 
                      kmsServerId: 
                  notifications:
                    sendSNMPNotifications: false
                    emailNotifications:
                      isEnabled: false
                      recipients: [ ]
                      notificationType: UseGlobalNotificationSettings
                      customNotificationSettings: 
                    vmAttribute:
                      isEnabled: false
                      notes: Notes
                      appendToExistingValue: true
                  vSphere:
                    enableVMWareToolsQuiescence: false
                    changedBlockTracking:
                      isEnabled: true
                      enableCbtAutomatically: true
                      resetCbtOnActiveFull: true
                  storageIntegration:
                    isEnabled: true
                    limitProcessedVm: false
                    limitProcessedVmCount: 10
                    failoverToStandardBackup: false
                  scripts:
                    preCommand:
                      isEnabled: false
                      command: ''
                    postCommand:
                      isEnabled: false
                      command: ''
                    periodicityType: BackupSessions
                    runScriptEvery: 1
                    dayOfWeek:
                      - Saturday
              guestProcessing:
                appAwareProcessing:
                  isEnabled: false
                  appSettings: [ ]
                guestFSIndexing:
                  isEnabled: false
                  indexingSettings: [ ]
                guestInteractionProxies:
                  autoSelection: true
                  proxyIds: [ ]
                guestCredentials: 
              schedule:
                runAutomatically: false
                daily:
                  isEnabled: true
                  localTime: '2025-09-09T10:00:00.0000000+02:00'
                  dailyKind: Everyday
                  days:
                    - Sunday
                    - Monday
                    - Tuesday
                    - Wednesday
                    - Thursday
                    - Friday
                    - Saturday
                monthly:
                  isEnabled: false
                  localTime: '2025-09-09T10:00:00.0000000+02:00'
                  dayOfWeek: Saturday
                  dayNumberInMonth: Fourth
                  dayOfMonth: 
                  months:
                    - Jan
                    - Feb
                    - Mar
                    - Apr
                    - May
                    - Jun
                    - Jul
                    - Aug
                    - Sep
                    - Oct
                    - Nov
                    - Dec
                periodically:
                  isEnabled: false
                  periodicallyKind: Hours
                  frequency: 1
                  backupWindow:
                    days:
                      - day: Sunday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Monday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Tuesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Wednesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Thursday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Friday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Saturday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                  startTimeWithinAnHour: 0
                continuously:
                  isEnabled: false
                  backupWindow:
                    days:
                      - day: Sunday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Monday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Tuesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Wednesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Thursday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Friday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Saturday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                afterThisJob:
                  isEnabled: false
                  jobName: 
                retry:
                  isEnabled: false
                  retryCount: 3
                  awaitMinutes: 10
                backupWindow:
                  isEnabled: false
                  backupWindow:
                    days:
                      - day: Sunday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Monday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Tuesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Wednesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Thursday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Friday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Saturday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerBackupJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 1bcb374f-b346-68b3-bd70-2b40cc7ff6ae
                  originalUid: 7fa501dc-f769-4d71-83b1-4f6859c43925
                  name: Backup Job 23
                  description: Customized Job Configuration
                  isDisabled: false
                  mappedOrganizationUid: 3337e028-55e1-453f-800c-3085a43033c6
                  mappedOrganizationName: hosted
                  backupServerUid: 91d5797e-c80b-48e5-bb97-b9df5707f14f
                  backupServerName: vbr1
                  isHighPriority: false
                  virtualMachines:
                    includes:
                      - inventoryObject:
                          hostName: vc1.tech.local
                          name: lis-l1-1
                          type: VirtualMachine
                          objectId: vm-91024
                        size: 49.4 GB
                      - inventoryObject:
                          hostName: vc1.tech.local
                          name: lis-l1-2
                          type: VirtualMachine
                          objectId: vm-91025
                        size: 49.4 GB
                    excludes:
                      vms: [ ]
                      disks:
                        - vmObject:
                            hostName: vc1.tech.local
                            name: lis-l1-1
                            type: VirtualMachine
                            objectId: vm-91024
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                        - vmObject:
                            hostName: vc1.tech.local
                            name: lis-l1-2
                            type: VirtualMachine
                            objectId: vm-91025
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                      templates:
                        isEnabled: true
                        excludeFromIncremental: true
                  storage:
                    backupRepositoryId: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    backupProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    retentionPolicy:
                      type: Days
                      quantity: 7
                    gfsPolicy:
                      isEnabled: false
                      weekly:
                        isEnabled: false
                        keepForNumberOfWeeks: 1
                        desiredTime: Monday
                      monthly:
                        isEnabled: false
                        keepForNumberOfMonths: 1
                        desiredTime: First
                      yearly:
                        isEnabled: false
                        keepForNumberOfYears: 1
                        desiredTime: Jan
                    advancedSettings:
                      backupModeType: Incremental
                      syntheticFulls:
                        isEnabled: true
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      activeFulls:
                        isEnabled: false
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      backupHealth:
                        isEnabled: false
                        weekly:
                          isEnabled: false
                          days:
                            - Saturday
                        monthly:
                          isEnabled: true
                          dayOfWeek: Saturday
                          dayNumberInMonth: Last
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      fullBackupMaintenance:
                        removeData:
                          isEnabled: false
                          afterDays: 14
                        defragmentAndCompact:
                          isEnabled: false
                          weekly:
                            isEnabled: false
                            days:
                              - Saturday
                          monthly:
                            isEnabled: true
                            dayOfWeek: Saturday
                            dayNumberInMonth: Last
                            dayOfMonths: 1
                            months:
                              - Jan
                              - Feb
                              - Mar
                              - Apr
                              - May
                              - Jun
                              - Jul
                              - Aug
                              - Sep
                              - Oct
                              - Nov
                              - Dec
                      storageData:
                        enableInlineDataDeduplication: true
                        excludeSwapFileBlocks: true
                        excludeDeletedFileBlocks: true
                        compressionLevel: Optimal
                        storageOptimization: LocalTarget
                        encryption:
                          isEnabled: false
                          encryptionType: ByUserPassword
                          encryptionPasswordId: 
                          encryptionPasswordTag: 
                          kmsServerId: 
                      notifications:
                        sendSNMPNotifications: false
                        emailNotifications:
                          isEnabled: false
                          recipients: [ ]
                          notificationType: UseGlobalNotificationSettings
                          customNotificationSettings: 
                        vmAttribute:
                          isEnabled: false
                          notes: Notes
                          appendToExistingValue: true
                      vSphere:
                        enableVMWareToolsQuiescence: false
                        changedBlockTracking:
                          isEnabled: true
                          enableCbtAutomatically: true
                          resetCbtOnActiveFull: true
                      storageIntegration:
                        isEnabled: true
                        limitProcessedVm: false
                        limitProcessedVmCount: 10
                        failoverToStandardBackup: false
                      scripts:
                        preCommand:
                          isEnabled: false
                          command: ''
                        postCommand:
                          isEnabled: false
                          command: ''
                        periodicityType: BackupSessions
                        runScriptEvery: 1
                        dayOfWeek:
                          - Saturday
                  guestProcessing:
                    appAwareProcessing:
                      isEnabled: false
                      appSettings: [ ]
                    guestFSIndexing:
                      isEnabled: false
                      indexingSettings: [ ]
                    guestInteractionProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    guestCredentials: 
                  schedule:
                    runAutomatically: false
                    daily:
                      isEnabled: true
                      localTime: '2025-09-09T10:00:00.0000000+02:00'
                      dailyKind: Everyday
                      days:
                        - Sunday
                        - Monday
                        - Tuesday
                        - Wednesday
                        - Thursday
                        - Friday
                        - Saturday
                    monthly:
                      isEnabled: false
                      localTime: '2025-09-09T10:00:00.0000000+02:00'
                      dayOfWeek: Saturday
                      dayNumberInMonth: Fourth
                      dayOfMonth: 
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                    periodically:
                      isEnabled: false
                      periodicallyKind: Hours
                      frequency: 1
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      startTimeWithinAnHour: 0
                    continuously:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                    afterThisJob:
                      isEnabled: false
                      jobName: 
                    retry:
                      isEnabled: false
                      retryCount: 3
                      awaitMinutes: 10
                    backupWindow:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/jobs/backupVmJobs/vcd/{jobUid}/configuration':
    get:
      tags:
        - Backup Server Jobs
      summary: Get VMware Cloud Director VM Backup Job Configuration
      description: Returns a resource representation of a configuration of a VMware Cloud Director VM backup job with the specified UID.
      operationId: GetBackupServerBackupVmVcdJobConfiguration
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 87ed6896-e968-6379-a9d0-955bce51f2b4
                  originalUid: b7c67df3-4315-46e7-81a0-02e3b642cfb8
                  name: Cloud Director Job 1
                  description: Customized Job Configuration
                  isDisabled: false
                  mappedOrganizationUid: b9e5b413-28f2-43c4-a1c7-937f25a4f0b4
                  mappedOrganizationName: hosted
                  backupServerUid: 91d5797e-d90b-48e5-bb97-b9df5707f14f
                  backupServerName: vbr1
                  isHighPriority: false
                  virtualMachines:
                    includes:
                      - hostName: vcd105.tech.local
                        name: ms-vapp-1
                        type: vApp
                        objectId: urn:vcloud:vapp:1fa005d1-ec9b-487a-9313-33feda70ddd9
                        size: 0 B
                        vcdOrganizationName: 
                        vcdOrganizationUid: 
                      - hostName: vcd105.tech.local
                        name: ms-vm-1
                        type: VirtualMachine
                        objectId: urn:vcloud:vm:c40534a1-c3cb-4d96-b3a5-bb0f79898c21
                        size: 0 B
                        vcdOrganizationName: 
                        vcdOrganizationUid: 
                    excludes:
                      vms: [ ]
                      disks:
                        - vmObject:
                            hostName: vcd105.tech.local
                            name: ms-vapp-1
                            type: vApp
                            objectId: urn:vcloud:vapp:1fa005d1-ec9b-487a-9313-33feda70ddd9
                            size: 
                            vcdOrganizationName: 
                            vcdOrganizationUid: 
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                        - vmObject:
                            hostName: vcd105.tech.local
                            name: ms-vm-1
                            type: VirtualMachine
                            objectId: urn:vcloud:vm:c40534a1-c3cb-4d96-b3a5-bb0f79898c21
                            size: 
                            vcdOrganizationName: 
                            vcdOrganizationUid: 
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                      templates:
                        isEnabled: true
                        excludeFromIncremental: true
                  storage:
                    backupRepositoryId: 88799f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    backupProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    retentionPolicy:
                      type: Days
                      quantity: 11
                    gfsPolicy:
                      isEnabled: false
                      weekly:
                        isEnabled: false
                        keepForNumberOfWeeks: 1
                        desiredTime: Monday
                      monthly:
                        isEnabled: false
                        keepForNumberOfMonths: 1
                        desiredTime: First
                      yearly:
                        isEnabled: false
                        keepForNumberOfYears: 1
                        desiredTime: Jan
                    advancedSettings:
                      backupModeType: Incremental
                      syntheticFulls:
                        isEnabled: true
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      activeFulls:
                        isEnabled: false
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      backupHealth:
                        isEnabled: false
                        weekly:
                          isEnabled: false
                          days:
                            - Saturday
                        monthly:
                          isEnabled: true
                          dayOfWeek: Saturday
                          dayNumberInMonth: Last
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      fullBackupMaintenance:
                        removeData:
                          isEnabled: false
                          afterDays: 14
                        defragmentAndCompact:
                          isEnabled: false
                          weekly:
                            isEnabled: false
                            days:
                              - Saturday
                          monthly:
                            isEnabled: true
                            dayOfWeek: Saturday
                            dayNumberInMonth: Last
                            dayOfMonths: 1
                            months:
                              - Jan
                              - Feb
                              - Mar
                              - Apr
                              - May
                              - Jun
                              - Jul
                              - Aug
                              - Sep
                              - Oct
                              - Nov
                              - Dec
                      storageData:
                        enableInlineDataDeduplication: true
                        excludeSwapFileBlocks: true
                        excludeDeletedFileBlocks: true
                        compressionLevel: Optimal
                        storageOptimization: LocalTarget
                        encryption:
                          isEnabled: false
                          encryptionType: ByUserPassword
                          encryptionPasswordId: 
                          encryptionPasswordTag: 
                          kmsServerId: 
                      notifications:
                        sendSNMPNotifications: false
                        emailNotifications:
                          isEnabled: false
                          recipients: [ ]
                          notificationType: UseGlobalNotificationSettings
                          customNotificationSettings: 
                        vmAttribute:
                          isEnabled: false
                          notes: Notes
                          appendToExistingValue: true
                      vSphere:
                        enableVMWareToolsQuiescence: false
                        changedBlockTracking:
                          isEnabled: true
                          enableCbtAutomatically: true
                          resetCbtOnActiveFull: true
                      storageIntegration:
                        isEnabled: true
                        limitProcessedVm: false
                        limitProcessedVmCount: 10
                        failoverToStandardBackup: false
                      scripts:
                        preCommand:
                          isEnabled: false
                          command: ''
                        postCommand:
                          isEnabled: false
                          command: ''
                        periodicityType: BackupSessions
                        runScriptEvery: 1
                        dayOfWeek:
                          - Saturday
                  guestProcessing:
                    appAwareProcessing:
                      isEnabled: false
                      appSettings: [ ]
                    guestFSIndexing:
                      isEnabled: false
                      indexingSettings: [ ]
                    guestInteractionProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    guestCredentials: 
                  schedule:
                    runAutomatically: true
                    daily:
                      isEnabled: true
                      localTime: '2025-09-09T11:15:00.0000000+02:00'
                      dailyKind: Everyday
                      days:
                        - Sunday
                        - Monday
                        - Tuesday
                        - Wednesday
                        - Thursday
                        - Friday
                        - Saturday
                    monthly:
                      isEnabled: false
                      localTime: '2025-09-09T10:00:00.0000000+02:00'
                      dayOfWeek: Saturday
                      dayNumberInMonth: Fourth
                      dayOfMonth: 
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                    periodically:
                      isEnabled: false
                      periodicallyKind: Hours
                      frequency: 1
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      startTimeWithinAnHour: 0
                    continuously:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                    afterThisJob:
                      isEnabled: false
                      jobName: 
                    retry:
                      isEnabled: false
                      retryCount: 3
                      awaitMinutes: 10
                    backupWindow:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Backup Server Jobs
      summary: Modify VMware Cloud Director VM Backup Job Configuration
      description: Modifies a configuration of a VMware Cloud Director VM backup job with the specified UID.
      operationId: PatchBackupServerBackupVmVcdJobConfiguration
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Customized Job Configuration
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 87ed6896-e968-6379-a9d0-955bce51f2b4
                  originalUid: b7c67df3-4315-46e7-81a0-02e3b642cfb8
                  name: Cloud Director Job 1
                  description: Customized Job Configuration
                  isDisabled: false
                  mappedOrganizationUid: b9e5b413-28f2-43c4-a1c7-937f25a4f0b4
                  mappedOrganizationName: hosted
                  backupServerUid: 91d5797e-d90b-48e5-bb97-b9df5707f14f
                  backupServerName: vbr1
                  isHighPriority: false
                  virtualMachines:
                    includes:
                      - hostName: vcd105.tech.local
                        name: ms-vapp-1
                        type: vApp
                        objectId: urn:vcloud:vapp:1fa005d1-ec9b-487a-9313-33feda70ddd9
                        size: 0 B
                        vcdOrganizationName: 
                        vcdOrganizationUid: 
                      - hostName: vcd105.tech.local
                        name: ms-vm-1
                        type: VirtualMachine
                        objectId: urn:vcloud:vm:c40534a1-c3cb-4d96-b3a5-bb0f79898c21
                        size: 0 B
                        vcdOrganizationName: 
                        vcdOrganizationUid: 
                    excludes:
                      vms: [ ]
                      disks:
                        - vmObject:
                            hostName: vcd105.tech.local
                            name: ms-vapp-1
                            type: vApp
                            objectId: urn:vcloud:vapp:1fa005d1-ec9b-487a-9313-33feda70ddd9
                            size: 
                            vcdOrganizationName: 
                            vcdOrganizationUid: 
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                        - vmObject:
                            hostName: vcd105.tech.local
                            name: ms-vm-1
                            type: VirtualMachine
                            objectId: urn:vcloud:vm:c40534a1-c3cb-4d96-b3a5-bb0f79898c21
                            size: 
                            vcdOrganizationName: 
                            vcdOrganizationUid: 
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                      templates:
                        isEnabled: true
                        excludeFromIncremental: true
                  storage:
                    backupRepositoryId: 88799f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    backupProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    retentionPolicy:
                      type: Days
                      quantity: 11
                    gfsPolicy:
                      isEnabled: false
                      weekly:
                        isEnabled: false
                        keepForNumberOfWeeks: 1
                        desiredTime: Monday
                      monthly:
                        isEnabled: false
                        keepForNumberOfMonths: 1
                        desiredTime: First
                      yearly:
                        isEnabled: false
                        keepForNumberOfYears: 1
                        desiredTime: Jan
                    advancedSettings:
                      backupModeType: Incremental
                      syntheticFulls:
                        isEnabled: true
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      activeFulls:
                        isEnabled: false
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      backupHealth:
                        isEnabled: false
                        weekly:
                          isEnabled: false
                          days:
                            - Saturday
                        monthly:
                          isEnabled: true
                          dayOfWeek: Saturday
                          dayNumberInMonth: Last
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      fullBackupMaintenance:
                        removeData:
                          isEnabled: false
                          afterDays: 14
                        defragmentAndCompact:
                          isEnabled: false
                          weekly:
                            isEnabled: false
                            days:
                              - Saturday
                          monthly:
                            isEnabled: true
                            dayOfWeek: Saturday
                            dayNumberInMonth: Last
                            dayOfMonths: 1
                            months:
                              - Jan
                              - Feb
                              - Mar
                              - Apr
                              - May
                              - Jun
                              - Jul
                              - Aug
                              - Sep
                              - Oct
                              - Nov
                              - Dec
                      storageData:
                        enableInlineDataDeduplication: true
                        excludeSwapFileBlocks: true
                        excludeDeletedFileBlocks: true
                        compressionLevel: Optimal
                        storageOptimization: LocalTarget
                        encryption:
                          isEnabled: false
                          encryptionType: ByUserPassword
                          encryptionPasswordId: 
                          encryptionPasswordTag: 
                          kmsServerId: 
                      notifications:
                        sendSNMPNotifications: false
                        emailNotifications:
                          isEnabled: false
                          recipients: [ ]
                          notificationType: UseGlobalNotificationSettings
                          customNotificationSettings: 
                        vmAttribute:
                          isEnabled: false
                          notes: Notes
                          appendToExistingValue: true
                      vSphere:
                        enableVMWareToolsQuiescence: false
                        changedBlockTracking:
                          isEnabled: true
                          enableCbtAutomatically: true
                          resetCbtOnActiveFull: true
                      storageIntegration:
                        isEnabled: true
                        limitProcessedVm: false
                        limitProcessedVmCount: 10
                        failoverToStandardBackup: false
                      scripts:
                        preCommand:
                          isEnabled: false
                          command: ''
                        postCommand:
                          isEnabled: false
                          command: ''
                        periodicityType: BackupSessions
                        runScriptEvery: 1
                        dayOfWeek:
                          - Saturday
                  guestProcessing:
                    appAwareProcessing:
                      isEnabled: false
                      appSettings: [ ]
                    guestFSIndexing:
                      isEnabled: false
                      indexingSettings: [ ]
                    guestInteractionProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    guestCredentials: 
                  schedule:
                    runAutomatically: true
                    daily:
                      isEnabled: true
                      localTime: '2025-09-09T11:15:00.0000000+02:00'
                      dailyKind: Everyday
                      days:
                        - Sunday
                        - Monday
                        - Tuesday
                        - Wednesday
                        - Thursday
                        - Friday
                        - Saturday
                    monthly:
                      isEnabled: false
                      localTime: '2025-09-09T10:00:00.0000000+02:00'
                      dayOfWeek: Saturday
                      dayNumberInMonth: Fourth
                      dayOfMonth: 
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                    periodically:
                      isEnabled: false
                      periodicallyKind: Hours
                      frequency: 1
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      startTimeWithinAnHour: 0
                    continuously:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                    afterThisJob:
                      isEnabled: false
                      jobName: 
                    retry:
                      isEnabled: false
                      retryCount: 3
                      awaitMinutes: 10
                    backupWindow:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs/vcd':
    post:
      tags:
        - Backup Server Jobs
      summary: Create VMware Cloud Director VM Backup Job
      description: Creates a VMware Cloud Director VM backup job on a Veeam Backup & Replication server with the specified UID.
      operationId: CreateBackupServerBackupVmVcdJob
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: mappedOrganizationUid
          in: query
          description: UID assigned to an organization that is mapped to a backup job on a hosted Veeam Backup & Replication server.
          schema:
            type: string
            format: uuid
            nullable: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Job configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobConfiguration'
            example:
              instanceUid: 87ed6896-e968-6379-a9d0-955bce51f2b4
              originalUid: b7c67df3-4315-46e7-81a0-02e3b642cfb8
              name: Cloud Director Job 1
              description: Customized Job Configuration
              isDisabled: false
              mappedOrganizationUid: b9e5b413-28f2-43c4-a1c7-937f25a4f0b4
              mappedOrganizationName: hosted
              backupServerUid: 91d5797e-d90b-48e5-bb97-b9df5707f14f
              backupServerName: vbr1
              isHighPriority: false
              virtualMachines:
                includes:
                  - hostName: vcd105.tech.local
                    name: ms-vapp-1
                    type: vApp
                    objectId: urn:vcloud:vapp:1fa005d1-ec9b-487a-9313-33feda70ddd9
                    size: 0 B
                    vcdOrganizationName: 
                    vcdOrganizationUid: 
                  - hostName: vcd105.tech.local
                    name: ms-vm-1
                    type: VirtualMachine
                    objectId: urn:vcloud:vm:c40534a1-c3cb-4d96-b3a5-bb0f79898c21
                    size: 0 B
                    vcdOrganizationName: 
                    vcdOrganizationUid: 
                excludes:
                  vms: [ ]
                  disks:
                    - vmObject:
                        hostName: vcd105.tech.local
                        name: ms-vapp-1
                        type: vApp
                        objectId: urn:vcloud:vapp:1fa005d1-ec9b-487a-9313-33feda70ddd9
                        size: 
                        vcdOrganizationName: 
                        vcdOrganizationUid: 
                      disksToProcess: AllDisks
                      disks: [ ]
                      removeFromVMConfiguration: true
                    - vmObject:
                        hostName: vcd105.tech.local
                        name: ms-vm-1
                        type: VirtualMachine
                        objectId: urn:vcloud:vm:c40534a1-c3cb-4d96-b3a5-bb0f79898c21
                        size: 
                        vcdOrganizationName: 
                        vcdOrganizationUid: 
                      disksToProcess: AllDisks
                      disks: [ ]
                      removeFromVMConfiguration: true
                  templates:
                    isEnabled: true
                    excludeFromIncremental: true
              storage:
                backupRepositoryId: 88799f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                backupProxies:
                  autoSelection: true
                  proxyIds: [ ]
                retentionPolicy:
                  type: Days
                  quantity: 11
                gfsPolicy:
                  isEnabled: false
                  weekly:
                    isEnabled: false
                    keepForNumberOfWeeks: 1
                    desiredTime: Monday
                  monthly:
                    isEnabled: false
                    keepForNumberOfMonths: 1
                    desiredTime: First
                  yearly:
                    isEnabled: false
                    keepForNumberOfYears: 1
                    desiredTime: Jan
                advancedSettings:
                  backupModeType: Incremental
                  syntheticFulls:
                    isEnabled: true
                    weekly:
                      isEnabled: true
                      days:
                        - Saturday
                    monthly:
                      isEnabled: false
                      dayOfWeek: Monday
                      dayNumberInMonth: First
                      dayOfMonths: 1
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                  activeFulls:
                    isEnabled: false
                    weekly:
                      isEnabled: true
                      days:
                        - Saturday
                    monthly:
                      isEnabled: false
                      dayOfWeek: Monday
                      dayNumberInMonth: First
                      dayOfMonths: 1
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                  backupHealth:
                    isEnabled: false
                    weekly:
                      isEnabled: false
                      days:
                        - Saturday
                    monthly:
                      isEnabled: true
                      dayOfWeek: Saturday
                      dayNumberInMonth: Last
                      dayOfMonths: 1
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                  fullBackupMaintenance:
                    removeData:
                      isEnabled: false
                      afterDays: 14
                    defragmentAndCompact:
                      isEnabled: false
                      weekly:
                        isEnabled: false
                        days:
                          - Saturday
                      monthly:
                        isEnabled: true
                        dayOfWeek: Saturday
                        dayNumberInMonth: Last
                        dayOfMonths: 1
                        months:
                          - Jan
                          - Feb
                          - Mar
                          - Apr
                          - May
                          - Jun
                          - Jul
                          - Aug
                          - Sep
                          - Oct
                          - Nov
                          - Dec
                  storageData:
                    enableInlineDataDeduplication: true
                    excludeSwapFileBlocks: true
                    excludeDeletedFileBlocks: true
                    compressionLevel: Optimal
                    storageOptimization: LocalTarget
                    encryption:
                      isEnabled: false
                      encryptionType: ByUserPassword
                      encryptionPasswordId: 
                      encryptionPasswordTag: 
                      kmsServerId: 
                  notifications:
                    sendSNMPNotifications: false
                    emailNotifications:
                      isEnabled: false
                      recipients: [ ]
                      notificationType: UseGlobalNotificationSettings
                      customNotificationSettings: 
                    vmAttribute:
                      isEnabled: false
                      notes: Notes
                      appendToExistingValue: true
                  vSphere:
                    enableVMWareToolsQuiescence: false
                    changedBlockTracking:
                      isEnabled: true
                      enableCbtAutomatically: true
                      resetCbtOnActiveFull: true
                  storageIntegration:
                    isEnabled: true
                    limitProcessedVm: false
                    limitProcessedVmCount: 10
                    failoverToStandardBackup: false
                  scripts:
                    preCommand:
                      isEnabled: false
                      command: ''
                    postCommand:
                      isEnabled: false
                      command: ''
                    periodicityType: BackupSessions
                    runScriptEvery: 1
                    dayOfWeek:
                      - Saturday
              guestProcessing:
                appAwareProcessing:
                  isEnabled: false
                  appSettings: [ ]
                guestFSIndexing:
                  isEnabled: false
                  indexingSettings: [ ]
                guestInteractionProxies:
                  autoSelection: true
                  proxyIds: [ ]
                guestCredentials: 
              schedule:
                runAutomatically: true
                daily:
                  isEnabled: true
                  localTime: '2025-09-09T11:15:00.0000000+02:00'
                  dailyKind: Everyday
                  days:
                    - Sunday
                    - Monday
                    - Tuesday
                    - Wednesday
                    - Thursday
                    - Friday
                    - Saturday
                monthly:
                  isEnabled: false
                  localTime: '2025-09-09T10:00:00.0000000+02:00'
                  dayOfWeek: Saturday
                  dayNumberInMonth: Fourth
                  dayOfMonth: 
                  months:
                    - Jan
                    - Feb
                    - Mar
                    - Apr
                    - May
                    - Jun
                    - Jul
                    - Aug
                    - Sep
                    - Oct
                    - Nov
                    - Dec
                periodically:
                  isEnabled: false
                  periodicallyKind: Hours
                  frequency: 1
                  backupWindow:
                    days:
                      - day: Sunday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Monday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Tuesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Wednesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Thursday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Friday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Saturday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                  startTimeWithinAnHour: 0
                continuously:
                  isEnabled: false
                  backupWindow:
                    days:
                      - day: Sunday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Monday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Tuesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Wednesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Thursday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Friday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Saturday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                afterThisJob:
                  isEnabled: false
                  jobName: 
                retry:
                  isEnabled: false
                  retryCount: 3
                  awaitMinutes: 10
                backupWindow:
                  isEnabled: false
                  backupWindow:
                    days:
                      - day: Sunday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Monday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Tuesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Wednesday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Thursday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Friday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      - day: Saturday
                        hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 87ed6896-e968-6379-a9d0-955bce51f2b4
                  originalUid: b7c67df3-4315-46e7-81a0-02e3b642cfb8
                  name: Cloud Director Job 1
                  description: Customized Job Configuration
                  isDisabled: false
                  mappedOrganizationUid: b9e5b413-28f2-43c4-a1c7-937f25a4f0b4
                  mappedOrganizationName: hosted
                  backupServerUid: 91d5797e-d90b-48e5-bb97-b9df5707f14f
                  backupServerName: vbr1
                  isHighPriority: false
                  virtualMachines:
                    includes:
                      - hostName: vcd105.tech.local
                        name: ms-vapp-1
                        type: vApp
                        objectId: urn:vcloud:vapp:1fa005d1-ec9b-487a-9313-33feda70ddd9
                        size: 0 B
                        vcdOrganizationName: 
                        vcdOrganizationUid: 
                      - hostName: vcd105.tech.local
                        name: ms-vm-1
                        type: VirtualMachine
                        objectId: urn:vcloud:vm:c40534a1-c3cb-4d96-b3a5-bb0f79898c21
                        size: 0 B
                        vcdOrganizationName: 
                        vcdOrganizationUid: 
                    excludes:
                      vms: [ ]
                      disks:
                        - vmObject:
                            hostName: vcd105.tech.local
                            name: ms-vapp-1
                            type: vApp
                            objectId: urn:vcloud:vapp:1fa005d1-ec9b-487a-9313-33feda70ddd9
                            size: 
                            vcdOrganizationName: 
                            vcdOrganizationUid: 
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                        - vmObject:
                            hostName: vcd105.tech.local
                            name: ms-vm-1
                            type: VirtualMachine
                            objectId: urn:vcloud:vm:c40534a1-c3cb-4d96-b3a5-bb0f79898c21
                            size: 
                            vcdOrganizationName: 
                            vcdOrganizationUid: 
                          disksToProcess: AllDisks
                          disks: [ ]
                          removeFromVMConfiguration: true
                      templates:
                        isEnabled: true
                        excludeFromIncremental: true
                  storage:
                    backupRepositoryId: 88799f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    backupProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    retentionPolicy:
                      type: Days
                      quantity: 11
                    gfsPolicy:
                      isEnabled: false
                      weekly:
                        isEnabled: false
                        keepForNumberOfWeeks: 1
                        desiredTime: Monday
                      monthly:
                        isEnabled: false
                        keepForNumberOfMonths: 1
                        desiredTime: First
                      yearly:
                        isEnabled: false
                        keepForNumberOfYears: 1
                        desiredTime: Jan
                    advancedSettings:
                      backupModeType: Incremental
                      syntheticFulls:
                        isEnabled: true
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      activeFulls:
                        isEnabled: false
                        weekly:
                          isEnabled: true
                          days:
                            - Saturday
                        monthly:
                          isEnabled: false
                          dayOfWeek: Monday
                          dayNumberInMonth: First
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      backupHealth:
                        isEnabled: false
                        weekly:
                          isEnabled: false
                          days:
                            - Saturday
                        monthly:
                          isEnabled: true
                          dayOfWeek: Saturday
                          dayNumberInMonth: Last
                          dayOfMonths: 1
                          months:
                            - Jan
                            - Feb
                            - Mar
                            - Apr
                            - May
                            - Jun
                            - Jul
                            - Aug
                            - Sep
                            - Oct
                            - Nov
                            - Dec
                      fullBackupMaintenance:
                        removeData:
                          isEnabled: false
                          afterDays: 14
                        defragmentAndCompact:
                          isEnabled: false
                          weekly:
                            isEnabled: false
                            days:
                              - Saturday
                          monthly:
                            isEnabled: true
                            dayOfWeek: Saturday
                            dayNumberInMonth: Last
                            dayOfMonths: 1
                            months:
                              - Jan
                              - Feb
                              - Mar
                              - Apr
                              - May
                              - Jun
                              - Jul
                              - Aug
                              - Sep
                              - Oct
                              - Nov
                              - Dec
                      storageData:
                        enableInlineDataDeduplication: true
                        excludeSwapFileBlocks: true
                        excludeDeletedFileBlocks: true
                        compressionLevel: Optimal
                        storageOptimization: LocalTarget
                        encryption:
                          isEnabled: false
                          encryptionType: ByUserPassword
                          encryptionPasswordId: 
                          encryptionPasswordTag: 
                          kmsServerId: 
                      notifications:
                        sendSNMPNotifications: false
                        emailNotifications:
                          isEnabled: false
                          recipients: [ ]
                          notificationType: UseGlobalNotificationSettings
                          customNotificationSettings: 
                        vmAttribute:
                          isEnabled: false
                          notes: Notes
                          appendToExistingValue: true
                      vSphere:
                        enableVMWareToolsQuiescence: false
                        changedBlockTracking:
                          isEnabled: true
                          enableCbtAutomatically: true
                          resetCbtOnActiveFull: true
                      storageIntegration:
                        isEnabled: true
                        limitProcessedVm: false
                        limitProcessedVmCount: 10
                        failoverToStandardBackup: false
                      scripts:
                        preCommand:
                          isEnabled: false
                          command: ''
                        postCommand:
                          isEnabled: false
                          command: ''
                        periodicityType: BackupSessions
                        runScriptEvery: 1
                        dayOfWeek:
                          - Saturday
                  guestProcessing:
                    appAwareProcessing:
                      isEnabled: false
                      appSettings: [ ]
                    guestFSIndexing:
                      isEnabled: false
                      indexingSettings: [ ]
                    guestInteractionProxies:
                      autoSelection: true
                      proxyIds: [ ]
                    guestCredentials: 
                  schedule:
                    runAutomatically: true
                    daily:
                      isEnabled: true
                      localTime: '2025-09-09T11:15:00.0000000+02:00'
                      dailyKind: Everyday
                      days:
                        - Sunday
                        - Monday
                        - Tuesday
                        - Wednesday
                        - Thursday
                        - Friday
                        - Saturday
                    monthly:
                      isEnabled: false
                      localTime: '2025-09-09T10:00:00.0000000+02:00'
                      dayOfWeek: Saturday
                      dayNumberInMonth: Fourth
                      dayOfMonth: 
                      months:
                        - Jan
                        - Feb
                        - Mar
                        - Apr
                        - May
                        - Jun
                        - Jul
                        - Aug
                        - Sep
                        - Oct
                        - Nov
                        - Dec
                    periodically:
                      isEnabled: false
                      periodicallyKind: Hours
                      frequency: 1
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                      startTimeWithinAnHour: 0
                    continuously:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                    afterThisJob:
                      isEnabled: false
                      jobName: 
                    retry:
                      isEnabled: false
                      retryCount: 3
                      awaitMinutes: 10
                    backupWindow:
                      isEnabled: false
                      backupWindow:
                        days:
                          - day: Sunday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Monday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Tuesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Wednesday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Thursday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Friday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
                          - day: Saturday
                            hours: '1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1,1'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All VM Backup Jobs Configured on Backup Server
      description: Returns a collection resource representation of all VM backup jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerBackupVmJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerBackupVmJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerBackupVmJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: d9971f61-d018-62eb-b3ec-5988e957f8e8
                    subtype: VSphere
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    protectedVmCount: 1
                    _embedded:
                      backupServerJob:
                        instanceUid: d9971f61-d018-62eb-b3ec-5988e957f8e8
                        originalUid: 890b3563-e468-4c5c-b80e-9f052a63b25d
                        name: Backup Job 1
                        description: Backup Job 1
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:32:14.6000000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: Success
                        type: BackupVm
                        lastRun: '2024-07-18T03:32:14.8500000+02:00'
                        lastEndTime: '2024-07-18T03:33:16.0670000+02:00'
                        lastDuration: 61
                        processingRate: 0
                        avgDuration: 61
                        transferredData: 0
                        backupChainSize: 1630208
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: e8516020-ab89-4c8a-8e29-6c1f399ca68a
                            objectUid: d2b0cbac-8315-4fed-be9f-40790f3b1e12
                            objectName: vm2
                            totalObjects: 4
                            processedObjects: 4
                            readDataSize: 
                            transferredDataSize: 
                            startTime: '2024-07-18T03:32:31.2400000+02:00'
                            endTime: '2024-07-18T03:33:10.2400000+02:00'
                            duration: 39
                            failureMessages: [ ]
                            status: Success
                  - instanceUid: de6e62f5-944f-61d4-bc7b-6092755adecc
                    subtype: VSphere
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    protectedVmCount: 1
                    _embedded:
                      backupServerJob:
                        instanceUid: de6e62f5-944f-61d4-bc7b-6092755adecc
                        originalUid: f35e2320-20f1-43b3-9423-4902f2c6803e
                        name: VM5BackupJob
                        description: Backup Job VM5
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:35:41.4770000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: Success
                        type: BackupVm
                        lastRun: '2024-07-18T03:35:41.5370000+02:00'
                        lastEndTime: '2024-07-18T03:36:36.3630000+02:00'
                        lastDuration: 54
                        processingRate: 0
                        avgDuration: 54
                        transferredData: 0
                        backupChainSize: 1650688
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: 05998331-da83-46e4-8d18-eab8e5d9486a
                            objectUid: e651b9a9-c910-4b60-a9ee-4a84cacd9c13
                            objectName: vm5
                            totalObjects: 5
                            processedObjects: 5
                            readDataSize: 
                            transferredDataSize: 
                            startTime: '2024-07-18T03:35:55.3330000+02:00'
                            endTime: '2024-07-18T03:36:32.3330000+02:00'
                            duration: 37
                            failureMessages: [ ]
                            status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/backupVmJobs/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of VM Backup Jobs Configured on Backup Server
      description: Returns a collection resource representation of all objects of VM backup jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerBackupVmJobsObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVmJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: bd85b21b-76d7-65cf-9bf7-d40da96696db
                    instanceUid: 31b8060d-b06a-4227-815b-70436dc00af2
                    name: vm2
                    platform: vSphere
                    hierarchyRef: vm-11093
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:19:44.6600000+02:00'
                      endTime: '2024-07-18T03:20:29.3930000+02:00'
                      duration: 44
                      messages: [ ]
                  - jobUid: 5d68dcc8-0c7e-6797-b643-b1cfceeb73ec
                    instanceUid: b4b68148-6f94-4a51-8115-8340a6bf3e27
                    name: vm3
                    platform: vSphere
                    hierarchyRef: vm-88
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:34:13.3700000+02:00'
                      endTime: '2024-07-18T03:34:52.3530000+02:00'
                      duration: 38
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/backupVmJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of VM Backup Jobs
      description: Returns a collection resource representation of all VM backup job objects.
      operationId: GetBackupServerBackupVmJobsObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVmJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: bd85b21b-76d7-65cf-9bf7-d40da96696db
                    instanceUid: 31b8060d-b06a-4227-815b-70436dc00af2
                    name: vm2
                    platform: vSphere
                    hierarchyRef: vm-11093
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:19:44.6600000+02:00'
                      endTime: '2024-07-18T03:20:29.3930000+02:00'
                      duration: 44
                      messages: [ ]
                  - jobUid: 5d68dcc8-0c7e-6797-b643-b1cfceeb73ec
                    instanceUid: b4b68148-6f94-4a51-8115-8340a6bf3e27
                    name: vm3
                    platform: vSphere
                    hierarchyRef: vm-88
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:34:13.3700000+02:00'
                      endTime: '2024-07-18T03:34:52.3530000+02:00'
                      duration: 38
                      messages: [ ]
                  - jobUid: a7e071d7-c999-67f5-815d-a9d8eb917c5c
                    instanceUid: 70eddab0-5dbe-45ce-add9-69fd0e415725
                    name: vm5
                    platform: vSphere
                    hierarchyRef: vm-11093
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T06:54:55.3530000+02:00'
                      endTime: '2024-07-18T06:55:23.8800000+02:00'
                      duration: 28
                      messages: [ ]
                  - jobUid: de6e62f5-944f-61d4-bc7b-6092755adecc
                    instanceUid: 701a9a3c-61f5-4732-9517-7f4ab51b8dad
                    name: vm7
                    platform: vSphere
                    hierarchyRef: vm-88
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:35:55.3330000+02:00'
                      endTime: '2024-07-18T03:36:32.6130000+02:00'
                      duration: 37
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/backupVmJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of VM Backup Job
      description: Returns a collection resource representation of all objects of a VM backup job with the specified UID.
      operationId: GetBackupServerBackupVmJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVmJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: bd85b21b-76d7-65cf-9bf7-d40da96696db
                    instanceUid: 31b8060d-b06a-4227-815b-70436dc00af2
                    name: autoJob
                    platform: vSphere
                    hierarchyRef: vm-11093
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:19:44.6600000+02:00'
                      endTime: '2024-07-18T03:20:29.3930000+02:00'
                      duration: 44
                      messages: [ ]
                  - jobUid: bd85b21b-76d7-65cf-9bf7-d40da96696db
                    instanceUid: 701a9a3c-61f5-4732-9517-7f4ab51b8dad
                    name: vm7
                    platform: vSphere
                    hierarchyRef: vm-88
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:19:44.6600000+02:00'
                      endTime: '2024-07-18T03:20:29.3930000+02:00'
                      duration: 44
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/replicationVmJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All VM Replication Jobs
      description: Returns a resource representation of all replication jobs that protects VMs.
      operationId: GetBackupServerReplicationVmJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerReplicationVmJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerReplicationVmJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: cc2b33a6-f11b-6f5f-b297-a5ee7cdbfc84
                    protectedVmCount: 1
                    isCloudJob: true
                    cloudHostUid: c7ca9843-26b7-4a1c-b6f5-0fa2cec9ec2e
                    targetHostUid: 00000000-0000-0000-0000-000000000000
                    sourceWanAcceleratorUid: 
                    targetWanAcceleratorUid: 
                    throughWanAccelerators: false
                    _embedded:
                      backupServerJob:
                        instanceUid: cc2b33a6-f11b-6f5f-b297-a5ee7cdbfc84
                        originalUid: 6a4c2357-29f4-4a28-b7a8-1870ea6f4e5a
                        name: CloudReplicaJob
                        description: Created by Powershell at 7/17/2024 6:48:08 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:48:09.6830000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: Warning
                        type: ReplicationVM
                        lastRun: '2024-07-18T03:48:09.7630000+02:00'
                        lastEndTime: '2024-07-18T03:54:52.4800000+02:00'
                        lastDuration: 402
                        processingRate: 127782020
                        avgDuration: 402
                        transferredData: 16115584998
                        backupChainSize: 0
                        bottleneck: Target
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: "ivz10_2:\r\nOne or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues.\r\n"
                        targetType: Cloud
                        destination: Hardware plan 1
                        retentionLimit: 7
                        retentionLimitType: RestorePoints
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: dc7fc45c-0dfb-4727-b974-87885534c9ce
                            objectUid: 5c60fc5a-c2ea-4544-9703-908eec6ae262
                            objectName: ivz10_2
                            totalObjects: 6
                            processedObjects: 6
                            readDataSize: 24234688512
                            transferredDataSize: 16115584998
                            startTime: '2024-07-18T03:48:21.9030000+02:00'
                            endTime: '2024-07-18T03:54:42.9030000+02:00'
                            duration: 381
                            failureMessages:
                              - One or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues
                            status: Warning
                  - instanceUid: 2e13e257-75b9-6b93-9490-13bde4138a06
                    protectedVmCount: 1
                    isCloudJob: false
                    cloudHostUid: 
                    targetHostUid: 5d1a37d2-2fab-4f4c-aa0e-3d3dec4c4916
                    sourceWanAcceleratorUid: 
                    targetWanAcceleratorUid: 
                    throughWanAccelerators: false
                    _embedded:
                      backupServerJob:
                        instanceUid: 2e13e257-75b9-6b93-9490-13bde4138a06
                        originalUid: fb5e45d9-2eec-4fe0-8d27-da075d533ff5
                        name: ReplicationJob2
                        description: Created by Powershell at 7/17/2024 6:20:50 PM.
                        createdBy: R2THIRDVBR\Administrator
                        creationTime: '2024-07-18T03:20:54.6270000+02:00'
                        backupServerUid: 11fcba52-d408-47b7-9b3a-e850257afe85
                        locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                        siteUid: 
                        organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                        mappedOrganizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                        status: Success
                        type: ReplicationVM
                        lastRun: '2024-07-18T03:20:54.7370000+02:00'
                        lastEndTime: '2024-07-18T03:22:23.1270000+02:00'
                        lastDuration: 88
                        processingRate: 0
                        avgDuration: 88
                        transferredData: 0
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: pd159.tech.local
                        retentionLimit: 7
                        retentionLimitType: RestorePoints
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: d59b7e7f-0703-47c3-b960-55552124c260
                            objectUid: 2ce156b6-d77a-4e44-bcd3-84593032260c
                            objectName: vm5
                            totalObjects: 4
                            processedObjects: 4
                            readDataSize: 
                            transferredDataSize: 
                            startTime: '2024-07-18T03:21:06.6600000+02:00'
                            endTime: '2024-07-18T03:22:12.6600000+02:00'
                            duration: 66
                            failureMessages: [ ]
                            status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/replicationVmJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get VM Replication Job
      description: Returns a resource representation of a replication job with the specified UID that protects VMs.
      operationId: GetBackupServerReplicationVmJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerReplicationVmJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/replicationVmJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All VM Replication Jobs Configured on Backup Server
      description: Returns a collection resource representation of all VM replication jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerReplicationVmJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerReplicationVmJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerReplicationVmJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: cc2b33a6-f11b-6f5f-b297-a5ee7cdbfc84
                    protectedVmCount: 1
                    isCloudJob: true
                    cloudHostUid: c7ca9843-26b7-4a1c-b6f5-0fa2cec9ec2e
                    targetHostUid: 00000000-0000-0000-0000-000000000000
                    sourceWanAcceleratorUid: 
                    targetWanAcceleratorUid: 
                    throughWanAccelerators: false
                    _embedded:
                      backupServerJob:
                        instanceUid: cc2b33a6-f11b-6f5f-b297-a5ee7cdbfc84
                        originalUid: 6a4c2357-29f4-4a28-b7a8-1870ea6f4e5a
                        name: CloudReplicaJob
                        description: Created by Powershell at 7/17/2024 6:48:08 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:48:09.6830000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: Warning
                        type: ReplicationVM
                        lastRun: '2024-07-18T03:48:09.7630000+02:00'
                        lastEndTime: '2024-07-18T03:54:52.4800000+02:00'
                        lastDuration: 402
                        processingRate: 127782020
                        avgDuration: 402
                        transferredData: 16115584998
                        backupChainSize: 0
                        bottleneck: Target
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: "ivz10_2:\r\nOne or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues.\r\n"
                        targetType: Cloud
                        destination: Hardware plan 1
                        retentionLimit: 7
                        retentionLimitType: RestorePoints
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: dc7fc45c-0dfb-4727-b974-87885534c9ce
                            objectUid: 5c60fc5a-c2ea-4544-9703-908eec6ae262
                            objectName: ivz10_2
                            totalObjects: 6
                            processedObjects: 6
                            readDataSize: 24234688512
                            transferredDataSize: 16115584998
                            startTime: '2024-07-18T03:48:21.9030000+02:00'
                            endTime: '2024-07-18T03:54:42.9030000+02:00'
                            duration: 381
                            failureMessages:
                              - One or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues
                            status: Warning
                  - instanceUid: 2e13e257-75b9-6b93-9490-13bde4138a06
                    protectedVmCount: 1
                    isCloudJob: false
                    cloudHostUid: 
                    targetHostUid: 5d1a37d2-2fab-4f4c-aa0e-3d3dec4c4916
                    sourceWanAcceleratorUid: 
                    targetWanAcceleratorUid: 
                    throughWanAccelerators: false
                    _embedded:
                      backupServerJob:
                        instanceUid: 2e13e257-75b9-6b93-9490-13bde4138a06
                        originalUid: fb5e45d9-2eec-4fe0-8d27-da075d533ff5
                        name: ReplicationJob2
                        description: Created by Powershell at 7/17/2024 6:20:50 PM.
                        createdBy: R2THIRDVBR\Administrator
                        creationTime: '2024-07-18T03:20:54.6270000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 41c50737-68c2-43dc-86c4-25156bbd3d34
                        siteUid: 
                        organizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                        mappedOrganizationUid: 2824ca8d-b324-493c-b827-939c884723c6
                        status: Success
                        type: ReplicationVM
                        lastRun: '2024-07-18T03:20:54.7370000+02:00'
                        lastEndTime: '2024-07-18T03:22:23.1270000+02:00'
                        lastDuration: 88
                        processingRate: 0
                        avgDuration: 88
                        transferredData: 0
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: pd159.tech.local
                        retentionLimit: 7
                        retentionLimitType: RestorePoints
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: d59b7e7f-0703-47c3-b960-55552124c260
                            objectUid: 2ce156b6-d77a-4e44-bcd3-84593032260c
                            objectName: vm5
                            totalObjects: 4
                            processedObjects: 4
                            readDataSize: 
                            transferredDataSize: 
                            startTime: '2024-07-18T03:21:06.6600000+02:00'
                            endTime: '2024-07-18T03:22:12.6600000+02:00'
                            duration: 66
                            failureMessages: [ ]
                            status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/replicationVmJobs/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of VM Replication Jobs Configured on Backup Server
      description: Returns a collection resource representation of all objects of VM replication jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerReplicationVmJobsObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVmJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: cc2b33a6-f11b-6f5f-b297-a5ee7cdbfc84
                    instanceUid: 60a4bf21-d6be-4bf9-b01c-e1aa8dd5f934
                    name: ivz10_2
                    platform: vSphere
                    hierarchyRef: vm-79
                    isExcluded: false
                    lastSession:
                      backupStatus: Warning
                      totalBackedSize: 16115584998
                      sourceSize: 32212254720
                      startTime: '2024-07-18T03:48:21.9030000+02:00'
                      endTime: '2024-07-18T03:54:43.6500000+02:00'
                      duration: 381
                      messages:
                        - One or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues
                  - jobUid: 2e13e257-75b9-6b93-9490-13bde4138a06
                    instanceUid: 4e19288c-ec9a-47ed-b80e-aacb6281c6ff
                    name: vm5
                    platform: vSphere
                    hierarchyRef: vm-11093
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:21:06.6600000+02:00'
                      endTime: '2024-07-18T03:22:12.6730000+02:00'
                      duration: 66
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/replicationVmJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of VM Replication Jobs
      description: Returns a collection resource representation of all VM replication job objects.
      operationId: GetBackupServerReplicationVmJobsObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVmJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: cc2b33a6-f11b-6f5f-b297-a5ee7cdbfc84
                    instanceUid: 60a4bf21-d6be-4bf9-b01c-e1aa8dd5f934
                    name: ivz10_2
                    platform: vSphere
                    hierarchyRef: vm-79
                    isExcluded: false
                    lastSession:
                      backupStatus: Warning
                      totalBackedSize: 16115584998
                      sourceSize: 32212254720
                      startTime: '2024-07-18T03:48:21.9030000+02:00'
                      endTime: '2024-07-18T03:54:43.6500000+02:00'
                      duration: 381
                      messages:
                        - One or more source networks were possibly mapped onto the same cloud network. Simultaneous partial failovers of VMs residing on those networks may result in issues
                  - jobUid: 2e13e257-75b9-6b93-9490-13bde4138a06
                    instanceUid: 4e19288c-ec9a-47ed-b80e-aacb6281c6ff
                    name: vm5
                    platform: vSphere
                    hierarchyRef: vm-11093
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:21:06.6600000+02:00'
                      endTime: '2024-07-18T03:22:12.6730000+02:00'
                      duration: 66
                      messages: [ ]
                  - jobUid: 0715e1f2-33b9-6a97-94a8-eb86d4348c15
                    instanceUid: be239da5-2952-47a8-95ed-c4f098f1997e
                    name: ivz10_12
                    platform: vSphere
                    hierarchyRef: vm-7836
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 24198453524
                      sourceSize: 32212254720
                      startTime: '2024-07-18T03:38:19.4870000+02:00'
                      endTime: '2024-07-18T03:44:22.9730000+02:00'
                      duration: 363
                      messages: [ ]
                  - jobUid: e98ba69a-1fc8-6ddd-940c-08c4243fc530
                    instanceUid: 658cb5b7-e56d-4097-b5f6-0638db4a965a
                    name: vm10
                    platform: vSphere
                    hierarchyRef: vm-1123
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:33:39.4830000+02:00'
                      endTime: '2024-07-18T03:34:44.5230000+02:00'
                      duration: 65
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/replicationVmJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of VM Replication Job
      description: Returns a collection resource representation of all objects of a VM replication job with the specified UID.
      operationId: GetBackupServerReplicationVmJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVmJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: e98ba69a-1fc8-6ddd-940c-08c4243fc530
                    instanceUid: be239da5-2952-47a8-95ed-c4f098f1997e
                    name: ivz10_12
                    platform: vSphere
                    hierarchyRef: vm-7836
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 24198453524
                      sourceSize: 32212254720
                      startTime: '2024-07-18T03:38:19.4870000+02:00'
                      endTime: '2024-07-18T03:44:22.9730000+02:00'
                      duration: 363
                      messages: [ ]
                  - jobUid: e98ba69a-1fc8-6ddd-940c-08c4243fc530
                    instanceUid: 658cb5b7-e56d-4097-b5f6-0638db4a965a
                    name: vm10
                    platform: vSphere
                    hierarchyRef: vm-1123
                    isExcluded: false
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 0
                      sourceSize: 0
                      startTime: '2024-07-18T03:33:39.4830000+02:00'
                      endTime: '2024-07-18T03:34:44.5230000+02:00'
                      duration: 65
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/cdpReplicationJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All CDP Replication Jobs
      description: Returns a collection resource representation of all CDP replication jobs.
      operationId: GetBackupServerCdpReplicationJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerCdpReplicationJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerCdpReplicationJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7287bb98-0248-6d5d-bbe8-5a39ff594740
                    rpo: 15
                    rpoUnit: Seconds
                    shortTermRetention: 240
                    shortTermRetentionUnit: Minutes
                    longTermRetention: 1440
                    longTermRetentionUnit: Minutes
                    _embedded:
                      backupServerJob: 
                    keepRestorePointsInDays: 2
                    sourceProxyAutoDetect: true
                    targetProxyAutoDetect: true
                    isApplicationAwareEnabled: false
                    lastPeriod:
                      successCount: 0
                      warningCount: 0
                      errorsCount: 0
                      averageData: 
                      maximumData: 0
                      totalData: 0
                      averageDuration: 
                      maximumDuration: 0
                      syncInterval: 0
                      sla: 
                      maxDelay: 
                      bottleneck: NotDefined
                    lastDay:
                      successCount: 0
                      warningCount: 0
                      errorsCount: 0
                      totalSize: 
                      readData: 
                      transferredData: 
                      sla: 0
                      maxDelay: 0
                      bottleneck: NotDefined
                  - instanceUid: 686c459e-515f-6fe4-9855-c75e00d82dbb
                    rpo: 15
                    rpoUnit: Seconds
                    shortTermRetention: 240
                    shortTermRetentionUnit: Minutes
                    longTermRetention: 480
                    longTermRetentionUnit: Minutes
                    _embedded:
                      backupServerJob: 
                    keepRestorePointsInDays: 7
                    sourceProxyAutoDetect: true
                    targetProxyAutoDetect: true
                    isApplicationAwareEnabled: false
                    lastPeriod:
                      successCount: 0
                      warningCount: 0
                      errorsCount: 0
                      averageData: 
                      maximumData: 
                      totalData: 
                      averageDuration: 
                      maximumDuration: 
                      syncInterval: 
                      sla: 
                      maxDelay: 
                      bottleneck: NotDefined
                    lastDay:
                      successCount: 0
                      warningCount: 0
                      errorsCount: 0
                      totalSize: 
                      readData: 
                      transferredData: 
                      sla: 
                      maxDelay: 
                      bottleneck: NotDefined
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/cdpReplicationJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get CDP Replication Job
      description: Returns a resource representation of a CDP replication job with the specified UID.
      operationId: GetBackupServerCdpReplicationJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerCdpReplicationJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/cdpReplicationJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All CDP Replication Jobs Configured on Backup Server
      description: Returns a collection resource representation of all CDP replication jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerCdpReplicationJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerCdpReplicationJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerCdpReplicationJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7287bb98-0248-6d5d-bbe8-5a39ff594740
                    rpo: 15
                    rpoUnit: Seconds
                    shortTermRetention: 240
                    shortTermRetentionUnit: Minutes
                    longTermRetention: 1440
                    longTermRetentionUnit: Minutes
                    _embedded:
                      backupServerJob: 
                    keepRestorePointsInDays: 2
                    sourceProxyAutoDetect: true
                    targetProxyAutoDetect: true
                    isApplicationAwareEnabled: false
                    lastPeriod:
                      successCount: 0
                      warningCount: 0
                      errorsCount: 0
                      averageData: 
                      maximumData: 0
                      totalData: 0
                      averageDuration: 
                      maximumDuration: 0
                      syncInterval: 0
                      sla: 
                      maxDelay: 
                      bottleneck: NotDefined
                    lastDay:
                      successCount: 0
                      warningCount: 0
                      errorsCount: 0
                      totalSize: 
                      readData: 
                      transferredData: 
                      sla: 0
                      maxDelay: 0
                      bottleneck: NotDefined
                  - instanceUid: 686c459e-515f-6fe4-9855-c75e00d82dbb
                    rpo: 15
                    rpoUnit: Seconds
                    shortTermRetention: 240
                    shortTermRetentionUnit: Minutes
                    longTermRetention: 480
                    longTermRetentionUnit: Minutes
                    _embedded:
                      backupServerJob: 
                    keepRestorePointsInDays: 7
                    sourceProxyAutoDetect: true
                    targetProxyAutoDetect: true
                    isApplicationAwareEnabled: false
                    lastPeriod:
                      successCount: 0
                      warningCount: 0
                      errorsCount: 0
                      averageData: 
                      maximumData: 
                      totalData: 
                      averageDuration: 
                      maximumDuration: 
                      syncInterval: 
                      sla: 
                      maxDelay: 
                      bottleneck: NotDefined
                    lastDay:
                      successCount: 0
                      warningCount: 0
                      errorsCount: 0
                      totalSize: 
                      readData: 
                      transferredData: 
                      sla: 
                      maxDelay: 
                      bottleneck: NotDefined
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/cdpReplicationJobs/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of CDP Replication Jobs Configured on Backup Server
      description: Returns a collection resource representation of all objects of CDP replication jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerCdpReplicationJobsObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerCdpReplicationJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: d6ceac94-0f74-4ccd-8f47-eb2e9fc0f4d8
                    instanceUid: 0c058ef8-7188-4641-8515-9b4c46d2c96e
                    name: CloudVM
                    status: InProgress
                    failureMessage: "RPO has been exceeded by more than 3 seconds at 1/16/2023 8:08:42 AM\r\nRPO has been exceeded by more than 2 seconds at 1/16/2023 8:08:20 AM\r\nRPO has been exceeded by more than 2 seconds at 1/16/2023 8:05:54 AM\r\nRPO has been exceeded by more than 3 seconds at 1/16/2023 8:04:16 AM\r\n"
                    lastSessionEndTime: '2023-11-19T09:00:00.0000000+01:00'
                    sla: 98
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 14546
                    maxDurationSec: 13485
                    intervalSec: 20
                    successfulSessionsCount: 493
                    failedSessionsCount: 3
                    warningsCount: 5
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                  - jobUid: 33599154-7999-49f2-9f19-716be9c8daf1
                    instanceUid: bc8069ae-74fd-48f6-bb30-2d3b5919e9b2
                    name: Cloud
                    status: InProgress
                    failureMessage: "RPO has been exceeded by more than 2 seconds at 1/16/2023 9:12:43 AM\r\n"
                    lastSessionEndTime: '2023-11-19T09:00:00.0000000+01:00'
                    sla: 98
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 13538
                    maxDurationSec: 11444
                    intervalSec: 18
                    successfulSessionsCount: 165
                    failedSessionsCount: 0
                    warningsCount: 2
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                  - jobUid: aa037bd5-40af-4ca8-a8f2-5ec1ef5132d4
                    instanceUid: cd060376-6de4-44d6-9f92-f93ff24e1ae7
                    name: 2vm218
                    status: InProgress
                    failureMessage: ''
                    lastSessionEndTime: '2023-11-19T09:00:00.0000000+01:00'
                    sla: 100
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 10019
                    maxDurationSec: 473
                    intervalSec: 20
                    successfulSessionsCount: 153
                    failedSessionsCount: 0
                    warningsCount: 0
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                  - jobUid: aa037bd5-40af-4ca8-a8f2-5ec1ef5132d4
                    instanceUid: 78af0cfc-f1a4-4dc8-8fe6-f3d6086c2637
                    name: 1vm218
                    status: InProgress
                    failureMessage: ''
                    lastSessionEndTime: '2023-11-19T09:00:00.0000000+01:00'
                    sla: 100
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 10014
                    maxDurationSec: 477
                    intervalSec: 20
                    successfulSessionsCount: 154
                    failedSessionsCount: 0
                    warningsCount: 0
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                  - jobUid: 346ed9e0-980d-426d-8729-519464c231c9
                    instanceUid: 295a2500-c7ec-44a1-97eb-b45f726a0fbb
                    name: 1vm211
                    status: InProgress
                    failureMessage: ''
                    lastSessionEndTime: '2023-11-19T09:00:00.0000000+01:00'
                    sla: 100
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 5019
                    maxDurationSec: 566
                    intervalSec: 10
                    successfulSessionsCount: 308
                    failedSessionsCount: 0
                    warningsCount: 0
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                meta:
                  pagingInfo:
                    total: 5
                    count: 5
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/cdpReplicationJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of CDP Replication Jobs
      description: Returns a collection resource representation of all CDP replication job objects.
      operationId: GetBackupServerCdpReplicationJobsObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerCdpReplicationJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: f0c0a24d-25c3-4ec2-a24a-b24635a3fe4b
                    instanceUid: c717cc70-0762-487d-bd4b-a2b43ff97aeb
                    name: 1vm207
                    status: InProgress
                    failureMessage: "VM configuration for the initial sync completed with errors Error: Using regular backup or replication functionality is restricted for Cloud Connect infrastructure servers to avoid impact on your tenants.: first occurrence at 1/5/2023 7:30:45 AM, last occurrence at 1/16/2023 9:05:21 AM, 61945 retries\r\nVM configuration for the initial sync completed with errors Error: Using regular backup or replication functionality is restricted for Cloud Connect infrastructure servers to avoid impact on your tenants.: first occurrence at 1/5/2023 7:30:45 AM, last occurrence at 1/16/2023 9:05:36 AM, 61946 retries\r\nVM configuration for the initial sync completed with errors Error: Using regular backup or replication functionality is restricted for Cloud Connect infrastructure servers to avoid impact on your tenants.: first occurrence at 1/5/2023 7:30:45 AM, last occurrence at 1/16/2023 9:05:04 AM, 61944 retries\r\nVM configuration for the initial sync completed with errors Error: Using regular backup or replication functionality is restricted for Cloud Connect infrastructure servers to avoid impact on your tenants.: first occurrence at 1/5/2023 7:30:45 AM, last occurrence at 1/16/2023 9:04:49 AM, 61943 retries\r\nVM configuration for the initial sync completed with errors Error: Using regular backup or replication functionality is restricted for Cloud Connect infrastructure servers to avoid impact on your tenants.: first occurrence at 1/5/2023 7:30:45 AM, last occurrence at 1/16/2023 9:04:33 AM, 61942 retries\r\n"
                    lastSessionEndTime: '2023-11-19T09:00:00.0000000+01:00'
                    sla: 0
                    bottleneck: NotDefined
                    maxDelaySec: 0
                    avgDurationSec: 
                    maxDurationSec: 
                    intervalSec: 0
                    successfulSessionsCount: 0
                    failedSessionsCount: 0
                    warningsCount: 0
                    avgTransferredDataKb: -1
                    maxTransferredDataKb: -1
                    totalTransferredDataKb: -1
                  - jobUid: fdedbaf2-5b4c-4636-a115-6e12afcbfd41
                    instanceUid: 320b8c3b-25e7-443a-ba53-a2b0f3b7dc8d
                    name: vm103
                    status: Warning
                    failureMessage: "Task session completed: 103 replica states processed successfully\r\nFinishing task session: Your trial license has expired.\r\nTo purchase a production license, submit a sales inquiry on our website at https://www.veeam.com/sales.\r\n\r\nTo obtain another license, please submit a request at https://www.veeam.com/sales\r\nA sales representative will contact you shortly after your request has been received..\r\n"
                    lastSessionEndTime: '2022-12-31T17:00:18.0570000+01:00'
                    sla: 100
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 0
                    maxDurationSec: 0
                    intervalSec: 15
                    successfulSessionsCount: 103
                    failedSessionsCount: 0
                    warningsCount: 0
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                  - jobUid: b04a5635-5450-40cf-b5bd-ffd43f8f135a
                    instanceUid: 2941677e-2be8-4933-9c6b-830eef1e14d8
                    name: vm221
                    status: Warning
                    failureMessage: "Task session completed: 77 replica states processed successfully\r\nFinishing task session: Your trial license has expired.\r\nTo purchase a production license, submit a sales inquiry on our website at https://www.veeam.com/sales.\r\n\r\nTo obtain another license, please submit a request at https://www.veeam.com/sales\r\nA sales representative will contact you shortly after your request has been received..\r\n"
                    lastSessionEndTime: '2022-12-31T17:00:17.1370000+01:00'
                    sla: 100
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 0
                    maxDurationSec: 0
                    intervalSec: 20
                    successfulSessionsCount: 77
                    failedSessionsCount: 0
                    warningsCount: 0
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                  - jobUid: d6ceac94-0f74-4ccd-8f47-eb2e9fc0f4d8
                    instanceUid: 0c058ef8-7188-4641-8515-9b4c46d2c96e
                    name: CloudVM
                    status: InProgress
                    failureMessage: "RPO has been exceeded by more than 3 seconds at 1/16/2023 8:08:42 AM\r\nRPO has been exceeded by more than 2 seconds at 1/16/2023 8:08:20 AM\r\nRPO has been exceeded by more than 2 seconds at 1/16/2023 8:05:54 AM\r\nRPO has been exceeded by more than 3 seconds at 1/16/2023 8:04:16 AM\r\n"
                    lastSessionEndTime: '2023-11-19T09:00:00.0000000+01:00'
                    sla: 98
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 14546
                    maxDurationSec: 13485
                    intervalSec: 20
                    successfulSessionsCount: 493
                    failedSessionsCount: 3
                    warningsCount: 5
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/cdpReplicationJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of CDP Replication Job
      description: Returns a collection resource representation of all objects of a CDP replication job with the specified UID.
      operationId: GetBackupServerCdpReplicationJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerCdpReplicationJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: d6ceac94-0f74-4ccd-8f47-eb2e9fc0f4d8
                    instanceUid: 0c058ef8-7188-4641-8515-9b4c46d2c96e
                    name: CloudVM
                    status: InProgress
                    failureMessage: "RPO has been exceeded by more than 3 seconds at 10/16/2023 8:08:42 AM\r\nRPO has been exceeded by more than 2 seconds at 1/16/2023 8:08:20 AM\r\nRPO has been exceeded by more than 2 seconds at 1/16/2023 8:05:54 AM\r\nRPO has been exceeded by more than 3 seconds at 10/16/2023 8:04:16 AM\r\n"
                    lastSessionEndTime: '2023-10-19T10:00:00.0000000+02:00'
                    sla: 98
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 14546
                    maxDurationSec: 13485
                    intervalSec: 20
                    successfulSessionsCount: 493
                    failedSessionsCount: 3
                    warningsCount: 5
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                  - jobUid: d6ceac94-0f74-4ccd-8f47-eb2e9fc0f4d8
                    instanceUid: 320b8c3b-25e7-443a-ba53-a2b0f3b7dc8d
                    name: vm103
                    status: InProgress
                    failureMessage: "RPO has been exceeded by more than 3 seconds at 10/16/2023 8:08:42 AM\r\nRPO has been exceeded by more than 2 seconds at 1/16/2023 8:08:20 AM\r\nRPO has been exceeded by more than 2 seconds at 1/16/2023 8:05:54 AM\r\nRPO has been exceeded by more than 3 seconds at 10/16/2023 8:04:16 AM\r\n"
                    lastSessionEndTime: '2023-10-19T10:00:00.0000000+02:00'
                    sla: 100
                    bottleneck: None
                    maxDelaySec: 0
                    avgDurationSec: 0
                    maxDurationSec: 0
                    intervalSec: 15
                    successfulSessionsCount: 103
                    failedSessionsCount: 0
                    warningsCount: 0
                    avgTransferredDataKb: 0
                    maxTransferredDataKb: 0
                    totalTransferredDataKb: 0
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/backupCopyJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Periodic Backup Copy Jobs
      description: Returns a collection resource representation of all periodic backup copy and legacy periodic backup copy jobs.
      operationId: GetBackupServerBackupCopyJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerBackupCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerBackupCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: edfdcbfb-80c5-4813-b316-458530a2904a
                    targetRepositoryUid: da62c2de-04a1-40a2-8d3a-03a23d7d7c93
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: false
                    rpoOptionsValue: 0
                    rpoOptionsUnit: Minutes
                    _embedded:
                      backupServerJob: 
                  - instanceUid: c35681f3-a57f-4ef3-9423-1ed394a372b1
                    targetRepositoryUid: da62c2de-04a1-40a2-8d3a-03a23d7d7c93
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: false
                    rpoOptionsValue: 0
                    rpoOptionsUnit: Minutes
                    _embedded:
                      backupServerJob: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/backupCopyJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get Periodic Backup Copy Job
      description: Returns a resource representation of a periodic backup copy or legacy periodic backup copy job with the specified UID.
      operationId: GetBackupServerBackupCopyJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerBackupCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/backupCopyJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Periodic Backup Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of all periodic backup copy and legacy periodic backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerBackupCopyJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerBackupCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerBackupCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: edfdcbfb-80c5-4813-b316-458530a2904a
                    targetRepositoryUid: da62c2de-04a1-40a2-8d3a-03a23d7d7c93
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: false
                    rpoOptionsValue: 0
                    rpoOptionsUnit: Minutes
                    _embedded:
                      backupServerJob: 
                  - instanceUid: c35681f3-a57f-4ef3-9423-1ed394a372b1
                    targetRepositoryUid: da62c2de-04a1-40a2-8d3a-03a23d7d7c93
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: false
                    rpoOptionsValue: 0
                    rpoOptionsUnit: Minutes
                    _embedded:
                      backupServerJob: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/backupCopyJobs/jobObjects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Periodic Backup Copy Jobs
      description: Returns a collection resource representation of objects of all periodic backup copy and legacy periodic backup copy jobs.
      operationId: GetBackupServerBackupCopyJobsLinkedJobObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: edfdcbfb-80c5-4813-b316-458530a2904a
                    linkedJobUid: 2151c695-aa5a-4f0e-8ad2-529532d31c7b
                  - jobUid: c35681f3-a57f-4ef3-9423-1ed394a372b1
                    linkedJobUid: cddd0885-2aaf-4bf7-8046-dc7a39b20da8
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/backupCopyJobs/{jobUid}/jobObjects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Periodic Backup Copy Job
      description: Returns a collection resource representation of all objects of a periodic backup copy or legacy periodic backup copy job with the specified UID.
      operationId: GetBackupServerBackupCopyJobLinkedJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: c35681f3-a57f-4ef3-9423-1ed394a372b1
                    linkedJobUid: cddd0885-2aaf-4bf7-8046-dc7a39b20da8
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/backupCopyJobs/jobObjects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Periodic Backup Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of objects of all periodic backup copy and legacy periodic backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerBackupCopyJobsLinkedJobObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: edfdcbfb-80c5-4813-b316-458530a2904a
                    linkedJobUid: 2151c695-aa5a-4f0e-8ad2-529532d31c7b
                  - jobUid: c35681f3-a57f-4ef3-9423-1ed394a372b1
                    linkedJobUid: cddd0885-2aaf-4bf7-8046-dc7a39b20da8
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/fileShareJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All File Share Jobs
      description: Returns a collection resource representation of all file share jobs.
      operationId: GetBackupServerFileShareJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerFileShareJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 8104876e-fb33-6cc8-88ec-7c2009241f20
                    targetRepositoryUid: 3a9cdc2f-487c-4999-8a20-840716f796c7
                    archiveRepositoryUid: 
                    retention: 28
                    retentionUnit: Days
                    isArchiveRetentionEnabled: false
                    archiveRetention: 3
                    archiveRetentionUnit: Years
                    _embedded:
                      backupServerJob: 
                  - instanceUid: 00c3b419-f9fb-69e9-8dcb-f776a7bad4a6
                    targetRepositoryUid: 5adf198e-135d-488f-ba6e-472a418e5337
                    archiveRepositoryUid: 
                    retention: 28
                    retentionUnit: Days
                    isArchiveRetentionEnabled: false
                    archiveRetention: 3
                    archiveRetentionUnit: Years
                    _embedded:
                      backupServerJob: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/fileShareJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get File Share Job
      description: Returns a resource representation of a file share job with the specified UID.
      operationId: GetBackupServerFileShareJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerFileShareJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/fileShareJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All File Share Jobs Configured on Backup Server
      description: Returns a collection resource representation of all file share jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerFileShareJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerFileShareJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 00c3b419-f9fb-69e9-8dcb-f776a7bad4a6
                    targetRepositoryUid: 5adf198e-135d-488f-ba6e-472a418e5337
                    archiveRepositoryUid: 
                    retention: 28
                    retentionUnit: Days
                    isArchiveRetentionEnabled: false
                    archiveRetention: 3
                    archiveRetentionUnit: Years
                    _embedded:
                      backupServerJob: 
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/fileShareJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of File Share Jobs
      description: Returns a collection resource representation of all file share job objects.
      operationId: GetBackupServerFileShareJobsObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 91487784-847f-481a-a9ac-5fa4b7a677d3
                    fileShareUid: a3638286-6a30-4479-a894-ad183571ce6e
                    name: \\r2vbr.tech.local\C$\setup
                    sources:
                      - path: \\r2vbr.tech.local\C$\setup
                        type: Directory
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks:
                          - \.snapshot
                          - \~snapshot
                    lastSession:
                      backupStatus: Success
                      sourceFilesCount: 
                      changedFilesCount: 0
                      skippedFilesCount: 0
                      backedUpFilesCount: 0
                      transferredSize: 0
                      sourceSize: 0
                      duration: 23
                      messages: [ ]
                  - jobUid: b648dd42-7bda-4353-a969-2e1b49715256
                    fileShareUid: 60041c92-e4eb-424e-aea7-9cfa3ecd89d1
                    name: \\r2SecondVBR.tech.local\C$\setup
                    sources:
                      - path: \\r2SecondVBR.tech.local\C$\setup
                        type: Directory
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks:
                          - \.snapshot
                          - \~snapshot
                    lastSession:
                      backupStatus: Success
                      sourceFilesCount: 5
                      changedFilesCount: 5
                      skippedFilesCount: 0
                      backedUpFilesCount: 5
                      transferredSize: 1260490
                      sourceSize: 13017942
                      duration: 28
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/fileShareJobs/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of File Share Jobs Configured on Backup Server
      description: Returns a collection resource representation of all objects of file share jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerFileShareJobsObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: b648dd42-7bda-4353-a969-2e1b49715256
                    fileShareUid: 60041c92-e4eb-424e-aea7-9cfa3ecd89d1
                    name: \\r2SecondVBR.tech.local\C$\setup
                    sources:
                      - path: \\r2SecondVBR.tech.local\C$\setup
                        type: Directory
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks:
                          - \.snapshot
                          - \~snapshot
                    lastSession:
                      backupStatus: Success
                      sourceFilesCount: 5
                      changedFilesCount: 5
                      skippedFilesCount: 0
                      backedUpFilesCount: 5
                      transferredSize: 1260490
                      sourceSize: 13017942
                      duration: 28
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/fileShareJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of File Share Job
      description: Returns a collection resource representation of all objects of a file share job with the specified UID.
      operationId: GetBackupServerFileShareJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 91487784-847f-481a-a9ac-5fa4b7a677d3
                    fileShareUid: a3638286-6a30-4479-a894-ad183571ce6e
                    name: \\r2vbr.tech.local\C$\setup
                    sources:
                      - path: \\r2vbr.tech.local\C$\setup
                        type: Directory
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks:
                          - \.snapshot
                          - \~snapshot
                    lastSession:
                      backupStatus: Success
                      sourceFilesCount: 
                      changedFilesCount: 0
                      skippedFilesCount: 0
                      backedUpFilesCount: 0
                      transferredSize: 0
                      sourceSize: 0
                      duration: 23
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/fileShareCopyJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All File Share Copy Jobs
      description: Returns a collection resource representation of all backup copy jobs for file shares.
      operationId: GetBackupServerFileShareCopyJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerFileShareCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7102363b-9c1e-617f-aff8-6d4fb47e628a
                    sourceFileShareJobUid: 8104876e-fb33-6cc8-88ec-7c2009241f20
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    retention: 28
                    retentionUnit: Days
                    sourceSize: 15395056
                    _embedded:
                      backupServerJob:
                        instanceUid: 7102363b-9c1e-617f-aff8-6d4fb47e628a
                        originalUid: 478e7a19-3475-4c12-937f-285646e53893
                        name: NASBackupJob (Copy) 1
                        description: ''
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:46:36.2670000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: Success
                        type: BackupFileCopy
                        lastRun: '2024-07-18T03:47:21.5470000+02:00'
                        lastEndTime: '2024-07-18T03:47:56.1700000+02:00'
                        lastDuration: 34
                        processingRate: 1539505
                        avgDuration: 34
                        transferredData: 1576106
                        backupChainSize: 71764356
                        bottleneck: Target
                        isEnabled: true
                        scheduleType: Continuously
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: bd841ec4-35cb-400f-b71f-6e43e7217b1e
                            objectUid: 3b441365-a472-4f89-89d4-bff8ba3ed23e
                            objectName: \\r2vbr.tech.local\C$\setup
                            totalObjects: 
                            processedObjects: 
                            readDataSize: 15395056
                            transferredDataSize: 1576106
                            startTime: '2024-07-18T03:47:34.0770000+02:00'
                            endTime: '2024-07-18T03:47:52.0770000+02:00'
                            duration: 18
                            failureMessages: [ ]
                            status: Success
                  - instanceUid: bf21b419-3e55-6531-b0b7-a21cfefa8a8a
                    sourceFileShareJobUid: 00c3b419-f9fb-69e9-8dcb-f776a7bad4a6
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    retention: 28
                    retentionUnit: Days
                    sourceSize: 15423644
                    _embedded:
                      backupServerJob:
                        instanceUid: bf21b419-3e55-6531-b0b7-a21cfefa8a8a
                        originalUid: f97f671f-2dfd-4748-80fa-95e9473adaa0
                        name: NASBackupJob (Copy) 1
                        description: ''
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:40:38.1430000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: Disabling
                        type: BackupFileCopy
                        lastRun: '2024-07-18T03:41:39.3930000+02:00'
                        lastEndTime: '2024-07-18T03:42:14.2830000+02:00'
                        lastDuration: 34
                        processingRate: 1542364
                        avgDuration: 34
                        transferredData: 1580501
                        backupChainSize: 71728099
                        bottleneck: Proxy
                        isEnabled: true
                        scheduleType: Continuously
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: 91c7ace2-21dc-41e2-bf96-ba29abf020ef
                            objectUid: f1a44a0c-ece1-430c-976d-0b54225aded0
                            objectName: \\r2SecondVBR.tech.local\C$\setup
                            totalObjects: 
                            processedObjects: 
                            readDataSize: 15423644
                            transferredDataSize: 1580501
                            startTime: '2024-07-18T03:41:51.8470000+02:00'
                            endTime: '2024-07-18T03:42:10.8470000+02:00'
                            duration: 19
                            failureMessages: [ ]
                            status: Success
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/fileShareCopyJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get File Share Copy Job
      description: Returns a resource representation of a file share backup copy job with the specified UID.
      operationId: GetBackupServerFileShareCopyJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerFileShareCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/fileShareCopyJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All File Share Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of all file share backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerFileShareCopyJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerFileShareCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: bf21b419-3e55-6531-b0b7-a21cfefa8a8a
                    sourceFileShareJobUid: 00c3b419-f9fb-69e9-8dcb-f776a7bad4a6
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    retention: 28
                    retentionUnit: Days
                    sourceSize: 15423644
                    _embedded:
                      backupServerJob:
                        instanceUid: bf21b419-3e55-6531-b0b7-a21cfefa8a8a
                        originalUid: f97f671f-2dfd-4748-80fa-95e9473adaa0
                        name: autoNASBackupJob (Copy) 1
                        description: ''
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:40:38.1430000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: Disabling
                        type: BackupFileCopy
                        lastRun: '2024-07-18T03:41:39.3930000+02:00'
                        lastEndTime: '2024-07-18T03:42:14.2830000+02:00'
                        lastDuration: 34
                        processingRate: 1542364
                        avgDuration: 34
                        transferredData: 1580501
                        backupChainSize: 71728099
                        bottleneck: Proxy
                        isEnabled: true
                        scheduleType: Continuously
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks:
                          - instanceUid: 91c7ace2-21dc-41e2-bf96-ba29abf020ef
                            objectUid: f1a44a0c-ece1-430c-976d-0b54225aded0
                            objectName: \\r2SecondVBR.tech.local\C$\setup
                            totalObjects: 
                            processedObjects: 
                            readDataSize: 15423644
                            transferredDataSize: 1580501
                            startTime: '2024-07-18T03:41:51.8470000+02:00'
                            endTime: '2024-07-18T03:42:10.8470000+02:00'
                            duration: 19
                            failureMessages: [ ]
                            status: Success
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/fileShareCopyJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of File Share Copy Jobs
      description: Returns a collection resource representation of all file share backup copy job objects.
      operationId: GetBackupServerFileShareCopyJobsObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareCopyJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 7102363b-9c1e-617f-aff8-6d4fb47e628a
                    fileShareUid: 85ba920f-9d68-4927-a1e0-c04a9fd0662e
                    path: \\r2vbr.tech.local\C$\setup
                    sources:
                      - path: \\r2vbr.tech.local\C$\setup
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks:
                          - \.snapshot
                          - \~snapshot
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 1576106
                      sourceSize: 15395056
                      startTime: '2024-07-18T03:47:34.0770000+02:00'
                      endTime: '2024-07-18T03:47:52.9970000+02:00'
                      duration: 18
                      messages: [ ]
                  - jobUid: bf21b419-3e55-6531-b0b7-a21cfefa8a8a
                    fileShareUid: d6aea63c-b2a9-4608-9bb1-0861b8557fb8
                    path: \\r2SecondVBR.tech.local\C$\setup
                    sources:
                      - path: \\r2SecondVBR.tech.local\C$\setup
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks:
                          - \.snapshot
                          - \~snapshot
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 1580501
                      sourceSize: 15423644
                      startTime: '2024-07-18T03:41:51.8470000+02:00'
                      endTime: '2024-07-18T03:42:11.0800000+02:00'
                      duration: 19
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/fileShareCopyJobs/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of File Share Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of all objects of file share backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerFileShareCopyJobsObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareCopyJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: bf21b419-3e55-6531-b0b7-a21cfefa8a8a
                    fileShareUid: d6aea63c-b2a9-4608-9bb1-0861b8557fb8
                    path: \\r2SecondVBR.tech.local\C$\setup
                    sources:
                      - path: \\r2SecondVBR.tech.local\C$\setup
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks:
                          - \.snapshot
                          - \~snapshot
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 1580501
                      sourceSize: 15423644
                      startTime: '2024-07-18T03:41:51.8470000+02:00'
                      endTime: '2024-07-18T03:42:11.0800000+02:00'
                      duration: 19
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/fileShareCopyJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of File Share Copy Job
      description: Returns a collection resource representation of all objects of a file share backup copy job with the specified UID.
      operationId: GetBackupServerFileShareCopyJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileShareCopyJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 7102363b-9c1e-617f-aff8-6d4fb47e628a
                    fileShareUid: 85ba920f-9d68-4927-a1e0-c04a9fd0662e
                    path: \\r2vbr.tech.local\C$\setup
                    sources:
                      - path: \\r2vbr.tech.local\C$\setup
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks:
                          - \.snapshot
                          - \~snapshot
                    lastSession:
                      backupStatus: Success
                      totalBackedSize: 1576106
                      sourceSize: 15395056
                      startTime: '2024-07-18T03:47:34.0770000+02:00'
                      endTime: '2024-07-18T03:47:52.9970000+02:00'
                      duration: 18
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/objectStorageBackupJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Object Storage Backup Jobs
      description: Returns a collection resource representation of all object storage backup jobs.
      operationId: GetBackupServerObjectStorageBackupJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerObjectStorageBackupJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e32220f5-ca02-4d34-8075-8b64c20c7684
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    retention: 28
                    retentionUnit: Days
                    isArchiveRetentionEnabled: false
                    archiveRetention: 3
                    archiveRetentionUnit: Years
                    _embedded:
                      backupServerJob: 
                  - instanceUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    retention: 28
                    retentionUnit: Days
                    isArchiveRetentionEnabled: false
                    archiveRetention: 3
                    archiveRetentionUnit: Years
                    _embedded:
                      backupServerJob: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/objectStorageBackupJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get Object Storage Backup Job
      description: Returns a resource representation of a object storage backup job with the specified UID.
      operationId: GetBackupServerObjectStorageBackupJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerObjectStorageBackupJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/objectStorageBackupJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Object Storage Backup Jobs Configured on Backup Server
      description: Returns a collection resource representation of all object storage backup jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerObjectStorageBackupJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerObjectStorageBackupJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e32220f5-ca02-4d34-8075-8b64c20c7684
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    retention: 28
                    retentionUnit: Days
                    isArchiveRetentionEnabled: false
                    archiveRetention: 3
                    archiveRetentionUnit: Years
                    _embedded:
                      backupServerJob: 
                  - instanceUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    retention: 28
                    retentionUnit: Days
                    isArchiveRetentionEnabled: false
                    archiveRetention: 3
                    archiveRetentionUnit: Years
                    _embedded:
                      backupServerJob: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/objectStorageBackupJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Object Storage Backup Jobs
      description: Returns a collection resource representation of all object storage backup job objects.
      operationId: GetBackupServerObjectStorageBackupJobsObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 53a5e690-b0db-4d5c-b096-99fb694724b4
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    name: srv2
                    sources:
                      - path: ns3/Veeam/Backup365
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession:
                      backupStatus: Success
                      sourceFilesCount: 7496
                      changedFilesCount: 0
                      skippedFilesCount: 7496
                      backedUpFilesCount: 0
                      transferredSize: 0
                      sourceSize: 8389746072
                      duration: 33
                      messages: [ ]
                  - jobUid: 63b1ab5a-b2bb-4941-bb65-9d92a5c2a718
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    name: srv1
                    sources:
                      - path: srv1
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/objectStorageBackupJobs/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Object Storage Backup Jobs Configured on Backup Server
      description: Returns a collection resource representation of all objects of object storage backup jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerObjectStorageBackupJobsObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 53a5e690-b0db-4d5c-b096-99fb694724b4
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    name: srv2
                    sources:
                      - path: ns3/Veeam/Backup365
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession:
                      backupStatus: Success
                      sourceFilesCount: 7496
                      changedFilesCount: 0
                      skippedFilesCount: 7496
                      backedUpFilesCount: 0
                      transferredSize: 0
                      sourceSize: 8389746072
                      duration: 33
                      messages: [ ]
                  - jobUid: 63b1ab5a-b2bb-4941-bb65-9d92a5c2a718
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    name: srv1
                    sources:
                      - path: srv1
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/objectStorageBackupJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Object Storage Backup Job
      description: Returns a collection resource representation of all objects of a object storage backup job with the specified UID.
      operationId: GetBackupServerObjectStorageBackupJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 53a5e690-b0db-4d5c-b096-99fb694724b4
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    name: srv2
                    sources:
                      - path: ns3/Veeam/Backup365
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession:
                      backupStatus: Success
                      sourceFilesCount: 7496
                      changedFilesCount: 0
                      skippedFilesCount: 7496
                      backedUpFilesCount: 0
                      transferredSize: 0
                      sourceSize: 8389746072
                      duration: 33
                      messages: [ ]
                  - jobUid: 53a5e690-b0db-4d5c-b096-99fb694724b4
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    name: srv1
                    sources:
                      - path: srv1
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession:
                      backupStatus: Success
                      sourceFilesCount: 4653
                      changedFilesCount: 0
                      skippedFilesCount: 4653
                      backedUpFilesCount: 0
                      transferredSize: 0
                      sourceSize: 4536485796
                      duration: 33
                      messages: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/objectStorageBackupCopyJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Object Storage Backup Copy Jobs
      description: Returns a collection resource representation of all backup copy jobs for object storage backups.
      operationId: GetBackupServerObjectStorageBackupCopyJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerObjectStorageBackupCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e32220f5-ca02-4d34-8075-8b64c20c7684
                    sourceObjectStorageBackupJobUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    retention: 28
                    retentionUnit: Days
                    sourceSize: 253458
                    _embedded:
                      backupServerJob: 
                  - instanceUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    sourceObjectStorageBackupJobUid: b93867fd-43f1-465c-b7d7-43afe1ecdbda
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    retention: 28
                    retentionUnit: Days
                    sourceSize: 14673
                    _embedded:
                      backupServerJob: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/objectStorageBackupCopyJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get Object Storage Backup Copy Job
      description: Returns a resource representation of a object storage backup backup copy job with the specified UID.
      operationId: GetBackupServerObjectStorageBackupCopyJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerObjectStorageBackupCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/objectStorageBackupCopyJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Object Storage Backup Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of all object storage backup backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerObjectStorageBackupCopyJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerObjectStorageBackupCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e32220f5-ca02-4d34-8075-8b64c20c7684
                    sourceObjectStorageBackupJobUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    retention: 28
                    retentionUnit: Days
                    sourceSize: 253458
                    _embedded:
                      backupServerJob: 
                  - instanceUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    sourceObjectStorageBackupJobUid: b93867fd-43f1-465c-b7d7-43afe1ecdbda
                    targetRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    retention: 28
                    retentionUnit: Days
                    sourceSize: 14673
                    _embedded:
                      backupServerJob: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/objectStorageBackupCopyJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Object Storage Backup Copy Jobs
      description: Returns a collection resource representation of all object storage backup backup copy job objects.
      operationId: GetBackupServerObjectStorageBackupCopyJobsObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupCopyJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 53a5e690-b0db-4d5c-b096-99fb694724b4
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    path: ns3/Veeam/Backup365
                    sources:
                      - path: ns3/Veeam/Backup365
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession: 
                  - jobUid: 63b1ab5a-b2bb-4941-bb65-9d92a5c2a718
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    path: srv1
                    sources:
                      - path: srv1
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/objectStorageBackupCopyJobs/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Object Storage Backup Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of all objects of object storage backup backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerObjectStorageBackupCopyJobsObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupCopyJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 53a5e690-b0db-4d5c-b096-99fb694724b4
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    path: ns3/Veeam/Backup365
                    sources:
                      - path: ns3/Veeam/Backup365
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession: 
                  - jobUid: 63b1ab5a-b2bb-4941-bb65-9d92a5c2a718
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    path: srv1
                    sources:
                      - path: srv1
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/objectStorageBackupCopyJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Object Storage Backup Copy Job
      description: Returns a collection resource representation of all objects of a object storage backup backup copy job with the specified UID.
      operationId: GetBackupServerObjectStorageBackupCopyJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerObjectStorageBackupCopyJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 53a5e690-b0db-4d5c-b096-99fb694724b4
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    path: ns3/Veeam/Backup365
                    sources:
                      - path: ns3/Veeam/Backup365
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession: 
                  - jobUid: 53a5e690-b0db-4d5c-b096-99fb694724b4
                    objectStorageUid: bd7f69b3-1f07-481e-83d4-a27dec61a6d3
                    name: srv1
                    sources:
                      - path: srv1
                        type: Directory
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                    lastSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/simpleBackupCopyJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Immediate Backup Copy Jobs
      description: Returns a collection resource representation of all immediate backup copy jobs.
      operationId: GetBackupServerSimpleBackupCopyJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerSimpleBackupCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerSimpleBackupCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: cf5fcd3e-6750-62bf-8365-4dbd6cff3611
                    targetRepositoryUid: 3a9cdc2f-487c-4999-8a20-840716f796c7
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: true
                    rpoOptionsValue: 1
                    rpoOptionsUnit: Days
                    _embedded:
                      backupServerJob:
                        instanceUid: cf5fcd3e-6750-62bf-8365-4dbd6cff3611
                        originalUid: ed803be7-94d3-48db-acdf-e1144fdc8d5d
                        name: BackupCopyJob
                        description: Created by Powershell at 7/17/2024 6:45:20 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:45:21.0800000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: None
                        type: SimpleBackupCopy
                        lastRun: '2024-07-18T03:45:21.0800000+02:00'
                        lastEndTime: 
                        lastDuration: 0
                        processingRate: 0
                        avgDuration: 0
                        transferredData: 0
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: false
                        scheduleType: Daily
                        failureMessage: 
                        targetType: Local
                        destination: LocalRepo
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: 85f322a3-1738-6d77-9a82-cd72e43c4a56
                    targetRepositoryUid: 3a9cdc2f-487c-4999-8a20-840716f796c7
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: true
                    rpoOptionsValue: 1
                    rpoOptionsUnit: Days
                    _embedded:
                      backupServerJob:
                        instanceUid: 85f322a3-1738-6d77-9a82-cd72e43c4a56
                        originalUid: f792249b-e7c2-4abf-b2af-6880236508ad
                        name: BackupCopyJob2
                        description: Created by Powershell at 7/17/2024 6:45:30 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:45:31.2530000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: None
                        type: SimpleBackupCopy
                        lastRun: '2024-07-18T03:45:31.2530000+02:00'
                        lastEndTime: 
                        lastDuration: 0
                        processingRate: 0
                        avgDuration: 0
                        transferredData: 0
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: false
                        scheduleType: Continuously
                        failureMessage: 
                        targetType: Local
                        destination: LocalRepo
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: 05f8f9ed-1642-6a64-969d-e0ceed4c63d8
                    targetRepositoryUid: 5adf198e-135d-488f-ba6e-472a418e5337
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: true
                    rpoOptionsValue: 1
                    rpoOptionsUnit: Days
                    _embedded:
                      backupServerJob:
                        instanceUid: 05f8f9ed-1642-6a64-969d-e0ceed4c63d8
                        originalUid: e4029275-5855-4a4f-bd1e-368e950d852f
                        name: BackupCopyJob3
                        description: Created by Powershell at 7/17/2024 6:42:22 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:42:22.9530000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: Success
                        type: SimpleBackupCopy
                        lastRun: '2024-07-18T07:00:06.2430000+02:00'
                        lastEndTime: '2024-07-18T07:01:28.9270000+02:00'
                        lastDuration: 85
                        processingRate: 0
                        avgDuration: 85
                        transferredData: 0
                        backupChainSize: 1646592
                        bottleneck: None
                        isEnabled: true
                        scheduleType: Daily
                        failureMessage: 
                        targetType: Local
                        destination: LocalRepo
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: d6557c1c-da01-673c-95ac-db3066c118e9
                    targetRepositoryUid: 5adf198e-135d-488f-ba6e-472a418e5337
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: true
                    rpoOptionsValue: 1
                    rpoOptionsUnit: Days
                    _embedded:
                      backupServerJob:
                        instanceUid: d6557c1c-da01-673c-95ac-db3066c118e9
                        originalUid: ef850637-c296-46d5-9561-ebc83c302771
                        name: BackupCopyJob4
                        description: Created by Powershell at 7/17/2024 6:35:17 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:35:18.2400000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: Enabling
                        type: SimpleBackupCopy
                        lastRun: '2024-07-18T03:35:18.2700000+02:00'
                        lastEndTime: 
                        lastDuration: 0
                        processingRate: 0
                        avgDuration: 0
                        transferredData: 0
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: false
                        scheduleType: Continuously
                        failureMessage: 
                        targetType: Local
                        destination: LocalRepo
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/simpleBackupCopyJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get Immediate Backup Copy Job
      description: Returns a resource representation of an immediate backup copy job with the specified UID.
      operationId: GetBackupServerSimpleBackupCopyJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerSimpleBackupCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/simpleBackupCopyJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Immediate Backup Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of all immediate backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerSimpleBackupCopyJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerSimpleBackupCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerSimpleBackupCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 05f8f9ed-1642-6a64-969d-e0ceed4c63d8
                    targetRepositoryUid: 5adf198e-135d-488f-ba6e-472a418e5337
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: true
                    rpoOptionsValue: 1
                    rpoOptionsUnit: Days
                    _embedded:
                      backupServerJob:
                        instanceUid: 05f8f9ed-1642-6a64-969d-e0ceed4c63d8
                        originalUid: e4029275-5855-4a4f-bd1e-368e950d852f
                        name: autoBackupCopyJob
                        description: Created by Powershell at 7/17/2024 6:42:22 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:42:22.9530000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: Success
                        type: SimpleBackupCopy
                        lastRun: '2024-07-18T07:00:06.2430000+02:00'
                        lastEndTime: '2024-07-18T07:01:28.9270000+02:00'
                        lastDuration: 85
                        processingRate: 0
                        avgDuration: 85
                        transferredData: 0
                        backupChainSize: 1646592
                        bottleneck: None
                        isEnabled: true
                        scheduleType: Daily
                        failureMessage: 
                        targetType: Local
                        destination: LocalRepo
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: d6557c1c-da01-673c-95ac-db3066c118e9
                    targetRepositoryUid: 5adf198e-135d-488f-ba6e-472a418e5337
                    targetWanAcceleratorUid: 
                    sourceWanAcceleratorUid: 
                    weeklyRestorePointsToKeep: 1
                    monthlyRestorePointsToKeep: 1
                    yearlyRestorePointsToKeep: 1
                    retentionPolicyType: Simple
                    isRpoOptionsEnabled: true
                    rpoOptionsValue: 1
                    rpoOptionsUnit: Days
                    _embedded:
                      backupServerJob:
                        instanceUid: d6557c1c-da01-673c-95ac-db3066c118e9
                        originalUid: ef850637-c296-46d5-9561-ebc83c302771
                        name: BackupCopyJob2
                        description: Created by Powershell at 7/17/2024 6:35:17 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:35:18.2400000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: Enabling
                        type: SimpleBackupCopy
                        lastRun: '2024-07-18T03:35:18.2700000+02:00'
                        lastEndTime: 
                        lastDuration: 0
                        processingRate: 0
                        avgDuration: 0
                        transferredData: 0
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: false
                        scheduleType: Continuously
                        failureMessage: 
                        targetType: Local
                        destination: LocalRepo
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/simpleBackupCopyJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Immediate Backup Copy Jobs
      description: Returns a collection resource representation of all immediate backup copy job objects.
      operationId: GetBackupServerSimpleBackupCopyJobsLinkedJobObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 25fd457b-04ae-4c33-aa53-a9d98d24cc52
                    linkedJobUid: 71a4ba79-2f99-4835-abbe-16ea40554272
                  - jobUid: 12ed0762-7d9d-45cf-ab57-9dc5329a8559
                    linkedJobUid: 71a4ba79-2f99-4835-abbe-16ea40554272
                  - jobUid: d55b7919-c77f-4a4c-954c-8e9ffc705630
                    linkedJobUid: eb5f436e-c6ef-4d57-b4ce-02d82fc7ccb0
                  - jobUid: 3db16281-8f6c-4a67-8998-afde8eecb970
                    linkedJobUid: eb5f436e-c6ef-4d57-b4ce-02d82fc7ccb0
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/simpleBackupCopyJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Immediate Backup Copy Job
      description: Returns a collection resource representation of all objects of an immediate backup copy job with the specified UID.
      operationId: GetBackupServerSimpleBackupCopyJobLinkedJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 25fd457b-04ae-4c33-aa53-a9d98d24cc52
                    linkedJobUid: 71a4ba79-2f99-4835-abbe-16ea40554272
                  - jobUid: 12ed0762-7d9d-45cf-ab57-9dc5329a8559
                    linkedJobUid: 71a4ba79-2f99-4835-abbe-16ea40554272
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/simpleBackupCopyJobs/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Immediate Backup Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of all objects of immediate backup copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerSimpleBackupCopyJobsLinkedJobObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: d55b7919-c77f-4a4c-954c-8e9ffc705630
                    linkedJobUid: eb5f436e-c6ef-4d57-b4ce-02d82fc7ccb0
                  - jobUid: 3db16281-8f6c-4a67-8998-afde8eecb970
                    linkedJobUid: eb5f436e-c6ef-4d57-b4ce-02d82fc7ccb0
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/vmCopyJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All VM Copy Jobs
      description: Returns a collection resource representation of all VM copy jobs.
      operationId: GetBackupServerVmCopyJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerVmCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVmCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: eb7bcf75-3d56-64d7-8ae2-471d2f8ac49d
                    targetRepositoryUid: 3a9cdc2f-487c-4999-8a20-840716f796c7
                    _embedded:
                      backupServerJob:
                        instanceUid: eb7bcf75-3d56-64d7-8ae2-471d2f8ac49d
                        originalUid: 755b885c-c353-4908-b96c-21cae9c86856
                        name: VMCopyJob
                        description: Created by Powershell at 7/17/2024 6:47:45 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:47:45.3100000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: None
                        type: CopyVm
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: LocalRepo
                        retentionLimit: 7
                        retentionLimitType: RestorePoints
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: a0dd6009-816b-6d95-a7cb-c31741680bf0
                    targetRepositoryUid: 5adf198e-135d-488f-ba6e-472a418e5337
                    _embedded:
                      backupServerJob:
                        instanceUid: a0dd6009-816b-6d95-a7cb-c31741680bf0
                        originalUid: 5db6d571-b97b-4c84-ae72-9f0d5baa8022
                        name: VMCopyJob2
                        description: Created by Powershell at 7/17/2024 6:41:45 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:41:45.2530000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: CopyVm
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: LocalRepo
                        retentionLimit: 7
                        retentionLimitType: RestorePoints
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/vmCopyJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get VM Copy Job
      description: Returns a resource representation of a VM copy job with the specified UID.
      operationId: GetBackupServerVmCopyJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerVmCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/vmCopyJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All VM Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of all VM copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerVmCopyJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerVmCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVmCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: a0dd6009-816b-6d95-a7cb-c31741680bf0
                    targetRepositoryUid: 5adf198e-135d-488f-ba6e-472a418e5337
                    _embedded:
                      backupServerJob:
                        instanceUid: a0dd6009-816b-6d95-a7cb-c31741680bf0
                        originalUid: 5db6d571-b97b-4c84-ae72-9f0d5baa8022
                        name: VMCopyJob
                        description: Created by Powershell at 7/17/2024 6:41:45 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:41:45.2530000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: CopyVm
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: autoLocalRepo
                        retentionLimit: 7
                        retentionLimitType: RestorePoints
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/fileCopyJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All File Copy Jobs
      description: Returns a collection resource representation of all file copy jobs.
      operationId: GetBackupServerFileCopyJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerFileCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 462bbf54-ba9d-6503-b044-9147b96e4f10
                    targetHostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    targetPath: C:\ProgramData
                    sourceSize: 
                    _embedded:
                      backupServerJob:
                        instanceUid: 462bbf54-ba9d-6503-b044-9147b96e4f10
                        originalUid: bab51c90-c5fd-42ee-95fd-dbc5bbecefbe
                        name: FileCopyJob
                        description: Created by Powershell at 7/17/2024 6:47:34 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:47:36.4970000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: None
                        type: CopyFile
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: '[R2VBR] C:\ProgramData'
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: e424a479-9d44-6467-a3e2-5f8a684c55a8
                    targetHostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    targetPath: C:\ProgramData
                    sourceSize: 
                    _embedded:
                      backupServerJob:
                        instanceUid: e424a479-9d44-6467-a3e2-5f8a684c55a8
                        originalUid: 59779e5a-331a-4635-8174-c5c0b604d410
                        name: FileCopyJob2
                        description: Created by Powershell at 7/17/2024 6:41:35 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:41:36.8000000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: CopyFile
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: '[R2SECONDVBR] C:\ProgramData'
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/fileCopyJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get File Copy Job
      description: Returns a resource representation of a file copy job with the specified UID.
      operationId: GetBackupServerFileCopyJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerFileCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/fileCopyJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All File Copy Jobs Configured on Backup Server
      description: Returns a collection resource representation of all file copy jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerFileCopyJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerFileCopyJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileCopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e424a479-9d44-6467-a3e2-5f8a684c55a8
                    targetHostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    targetPath: C:\ProgramData
                    sourceSize: 
                    _embedded:
                      backupServerJob:
                        instanceUid: e424a479-9d44-6467-a3e2-5f8a684c55a8
                        originalUid: 59779e5a-331a-4635-8174-c5c0b604d410
                        name: FileCopyJob
                        description: Created by Powershell at 7/17/2024 6:41:35 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:41:36.8000000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: CopyFile
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: '[R2SECONDVBR] C:\ProgramData'
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: 462bbf54-ba9d-6503-b044-9147b96e4f10
                    targetHostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    targetPath: C:\ProgramData
                    sourceSize: 
                    _embedded:
                      backupServerJob:
                        instanceUid: 462bbf54-ba9d-6503-b044-9147b96e4f10
                        originalUid: bab51c90-c5fd-42ee-95fd-dbc5bbecefbe
                        name: FileCopyJob2
                        description: Created by Powershell at 7/17/2024 6:47:34 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:47:36.4970000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: None
                        type: CopyFile
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: '[R2VBR] C:\ProgramData'
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/fileTapeJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All File to Tape Jobs
      description: Returns a collection resource representation of all file to tape jobs.
      operationId: GetBackupServerFileTapeJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerFileTapeJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileTapeJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: f9d7d65e-0b98-6bef-8a49-1680eece45ba
                    fullMediaPoolUid: 57b3d88a-6f17-47ad-8aed-0f76741e56bd
                    incrementalMediaPoolUid: 57b3d88a-6f17-47ad-8aed-0f76741e56bd
                    _embedded:
                      backupServerJob:
                        instanceUid: f9d7d65e-0b98-6bef-8a49-1680eece45ba
                        originalUid: db38a055-d56f-4283-a040-80ef18361785
                        name: FileToTapeJob
                        description: Created by Powershell at 7/17/2024 6:46:24 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:46:24.7500000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: None
                        type: FileToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Media Pool 1
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: e54e4fd4-b924-6d2b-931d-9feeb6ee5790
                    fullMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    incrementalMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    _embedded:
                      backupServerJob:
                        instanceUid: e54e4fd4-b924-6d2b-931d-9feeb6ee5790
                        originalUid: 9e161001-993b-412f-b21f-6058ec34da50
                        name: FileToTapeJob2
                        description: Created by Powershell at 7/17/2024 6:39:58 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:39:58.9430000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: FileToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: MediaPool
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/fileTapeJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get File to Tape Job
      description: Returns a resource representation of a file to tape job with the specified UID.
      operationId: GetBackupServerFileTapeJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerFileTapeJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/fileTapeJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All File to Tape Jobs Configured on Backup Server
      description: Returns a collection resource representation of all file to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerFileTapeJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerFileTapeJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileTapeJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: f9d7d65e-0b98-6bef-8a49-1680eece45ba
                    fullMediaPoolUid: 57b3d88a-6f17-47ad-8aed-0f76741e56bd
                    incrementalMediaPoolUid: 57b3d88a-6f17-47ad-8aed-0f76741e56bd
                    _embedded:
                      backupServerJob:
                        instanceUid: f9d7d65e-0b98-6bef-8a49-1680eece45ba
                        originalUid: db38a055-d56f-4283-a040-80ef18361785
                        name: FileToTapeJob
                        description: Created by Powershell at 7/17/2024 6:46:24 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:46:24.7500000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: None
                        type: FileToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Media Pool 1
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: e54e4fd4-b924-6d2b-931d-9feeb6ee5790
                    fullMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    incrementalMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    _embedded:
                      backupServerJob:
                        instanceUid: e54e4fd4-b924-6d2b-931d-9feeb6ee5790
                        originalUid: 9e161001-993b-412f-b21f-6058ec34da50
                        name: FileToTapeJob2
                        description: Created by Powershell at 7/17/2024 6:39:58 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:39:58.9430000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: FileToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: MediaPool
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/fileTapeJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of File to Tape Jobs
      description: Returns a collection resource representation of all file to tape job objects.
      operationId: GetBackupServerFileTapeJobsObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileTapeJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: f9d7d65e-0b98-6bef-8a49-1680eece45ba
                    hostName: r2vbr.tech.local
                    sources:
                      - path: C:\Setup
                        type: Directory
                    lastSession: 
                  - jobUid: e54e4fd4-b924-6d2b-931d-9feeb6ee5790
                    hostName: r2SecondVBR.tech.local
                    sources:
                      - path: C:\Setup
                        type: Directory
                    lastSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/fileTapeJobs/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of File to Tape Jobs Configured on Backup Server
      description: Returns a collection resource representation of all objects of file to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerFileTapeJobsObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileTapeJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: e54e4fd4-b924-6d2b-931d-9feeb6ee5790
                    hostName: r2SecondVBR.tech.local
                    sources:
                      - path: C:\Setup
                        type: Directory
                    lastSession: 
                  - jobUid: f9d7d65e-0b98-6bef-8a49-1680eece45ba
                    hostName: r2vbr.tech.local
                    sources:
                      - path: C:\Setup
                        type: Directory
                    lastSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/fileTapeJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of File to Tape Job
      description: Returns a collection resource representation of all objects of a file to tape job with the specified UID.
      operationId: GetBackupServerFileTapeJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerFileTapeJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: e54e4fd4-b924-6d2b-931d-9feeb6ee5790
                    hostName: r2SecondVBR.tech.local
                    sources:
                      - path: C:\Setup
                        type: Directory
                    lastSession: 
                  - jobUid: e54e4fd4-b924-6d2b-931d-9feeb6ee5790
                    hostName: r2vbr.tech.local
                    sources:
                      - path: C:\Setup
                        type: Directory
                    lastSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/backupTapeJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Backup to Tape Jobs
      description: Returns a collection resource representation of all backup to tape jobs.
      operationId: GetBackupServerBackupTapeJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerBackupTapeJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerBackupTapeJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: d77b5a73-9ac4-6b75-897d-49dedc1dd210
                    fullMediaPoolUid: 57b3d88a-6f17-47ad-8aed-0f76741e56bd
                    incrementalMediaPoolUid: 57b3d88a-6f17-47ad-8aed-0f76741e56bd
                    isGfsEnabled: false
                    _embedded:
                      backupServerJob:
                        instanceUid: d77b5a73-9ac4-6b75-897d-49dedc1dd210
                        originalUid: a0177126-af0a-49a9-92f2-ec91f319366c
                        name: RepoToTapeJob
                        description: Simple
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:46:02.1570000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: None
                        type: BackupToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Media Pool 1
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: b06b0627-3dee-6089-a0bc-79e5f9ce1c4e
                    fullMediaPoolUid: 57b3d88a-6f17-47ad-8aed-0f76741e56bd
                    incrementalMediaPoolUid: 57b3d88a-6f17-47ad-8aed-0f76741e56bd
                    isGfsEnabled: false
                    _embedded:
                      backupServerJob:
                        instanceUid: b06b0627-3dee-6089-a0bc-79e5f9ce1c4e
                        originalUid: b3cf55b9-d40a-4f02-8b13-22a4563915d0
                        name: BackupToTapeJob
                        description: Simple
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T03:45:52.0330000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: None
                        type: BackupToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Media Pool 1
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: 4e1faa3c-653e-67ba-a580-5829a6d247dd
                    fullMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    incrementalMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    isGfsEnabled: false
                    _embedded:
                      backupServerJob:
                        instanceUid: 4e1faa3c-653e-67ba-a580-5829a6d247dd
                        originalUid: 70d2ba5a-74c0-40c4-8eee-70600290fa3c
                        name: BackupToTapeJob2
                        description: Simple
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:39:20.7730000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: BackupToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: MediaPool
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: b6b692ba-6e85-6b9c-a3d8-c79fc5a3d00a
                    fullMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    incrementalMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    isGfsEnabled: false
                    _embedded:
                      backupServerJob:
                        instanceUid: b6b692ba-6e85-6b9c-a3d8-c79fc5a3d00a
                        originalUid: df4852ca-964f-4c4a-99d7-bf0d7842e938
                        name: RepoToTapeJob2
                        description: Simple
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:39:30.6170000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: BackupToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: MediaPool
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/backupTapeJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get Backup to Tape Job
      description: Returns a resource representation of a backup to tape job with the specified UID.
      operationId: GetBackupServerBackupTapeJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerBackupTapeJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/backupTapeJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Backup to Tape Jobs Configured on Backup Server
      description: Returns a collection resource representation of all backup to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerBackupTapeJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerBackupTapeJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerBackupTapeJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 4e1faa3c-653e-67ba-a580-5829a6d247dd
                    fullMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    incrementalMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    isGfsEnabled: false
                    _embedded:
                      backupServerJob:
                        instanceUid: 4e1faa3c-653e-67ba-a580-5829a6d247dd
                        originalUid: 70d2ba5a-74c0-40c4-8eee-70600290fa3c
                        name: BackupToTapeJob1
                        description: Simple
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:39:20.7730000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: BackupToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: MediaPool
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: b6b692ba-6e85-6b9c-a3d8-c79fc5a3d00a
                    fullMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    incrementalMediaPoolUid: 4d9ded7a-dbc8-4c94-878d-550f7973b116
                    isGfsEnabled: false
                    _embedded:
                      backupServerJob:
                        instanceUid: b6b692ba-6e85-6b9c-a3d8-c79fc5a3d00a
                        originalUid: df4852ca-964f-4c4a-99d7-bf0d7842e938
                        name: RepoToTapeJob2
                        description: Simple
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:39:30.6170000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: BackupToTape
                        lastRun: 
                        lastEndTime: 
                        lastDuration: 
                        processingRate: 
                        avgDuration: 0
                        transferredData: 
                        backupChainSize: 0
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: MediaPool
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/backupTapeJobs/jobObjects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Job Objects of Backup to Tape Jobs
      description: Returns a collection resource representation of all jobs processed by backup to tape jobs.
      operationId: GetBackupServerBackupTapeJobsLinkedJobObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 1b316c32-76a0-4c2b-b46a-4ea3d89c85b0
                    linkedJobUid: 71a4ba79-2f99-4835-abbe-16ea40554272
                  - jobUid: 8f51b52d-e887-494d-8fbc-f79d2ce01bad
                    linkedJobUid: eb5f436e-c6ef-4d57-b4ce-02d82fc7ccb0
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/backupTapeJobs/jobObjects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Job Objects of Backup to Tape Jobs Configured on Backup Server
      description: Returns a collection resource representation of all jobs that are processed by backup to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerBackupTapeJobsLinkedJobObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 1b316c32-76a0-4c2b-b46a-4ea3d89c85b0
                    linkedJobUid: 71a4ba79-2f99-4835-abbe-16ea40554272
                  - jobUid: 8f51b52d-e887-494d-8fbc-f79d2ce01bad
                    linkedJobUid: eb5f436e-c6ef-4d57-b4ce-02d82fc7ccb0
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/backupTapeJobs/{jobUid}/jobObjects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Job Objects of Backup to Tape Job
      description: Returns a collection resource representation of all jobs processed by a backup to tape job with the specified UID.
      operationId: GetBackupServerBackupTapeJobLinkedJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 1b316c32-76a0-4c2b-b46a-4ea3d89c85b0
                    linkedJobUid: 71a4ba79-2f99-4835-abbe-16ea40554272
                  - jobUid: 1b316c32-76a0-4c2b-b46a-4ea3d89c85b0
                    linkedJobUid: eb5f436e-c6ef-4d57-b4ce-02d82fc7ccb0
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/backupTapeJobs/repositoryObjects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Repository Objects of Backup to Tape Jobs
      description: Returns a collection resource representation of all repositories processed by backup to tape jobs.
      operationId: GetBackupServerBackupTapeJobsLinkedRepositoryObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedRepositoryObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 08e34b45-6571-4d1e-a758-8b467f06d97a
                    linkedRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                  - jobUid: 51af6bac-ce1d-4b2a-9df2-f8ad8a14edb4
                    linkedRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/backupTapeJobs/repositoryObjects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Repository Objects of Backup to Tape Jobs Configured on Backup Server
      description: Returns a collection resource representation of all repositories that are processed by backup to tape jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerBackupTapeJobsLinkedRepositoryObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedRepositoryObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 51af6bac-ce1d-4b2a-9df2-f8ad8a14edb4
                    linkedRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                  - jobUid: 08e34b45-6571-4d1e-a758-8b467f06d97a
                    linkedRepositoryUid: 8f51b52d-e887-494d-8fbc-f79d2ce01bad
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/backupTapeJobs/{jobUid}/repositoryObjects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Repository Objects of Backup to Tape Job
      description: Returns a collection resource representation of all repositories processed by a backup to tape job with the specified UID.
      operationId: GetBackupServerBackupTapeJobLinkedRepositoryObjects
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerJobLinkedRepositoryObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - jobUid: 08e34b45-6571-4d1e-a758-8b467f06d97a
                    linkedRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                  - jobUid: 08e34b45-6571-4d1e-a758-8b467f06d97a
                    linkedJobUid: eb5f436e-c6ef-4d57-b4ce-02d82fc7ccb0
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/agentJobs:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Backup Agent Jobs
      description: Returns a collection resource representation of all backup agent jobs.
      operationId: GetBackupServerAgentJobs
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerAgentJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 848e5e29-d1d3-6d60-bee4-2ccc27cf9e89
                    totalJobsCount: 1
                    successJobsCount: 1
                    destination: Default Backup Repository
                    source:
                      backupMode: File
                      backupUserFolders: false
                      backupOperatingSystem: false
                      fileSystemItems:
                        volumes: 
                        filesAndFolders:
                          - C:\Share
                    jobMode: ManagedByBackupServer
                    osType: Windows
                    licenseType: Server
                    _embedded:
                      backupServerJob:
                        instanceUid: 848e5e29-d1d3-6d60-bee4-2ccc27cf9e89
                        originalUid: 59270020-6d17-4992-a9b2-94eb4851dd4b
                        name: vawJobByVBR
                        description: Created by Powershell at 7/17/2024 7:00:45 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T04:00:46.6530000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: Success
                        type: AgentBackupJob
                        lastRun: '2024-07-18T04:00:51.7330000+02:00'
                        lastEndTime: '2024-07-18T04:03:30.4600000+02:00'
                        lastDuration: 158
                        processingRate: 8394327
                        avgDuration: 
                        transferredData: 83943272
                        backupChainSize: 
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                  - instanceUid: b468fde2-11bf-650d-b995-14bee776bb7c
                    totalJobsCount: 0
                    successJobsCount: 0
                    destination: LocalLinuxRepo
                    source:
                      backupMode: File
                      backupUserFolders: false
                      backupOperatingSystem: false
                      fileSystemItems:
                        volumes: 
                        filesAndFolders:
                          - /tmp/toBackup
                    jobMode: ManagedByBackupServer
                    osType: Linux
                    licenseType: Server
                    _embedded:
                      backupServerJob:
                        instanceUid: b468fde2-11bf-650d-b995-14bee776bb7c
                        originalUid: 37dd91b1-eb7d-4a5f-92a1-ff72d68b78a1
                        name: LinuxBackupJob
                        description: Created by Powershell at 7/17/2024 6:41:58 PM.
                        createdBy: R2SECONDVBR\Administrator
                        creationTime: '2024-07-18T03:41:59.5170000+02:00'
                        backupServerUid: 17b0cf5a-b197-4142-974c-745a761362af
                        locationUid: 5d484944-11c6-4468-9b40-5f4a5851a9c0
                        siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                        organizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        mappedOrganizationUid: e18336ae-e2aa-4254-a7e9-7718d805c3d9
                        status: None
                        type: AgentBackupJob
                        lastRun: '2024-07-18T03:42:01.0000000+02:00'
                        lastEndTime: '2024-07-18T03:42:13.2030000+02:00'
                        lastDuration: 12
                        processingRate: 0
                        avgDuration: 
                        transferredData: 0
                        backupChainSize: 
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: "Nothing to process.\r\nUnable to process r2valVBR.tech.local: backup agent is missing.\r\n"
                        targetType: Local
                        destination: LocalLinuxRepo
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/jobs/agentJobs':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Backup Agent Jobs Configured on Backup Server
      description: Returns a collection resource representation of all backup agent jobs configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerAgentJobsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/BackupServerAgentJobExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 848e5e29-d1d3-6d60-bee4-2ccc27cf9e89
                    totalJobsCount: 1
                    successJobsCount: 1
                    destination: Default Backup Repository
                    source:
                      backupMode: File
                      backupUserFolders: false
                      backupOperatingSystem: false
                      fileSystemItems:
                        volumes: 
                        filesAndFolders:
                          - C:\Share
                    jobMode: ManagedByBackupServer
                    osType: Windows
                    licenseType: Server
                    _embedded:
                      backupServerJob:
                        instanceUid: 848e5e29-d1d3-6d60-bee4-2ccc27cf9e89
                        originalUid: 59270020-6d17-4992-a9b2-94eb4851dd4b
                        name: vawJobByVBR
                        description: Created by Powershell at 7/17/2024 7:00:45 PM.
                        createdBy: R2VBR\Administrator
                        creationTime: '2024-07-18T04:00:46.6530000+02:00'
                        backupServerUid: c44ed101-1989-480a-9668-6cb0868bc176
                        locationUid: 757dd2a9-b65c-483a-823a-fbfa77cb911f
                        siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                        organizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        mappedOrganizationUid: 61204df8-9cd3-4645-b905-3cc298a94386
                        status: Success
                        type: AgentBackupJob
                        lastRun: '2024-07-18T04:00:51.7330000+02:00'
                        lastEndTime: '2024-07-18T04:03:30.4600000+02:00'
                        lastDuration: 158
                        processingRate: 8394327
                        avgDuration: 
                        transferredData: 83943272
                        backupChainSize: 
                        bottleneck: None
                        isEnabled: true
                        scheduleType: NotScheduled
                        failureMessage: 
                        targetType: Local
                        destination: Default Backup Repository
                        retentionLimit: 7
                        retentionLimitType: Days
                        isGfsOptionEnabled: false
                        lastSessionTasks: [ ]
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/agentJobs/{jobUid}':
    get:
      tags:
        - Backup Server Jobs
      summary: Get Backup Agent Job
      description: Returns a resource representation of a backup agent job with the specified UID.
      operationId: GetBackupServerAgentJob
      parameters:
        - name: jobUid
          in: path
          description: Job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupServerAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 848e5e29-d1d3-6d60-bee4-2ccc27cf9e89
                  totalJobsCount: 1
                  successJobsCount: 1
                  destination: Default Backup Repository
                  source:
                    backupMode: File
                    backupUserFolders: false
                    backupOperatingSystem: false
                    fileSystemItems:
                      volumes: 
                      filesAndFolders:
                        - C:\Share
                  jobMode: ManagedByBackupServer
                  osType: Windows
                  licenseType: Server
                  _embedded:
                    backupServerJob: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/jobs/agentJobs/{jobUid}/objects':
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Backup Agent Job
      description: Returns a collection resource representation of all objects of a backup agent job with the specified UID.
      operationId: GetBackupServerAgentJobObjects
      parameters:
        - name: jobUid
          in: path
          description: Backup agent job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerAgentJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 8c7030ea-fc92-4922-a0c7-8c988ba7fb15
                    backupServerUid: 4435485f-2c7d-434a-be30-f5466e612ce6
                    agentUid: dc4f222e-48fa-489f-8d3f-bf439dd7b373
                    jobUid: 755ccce4-9546-48f8-afca-6f3d8f4f46f7
                    computer: lrsws16.tech.local
                    backupStatus: Success
                    lastRun: '2023-11-08T22:00:33.0000000+01:00'
                    lastEndTime: '2023-11-08T22:19:27.4230000+01:00'
                    lastDuration: 1134
                    restorePointsCount: 5
                    osType: Windows
                    failureMessage: ''
                  - instanceUid: 754a4b1d-508d-4006-8dc9-ca0ccac30854
                    backupServerUid: 4435485f-2c7d-434a-be30-f5466e612ce6
                    agentUid: dc4f222e-48fa-489f-8d3f-bf439dd7b373
                    jobUid: 755ccce4-9546-48f8-afca-6f3d8f4f46f7
                    computer: lrsws17.tech.local
                    backupStatus: Success
                    lastRun: '2023-11-08T22:00:28.0000000+01:00'
                    lastEndTime: '2023-11-08T22:17:09.4770000+01:00'
                    lastDuration: 1001
                    restorePointsCount: 5
                    osType: Windows
                    failureMessage: ''
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/jobs/agentJobs/objects:
    get:
      tags:
        - Backup Server Jobs
      summary: Get All Objects of Backup Agent Jobs
      description: Returns a collection resource representation of all backup agent job objects.
      operationId: GetBackupServerAgentJobsObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerAgentJobObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 8c7030ea-fc92-4922-a0c7-8c988ba7fb15
                    backupServerUid: 4435485f-2c7d-434a-be30-f5466e612ce6
                    agentUid: dc4f222e-48fa-489f-8d3f-bf439dd7b373
                    jobUid: 755ccce4-9546-48f8-afca-6f3d8f4f46f7
                    computer: lrsws16.tech.local
                    backupStatus: Success
                    lastRun: '2023-11-08T22:00:33.0000000+01:00'
                    lastEndTime: '2023-11-08T22:19:27.4230000+01:00'
                    lastDuration: 1134
                    restorePointsCount: 5
                    osType: Windows
                    failureMessage: ''
                  - instanceUid: 754a4b1d-508d-4006-8dc9-ca0ccac30854
                    backupServerUid: 4435485f-2c7d-434a-be30-f5466e612ce6
                    agentUid: dc4f222e-48fa-489f-8d3f-bf439dd7b373
                    jobUid: afa26c38-599d-428e-99a6-8e48f1ba6b98
                    computer: lrsws16.tech.local
                    backupStatus: Success
                    lastRun: '2023-11-08T22:00:28.0000000+01:00'
                    lastEndTime: '2023-11-08T22:17:09.4770000+01:00'
                    lastDuration: 1001
                    restorePointsCount: 5
                    osType: Windows
                    failureMessage: ''
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/protectionGroups:
    get:
      tags:
        - Backup Servers
      summary: Get All Protection Groups
      description: Returns a collection resource representation of all protection groups configured on managed Veeam Backup & Replication servers.
      operationId: GetBackupServerAgentProtectionGroups
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerAgentProtectionGroup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 730dc485-84c2-4a9d-86e7-2e35d1d5a0be
                    name: Manually Added
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  - instanceUid: 730dc485-84c2-4a9d-86e7-2e35d1d5a0be
                    name: Manually Added
                    backupServerUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                  - instanceUid: 730dc485-84c2-4a9d-86e7-2e35d1d5a0be
                    name: Manually Added
                    backupServerUid: 0107365a-60f9-422a-832b-485db173d356
                  - instanceUid: 730dc485-84c2-4a9d-86e7-2e35d1d5a0be
                    name: Manually Added
                    backupServerUid: e48b073a-cf2e-42d2-bf3d-3eb8d2c32429
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/protectionGroups':
    get:
      tags:
        - Backup Servers
      summary: Get All Protection Groups Configured on Backup Server
      description: Returns a collection resource representation of all protection groups configured on a managed Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupServerAgentProtectionGroupsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerAgentProtectionGroup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 730dc485-84c2-4a9d-86e7-2e35d1d5a0be
                    name: Manually Added
                    backupServerUid: 0107365a-60f9-422a-832b-485db173d356
                  - instanceUid: 730dc485-84c2-4a9d-86e7-2e35d1d5a0be
                    name: Manually Added
                    backupServerUid: 0107365a-60f9-422a-832b-485db173d356
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/failoverplans:
    get:
      tags:
        - Backup Server Failover Plans
      summary: Get All Failover Plans
      description: Returns a collection resource representation of all failover plans.
      operationId: GetBackupFailoverPlans
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupFailoverPlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7c5a77ac-6931-3c53-db78-eee46dfa64ca
                    originalUid: ed58ab6c-2846-4775-abe1-f1b44e58d677
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    name: CloudFailoverPlan
                    type: Tenant
                    status: Ready
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    objectsCount: 1
                    preFailoverScriptEnabled: false
                    preFailoverCommand: ''
                    postFailoverCommand: ''
                    postFailoverScriptEnabled: false
                  - instanceUid: 5f211358-8dd8-8ef6-9409-53c14e4d93bf
                    originalUid: 2e46894a-2ec7-42e5-b036-bb0f08892f52
                    backupServerUid: 0107365a-60f9-422a-832b-485db173d356
                    name: CloudFailoverPlan
                    type: Tenant
                    status: Ready
                    tenantUid: 5372b589-03f7-4725-b9d0-77fdfd45663d
                    objectsCount: 1
                    preFailoverScriptEnabled: false
                    preFailoverCommand: ''
                    postFailoverCommand: ''
                    postFailoverScriptEnabled: false
                  - instanceUid: c6219755-4027-be2e-2851-8fb87e400dbb
                    originalUid: 2e46894a-2ec7-42e5-b036-bb0f08892f52
                    backupServerUid: e48b073a-cf2e-42d2-bf3d-3eb8d2c32429
                    name: CloudFailoverPlan
                    type: Cloud
                    status: Ready
                    tenantUid: 
                    objectsCount: 1
                    preFailoverScriptEnabled: false
                    preFailoverCommand: ''
                    postFailoverCommand: ''
                    postFailoverScriptEnabled: false
                  - instanceUid: 06b21e21-7161-50a9-b8ae-231cf9951d82
                    originalUid: 99ff2ff5-beb0-40aa-90d5-418f3e7dbe0e
                    backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                    name: FailoverPlan1
                    type: Local
                    status: Ready
                    tenantUid: 
                    objectsCount: 1
                    preFailoverScriptEnabled: false
                    preFailoverCommand: ''
                    postFailoverCommand: ''
                    postFailoverScriptEnabled: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/failoverplans':
    get:
      tags:
        - Backup Server Failover Plans
      summary: Get All Failover Plans Configured on Backup Server
      description: Returns a collection resource representation of all failover plans configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupFailoverPlansByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupFailoverPlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7c5a77ac-6931-3c53-db78-eee46dfa64ca
                    originalUid: ed58ab6c-2846-4775-abe1-f1b44e58d677
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    name: CloudFailoverPlan
                    type: Tenant
                    status: Ready
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    objectsCount: 1
                    preFailoverScriptEnabled: false
                    preFailoverCommand: ''
                    postFailoverCommand: ''
                    postFailoverScriptEnabled: false
                  - instanceUid: 5f211358-8dd8-8ef6-9409-53c14e4d93bf
                    originalUid: 2e46894a-2ec7-42e5-b036-bb0f08892f52
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    name: CloudFailoverPlan
                    type: Tenant
                    status: Ready
                    tenantUid: 5372b589-03f7-4725-b9d0-77fdfd45663d
                    objectsCount: 1
                    preFailoverScriptEnabled: false
                    preFailoverCommand: ''
                    postFailoverCommand: ''
                    postFailoverScriptEnabled: false
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/failoverplans/{planUid}':
    get:
      tags:
        - Backup Server Failover Plans
      summary: Get Failover Plan
      description: Returns a resource representation of a failover plan with the specified UID.
      operationId: GetBackupFailoverPlan
      parameters:
        - name: planUid
          in: path
          description: Failover plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupFailoverPlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 7c5a77ac-6931-3c53-db78-eee46dfa64ca
                  originalUid: ed58ab6c-2846-4775-abe1-f1b44e58d677
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  name: CloudFailoverPlan
                  type: Tenant
                  status: InUndoProgress
                  tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                  objectsCount: 1
                  preFailoverScriptEnabled: false
                  preFailoverCommand: ''
                  postFailoverCommand: ''
                  postFailoverScriptEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Backup Server Failover Plans
      summary: Modify Failover Plan
      description: "Modifies a failover plan with the specified UID.\n> Operation is performed asynchronously and cannot be tracked.\n"
      operationId: PatchBackupFailoverPlan
      parameters:
        - name: planUid
          in: path
          description: Failover plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: r2_SP_pre
                path: /preFailoverCommand
                op: replace
              - value: r2_SP_post
                path: /postFailoverCommand
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupFailoverPlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 06b21e21-7161-50a9-b8ae-231cf9951d82
                  originalUid: 99ff2ff5-beb0-40aa-90d5-418f3e7dbe0e
                  backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                  name: r3FailoverPlan1
                  type: Local
                  status: Ready
                  tenantUid: 
                  objectsCount: 1
                  preFailoverScriptEnabled: false
                  preFailoverCommand: ''
                  postFailoverCommand: ''
                  postFailoverScriptEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BackupFailoverPlan'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/failoverplans/{planUid}/start':
    post:
      tags:
        - Backup Server Failover Plans
      summary: Start Failover Plan
      description: Starts a failover plan with the specified UID. Returns a positive response when the task is added to the internal queue and not when the task is executed.
      operationId: StartBackupFailoverPlan
      parameters:
        - name: planUid
          in: path
          description: Failover plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: dateTime
          in: query
          description: "Backup date and time. Veeam Backup & Replication finds the closest restore point prior to the entered value for each VM and will fail over to it.\n> If you provide a future date, the operation returns an error response.\n"
          schema:
            type: string
            format: date
        - name: test
          in: query
          description: "If set, the failover runs in test mode.\n"
          schema:
            type: boolean
            default: false
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupServers/failoverplans/{planUid}/undo':
    post:
      tags:
        - Backup Server Failover Plans
      summary: Undo Failover Plan
      description: Undoes a failover plan with the specified UID. Returns a positive response when the undo task is added to the internal queue and not when the task is executed.
      operationId: UndoBackupFailoverPlan
      parameters:
        - name: planUid
          in: path
          description: Failover plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupServers/failoverplans/objects:
    get:
      tags:
        - Backup Server Failover Plans
      summary: Get All Objects of Failover Plans
      description: Returns a collection resource representation of VMs included in all failover plans.
      operationId: GetBackupFailoverPlansObjects
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupFailoverPlanObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: a66c3b5b-fa1d-427c-8776-e56588bd082a
                    planUid: 7c5a77ac-6931-3c53-db78-eee46dfa64ca
                    name: ivz10copy2
                    hostName: 
                    folderName: 
                    path: ivz10copy2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    restoreSession: 
                  - instanceUid: 85273382-8a99-4db4-983e-be9cffba46f3
                    planUid: 5f211358-8dd8-8ef6-9409-53c14e4d93bf
                    name: BackupJob2
                    hostName: 
                    folderName: 
                    path: BackupJob2
                    backupServerUid: 0107365a-60f9-422a-832b-485db173d356
                    restoreSession: 
                  - instanceUid: 7f0e7ad2-01d7-4312-a514-8799d9a43318
                    planUid: c6219755-4027-be2e-2851-8fb87e400dbb
                    name: CopyJob2
                    hostName: 
                    folderName: 
                    path: CopyJob2
                    backupServerUid: e48b073a-cf2e-42d2-bf3d-3eb8d2c32429
                    restoreSession: 
                  - instanceUid: 423b64a5-21b6-6599-839c-3ab014344313
                    planUid: 06b21e21-7161-50a9-b8ae-231cf9951d82
                    name: ivz10copy2_localReplica
                    hostName: ''
                    folderName: ''
                    path: moonvc.tech.local\MoonDatacenter\MoonCluster\Main\ivz10copy2_localReplica
                    backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                    restoreSession: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/failoverplans/objects':
    get:
      tags:
        - Backup Server Failover Plans
      summary: Get All Objects of Failover Plans Configured on Backup Server
      description: Returns a collection resource representation of VMs included in all failover plans configured on a Veeam Backup & Replication server with the specified UID.
      operationId: GetBackupFailoverPlansObjectsByServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupFailoverPlanObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e8c59d16-7202-4212-8d4e-7890205c5aa2
                    planUid: 7c5a77ac-6931-3c53-db78-eee46dfa64ca
                    name: ivz10copy2
                    hostName: 
                    folderName: 
                    path: ivz10copy2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    restoreSession: 
                  - instanceUid: 85273382-8a99-4db4-983e-be9cffba46f3
                    planUid: 5f211358-8dd8-8ef6-9409-53c14e4d93bf
                    name: BackupJob2
                    hostName: 
                    folderName: 
                    path: BackupJob2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    restoreSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/failoverplans/{planUid}/objects':
    get:
      tags:
        - Backup Server Failover Plans
      summary: Get All Objects of Failover Plan
      description: Returns a collection resource representation of all VMs included in a failover plan with the specified UID.
      operationId: GetBackupFailoverPlanObjects
      parameters:
        - name: planUid
          in: path
          description: Failover plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupFailoverPlanObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7c5a77ac-6931-3c53-db78-eee46dfa64ca
                    planUid: 7c5a77ac-6931-3c53-db78-eee46dfa64ca
                    name: ivz10copy2
                    hostName: 
                    folderName: 
                    path: ivz10copy2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    restoreSession: 
                  - instanceUid: 85273382-8a99-4db4-983e-be9cffba46f3
                    planUid: 7c5a77ac-6931-3c53-db78-eee46dfa64ca
                    name: BackupJob2
                    hostName: 
                    folderName: 
                    path: BackupJob2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    restoreSession: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupAgents:
    get:
      tags:
        - Backup Agents
      summary: Get All Backup Agents
      description: Returns a collection resource representation of all Veeam backup agents.
      operationId: GetBackupAgents
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    agentPlatform: Windows
                    status: Active
                    managementAgentStatus: Healthy
                    managementAgentUid: 2c37d84b-f4d7-4589-9b02-db81692202e7
                    siteUid: bfa1148c-f3cf-446b-8603-656f2e6e46c4
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: wina1
                    operationMode: UnLicensed
                    guiMode: Unknown
                    platform: Virtual
                    version: 5.0.0.4301
                    versionStatus: OutOfDate
                    activationTime: 
                    managementMode: UnManaged
                    installationType: Full
                    totalJobsCount: 0
                    runningJobsCount: 0
                    successJobsCount: 0
                  - instanceUid: 5bae3b42-31e4-51de-23c3-ff3b18bc8317
                    agentPlatform: Windows
                    status: Active
                    managementAgentStatus: Healthy
                    managementAgentUid: 91db8de3-099a-4d35-9157-dbe48cd7e034
                    siteUid: bfa1148c-f3cf-446b-8603-656f2e6e46c4
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: wina2
                    operationMode: Workstation
                    guiMode: ReadOnly
                    platform: Virtual
                    version: 5.0.0.4301
                    versionStatus: OutOfDate
                    activationTime: '2025-07-24T06:56:53.8743526+02:00'
                    managementMode: ManagedByConsole
                    installationType: Full
                    totalJobsCount: 1
                    runningJobsCount: 0
                    successJobsCount: 0
                  - instanceUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                    agentPlatform: Windows
                    status: Active
                    managementAgentStatus: Healthy
                    managementAgentUid: 308a257e-de98-4a52-8e8e-161a6f2e05ee
                    siteUid: bfa1148c-f3cf-446b-8603-656f2e6e46c4
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: wina3
                    operationMode: Server
                    guiMode: Full
                    platform: Virtual
                    version: 6.3.2.1205
                    versionStatus: UpToDate
                    activationTime: '2025-07-24T05:44:40.9897162+02:00'
                    managementMode: ManagedByConsole
                    installationType: Full
                    totalJobsCount: 4
                    runningJobsCount: 0
                    successJobsCount: 0
                  - instanceUid: 4cf83b42-9bca-bc64-f724-e8ab48aece24
                    agentPlatform: Windows
                    status: Active
                    managementAgentStatus: Healthy
                    managementAgentUid: d3f2989d-4c32-4f57-8dce-3b86b937020c
                    siteUid: e9ac31e5-5377-4f9b-8fbf-1e3d32218ded
                    organizationUid: 052dde7c-fb66-4b68-85b1-df9809c6bde2
                    name: wina4
                    operationMode: UnLicensed
                    guiMode: Unknown
                    platform: Virtual
                    version: 6.2.0.121
                    versionStatus: OutOfDate
                    activationTime: 
                    managementMode: UnManaged
                    installationType: Full
                    totalJobsCount: 0
                    runningJobsCount: 0
                    successJobsCount: 0
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/{backupAgentUid}':
    get:
      tags:
        - Backup Agents
      summary: Get Backup Agent
      description: Returns a resource representation of a Veeam backup agent with the specified UID.
      operationId: GetBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 42165496-893b-4877-4e6f-886e5c0cb873
                  agentPlatform: Mac
                  status: Active
                  managementAgentStatus: Healthy
                  managementAgentUid: c5d88661-9d15-4ef4-b5e1-18aebbbc6277
                  siteUid: 8677af41-fe0a-470f-8943-e6ca1c871a32
                  organizationUid: 0c600981-2136-4999-af1c-69477e79c0b4
                  name: maca1
                  operationMode: Workstation
                  guiMode: Full
                  platform: Virtual
                  version: 2.3.1.1009
                  versionStatus: UpToDate
                  activationTime: '2025-07-24T03:30:48.0510000+02:00'
                  managementMode: ManagedByConsole
                  installationType: Full
                  totalJobsCount: 0
                  runningJobsCount: 0
                  successJobsCount: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Backup Agents
      summary: Modify Backup Agent
      description: Modifies Veeam backup agent with the specified UID.
      operationId: PatchBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: PATCH operation.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Full
                path: /guiMode
                op: add
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  agentPlatform: Windows
                  status: Active
                  managementAgentStatus: Healthy
                  managementAgentUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  siteUid: 6f213654-b538-4695-ac69-aa677e41862e
                  organizationUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  name: srv2
                  operationMode: Server
                  guiMode: Full
                  platform: Virtual
                  version: 6.3.2.1205
                  versionStatus: UpToDate
                  activationTime: '2025-07-24T05:44:40.9897162+02:00'
                  managementMode: ManagedByConsole
                  installationType: Full
                  totalJobsCount: 3
                  runningJobsCount: 0
                  successJobsCount: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BackupAgent'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    delete:
      tags:
        - Backup Agents
      summary: Delete Backup Agent
      description: Deletes Veeam backup agent with the specified UID.
      operationId: DeleteBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/{backupAgentUid}/activate':
    post:
      tags:
        - Backup Agents
      summary: Activate Backup Agent
      description: Changes management mode of a Veeam backup agent with the specified UID to ManagedByConsole.
      operationId: ActivateBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/{backupAgentUid}/deactivate':
    post:
      tags:
        - Backup Agents
      summary: Deactivate Backup Agent
      description: Changes management mode of Veeam backup agent with the specified UID to UnManaged and deletes management agent from the agent computer.
      operationId: DeactivateBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/{backupAgentUid}/restart':
    post:
      tags:
        - Backup Agents
      summary: Restart Backup Agent
      description: Restarts Veeam backup agent with the specified UID. Returns a positive response if the restart task is added to the internal queue and not when the task is executed.
      operationId: RestartBackupAgentService
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/{backupAgentUid}/collect':
    post:
      tags:
        - Backup Agents
      summary: Force Data Collection from Backup Agent
      description: Forces data collection from a Veeam backup agent with the specified UID. Returns a positive response when the management agent receives the data collection task and not when the task is executed.
      operationId: ForceCollectBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/windows:
    get:
      tags:
        - Backup Agents
      summary: Get All Veeam Agents for Microsoft Windows
      description: Returns a collection resource representation of all Veeam backup agents installed on Windows computers.
      operationId: GetWindowsBackupAgents
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WindowsBackupAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    managementAgentUid: 44db72c8-bf6a-4b0c-8ad0-54a303660484
                    cbtDriverStatus: Unknown
                  - instanceUid: 5bae3b42-31e4-51de-23c3-ff3b18bc8317
                    managementAgentUid: a62232a5-0bcd-4c81-b8e5-f6cfe98038a7
                    cbtDriverStatus: NotInstalled
                  - instanceUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                    managementAgentUid: d72c39ea-b1d3-4663-9a71-74a6351af66a
                    cbtDriverStatus: NotInstalled
                  - instanceUid: 4cf83b42-9bca-bc64-f724-e8ab48aece24
                    managementAgentUid: 7dad2e49-5227-4f41-9b56-d028e4e71344
                    cbtDriverStatus: Unknown
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}':
    get:
      tags:
        - Backup Agents
      summary: Get Veeam Agent for Microsoft Windows
      description: Returns a resource representation of a Veeam Agent for Microsoft Windows with the specified UID.
      operationId: GetWindowsBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsBackupAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d3533b42-475c-a193-4c1f-4c08fbff63cb
                  managementAgentUid: d6d4e785-7267-407b-9253-d229d7bfb27d
                  cbtDriverStatus: NotInstalled
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/update':
    post:
      tags:
        - Deployment
      summary: Update Veeam Agent for Microsoft Windows
      description: "Updates Veeam Agent for Microsoft Windows with the specified UID. \n> To track the deployment progress, you can use the `WaitDeploymentTask` operation.\n"
      operationId: UpdateWindowsBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DeploymentInformation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  deployTaskUid: 9ea4433e-c759-48ab-8e56-206381a56dcf
                  deployTaskId: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/installCbtDriver':
    post:
      tags:
        - Backup Agents
      summary: Install CBT Driver
      description: Installs the Veeam CBT driver on a Windows computer that runs Veeam Agent with the specified UID.
      operationId: InstallCbtDriver
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/uninstallCbtDriver':
    post:
      tags:
        - Backup Agents
      summary: Uninstall CBT Driver
      description: Uninstalls the Veeam CBT driver from a Windows computer that runs Veeam Agent with the specified UID.
      operationId: UninstallCbtDriver
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/windows/settings:
    get:
      tags:
        - Backup Agents
      summary: Get All Veeam Agents for Microsoft Windows Settings
      description: Returns a collection resource representation of settings configured for all Veeam backup agents installed on Windows computers.
      operationId: GetBackupAgentsSettings
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupAgentSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - backupAgentUid: 5bae3b42-31e4-51de-23c3-ff3b18bc8317
                    disableScheduledBackups: false
                    disableControlPanelNotification: false
                    disableBackupOverMeteredConnection: true
                    disableScheduleWakeup: false
                    throttleBackupActivity: true
                    restrictVpnConnections: false
                    limitBandwidthConsumption: false
                    bandwidthSpeedLimit: 1
                    bandwidthSpeedLimitUnit: MbytePerSec
                    flrWithoutAdminPrivilegesAllowed: false
                  - backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                    disableScheduledBackups: false
                    disableControlPanelNotification: false
                    disableBackupOverMeteredConnection: true
                    disableScheduleWakeup: false
                    throttleBackupActivity: true
                    restrictVpnConnections: false
                    limitBandwidthConsumption: false
                    bandwidthSpeedLimit: 1
                    bandwidthSpeedLimitUnit: MbitPerSec
                    flrWithoutAdminPrivilegesAllowed: false
                  - backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    disableScheduledBackups: false
                    disableControlPanelNotification: false
                    disableBackupOverMeteredConnection: true
                    disableScheduleWakeup: false
                    throttleBackupActivity: true
                    restrictVpnConnections: false
                    limitBandwidthConsumption: false
                    bandwidthSpeedLimit: 1
                    bandwidthSpeedLimitUnit: MbitPerSec
                    flrWithoutAdminPrivilegesAllowed: false
                  - backupAgentUid: 39713b42-902b-1b9d-ea6e-26f7bf7e4aa7
                    disableScheduledBackups: false
                    disableControlPanelNotification: false
                    disableBackupOverMeteredConnection: true
                    disableScheduleWakeup: false
                    throttleBackupActivity: true
                    restrictVpnConnections: false
                    limitBandwidthConsumption: false
                    bandwidthSpeedLimit: 1
                    bandwidthSpeedLimitUnit: MbytePerSec
                    flrWithoutAdminPrivilegesAllowed: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/settings':
    get:
      tags:
        - Backup Agents
      summary: Get Veeam Agent for Microsoft Windows Settings
      description: Returns a resource representation of settings configured for Veeam Agent for Microsoft Windows with the specified UID.
      operationId: GetBackupAgentSettings
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupAgentSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                  disableScheduledBackups: true
                  disableControlPanelNotification: true
                  disableBackupOverMeteredConnection: true
                  disableScheduleWakeup: false
                  throttleBackupActivity: true
                  restrictVpnConnections: false
                  limitBandwidthConsumption: true
                  bandwidthSpeedLimit: 10
                  bandwidthSpeedLimitUnit: MbytePerSec
                  flrWithoutAdminPrivilegesAllowed: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/BackupAgentSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    put:
      tags:
        - Backup Agents
      summary: Replace Veeam Agent for Microsoft Windows Settings
      description: Replaces settings configured for Veeam Agent for Microsoft Windows with the specified UID.
      operationId: SetBackupAgentSettings
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: New settings.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BackupAgentSettings'
            example:
              backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
              disableScheduledBackups: true
              disableControlPanelNotification: true
              disableBackupOverMeteredConnection: true
              disableScheduleWakeup: false
              throttleBackupActivity: true
              restrictVpnConnections: false
              limitBandwidthConsumption: true
              bandwidthSpeedLimit: 10
              bandwidthSpeedLimitUnit: MbytePerSec
              flrWithoutAdminPrivilegesAllowed: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupAgentSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                  disableScheduledBackups: true
                  disableControlPanelNotification: true
                  disableBackupOverMeteredConnection: true
                  disableScheduleWakeup: false
                  throttleBackupActivity: true
                  restrictVpnConnections: false
                  limitBandwidthConsumption: true
                  bandwidthSpeedLimit: 10
                  bandwidthSpeedLimitUnit: MbytePerSec
                  flrWithoutAdminPrivilegesAllowed: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    patch:
      tags:
        - Backup Agents
      summary: Modify Veeam Agent for Microsoft Windows Settings
      description: Modifies settings configured for Veeam Agent for Microsoft Windows with the specified UID.
      operationId: PatchBackupAgentSettings
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 2
                path: /BandwidthSpeedLimit
                op: replace
              - value: true
                path: /LimitBandwidthConsumption
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupAgentSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                  disableScheduledBackups: false
                  disableControlPanelNotification: false
                  disableBackupOverMeteredConnection: true
                  disableScheduleWakeup: false
                  throttleBackupActivity: true
                  restrictVpnConnections: false
                  limitBandwidthConsumption: true
                  bandwidthSpeedLimit: 2
                  bandwidthSpeedLimitUnit: MbitPerSec
                  flrWithoutAdminPrivilegesAllowed: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/BackupAgentSettings'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/windows/assignedPolicies:
    get:
      tags:
        - Backup Agents
      summary: Get Policies Assigned to All Veeam Agents for Microsoft Windows
      description: Returns a collection resource representation of all backup policies assigned to Veeam Agents for Microsoft Windows.
      operationId: GetAllBackupAgentAssignedPolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupAgentAssignedBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - configUid: 4610eb17-b41c-4cc5-81d1-938ee6d89b7a
                    backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                    backupPolicyUid: 80c6c364-3cf0-4b5f-8270-578ea93f66ad
                    backupPolicyId: 1
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: 
                    assignedBy: '-'
                  - configUid: 441824a4-02cf-4b17-bc3f-310dbfbc8d8d
                    backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                    backupPolicyUid: b7d8a20f-a205-4e98-ae66-c9f414270c9f
                    backupPolicyId: 8
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 1
                    assignedDate: '2025-07-24T06:47:56.4074700+02:00'
                    assignedBy: VSPC1\Administrator
                  - configUid: 4610eb17-b41c-4cc5-81d1-938ee6d89b7a
                    backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    backupPolicyUid: 80c6c364-3cf0-4b5f-8270-578ea93f66ad
                    backupPolicyId: 1
                    status: Applied
                    isCustom: true
                    isOutOfDate: true
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: '2025-07-24T05:23:56.8051899+02:00'
                    assignedBy: '-'
                  - configUid: 441824a4-02cf-4b17-bc3f-310dbfbc8d8d
                    backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    backupPolicyUid: b7d8a20f-a205-4e98-ae66-c9f414270c9f
                    backupPolicyId: 8
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 1
                    assignedDate: '2025-07-24T06:43:58.6926365+02:00'
                    assignedBy: VSPC1\Administrator
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/assignedPolicies':
    get:
      tags:
        - Backup Agents
      summary: Get All Policies Assigned to Veeam Agent for Microsoft Windows
      description: Returns a collection resource representation of all backup policies assigned to Veeam Agent for Microsoft Windows with the specified UID.
      operationId: GetBackupAgentAssignedPolicies
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupAgentAssignedBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - configUid: 4610eb17-b41c-4cc5-81d1-938ee6d89b7a
                    backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    backupPolicyUid: 80c6c364-3cf0-4b5f-8270-578ea93f66ad
                    backupPolicyId: 1
                    status: Applied
                    isCustom: true
                    isOutOfDate: true
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: '2025-07-24T05:23:56.8051899+02:00'
                    assignedBy: '-'
                  - configUid: 441824a4-02cf-4b17-bc3f-310dbfbc8d8d
                    backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    backupPolicyUid: b7d8a20f-a205-4e98-ae66-c9f414270c9f
                    backupPolicyId: 8
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 1
                    assignedDate: '2025-07-24T06:43:58.6926365+02:00'
                    assignedBy: VSPC1\Administrator
                  - configUid: f1477df5-8550-4e77-ab55-aa65d9f325c3
                    backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    backupPolicyUid: 3545c067-4aea-4d97-882a-0e9cc3fe52d6
                    backupPolicyId: 9
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: '2025-07-24T06:46:13.1690037+02:00'
                    assignedBy: VSPC1\Administrator
                  - configUid: 9f3bf058-5f78-401b-8067-9b1ede504759
                    backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    backupPolicyUid: 2e09d39f-56c2-4679-b96b-96fb824012ed
                    backupPolicyId: 2
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: '2025-07-24T07:42:12.4485618+02:00'
                    assignedBy: VSPC1\Administrator
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Backup Agents
      summary: Assign Policy to Veeam Agent for Microsoft Windows
      description: Assigns a backup policy to a Veeam Agent for Microsoft Windows with the specified UID. Returns a positive response when the management agent receives the task and not when the task is executed.
      operationId: AssignPolicyOnBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: policyUid
          in: query
          description: Backup policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/jobs:
    get:
      tags:
        - Backup Agent Jobs
      summary: Get All Veeam Backup Agent Jobs
      description: Returns a collection resource representation of all Veeam backup agent jobs protecting Windows computers.
      operationId: GetBackupAgentJobs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 70c7fc65-6128-675c-b53b-f0c17762e6f6
                    originalUid: bffded0b-7c79-494c-a151-bb200f3fc4f5
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    organizationUid: 2da90254-8fe3-4df5-94c3-b68420fbfe23
                    name: AgentJob1
                    description: Created by VSPC1\Administrator at 7/15/2019 3:12 PM.
                    configUid: e0e29206-2860-49de-974b-781d6c2fedb2
                    systemType: Windows
                    backupPolicyUid: 
                    backupPolicyName: 
                    backupPolicyAssignStatus: 
                    backupPolicyFailureMessage: 
                    status: Failed
                    operationMode: Workstation
                    destination: C:\backups\
                    restorePoints: 2
                    lastRun: '2025-07-27T03:34:05.7160000+02:00'
                    lastEndTime: '2025-07-27T03:35:14.5030000+02:00'
                    lastDuration: 68
                    nextRun: 
                    avgDuration: 68
                    backupMode: File
                    targetType: LocalFolder
                    isEnabled: false
                    scheduleType: Daily
                    scheduleDisplayName: Disabled
                    lastModifiedDate: 
                    lastModifiedBy: 
                    failureMessage: 'Error: Operation was canceled by user WORKGROUP\SYSTEM'
                    backedUpSize: 392183808
                    freeSpace: 79857876992
                  - instanceUid: 7f9a42de-bf49-67c3-8269-c36bfa334585
                    originalUid: 46a3e465-de0c-4452-953f-4e20daaf37f1
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    organizationUid: 2da90254-8fe3-4df5-94c3-b68420fbfe23
                    name: Windows workstation - Personal r2vbr
                    description: This policy processes user profile folder including all user settings and data.
                    configUid: 4610eb17-b41c-4cc5-81d1-938ee6d89b7a
                    systemType: Windows
                    backupPolicyUid: db3fc1fd-e817-4856-82ce-a7d348d88a03
                    backupPolicyName: Windows workstation - Personal files
                    backupPolicyAssignStatus: Assigned
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Workstation
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 
                    backupMode: File
                    targetType: CloudRepository
                    isEnabled: false
                    scheduleType: Daily
                    scheduleDisplayName: Disabled
                    lastModifiedDate: '2025-07-27T02:57:19.6334268+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: 725a706d-b44a-6e57-b004-f0dc8ba3ce3b
                    originalUid: 35b27351-9fde-4216-bc6b-f19683784b24
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    organizationUid: 2da90254-8fe3-4df5-94c3-b68420fbfe23
                    name: Windows server - Entire computer_r2vbr
                    description: 'This policy should be used if you want to create a backup of the entire computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                    configUid: 9f3bf058-5f78-401b-8067-9b1ede504759
                    systemType: Windows
                    backupPolicyUid: aec5f032-be73-48a9-a4bb-908848fe61ff
                    backupPolicyName: Windows server - Entire computer
                    backupPolicyAssignStatus: Assigned
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Server
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 
                    backupMode: EntireComputer
                    targetType: CloudRepository
                    isEnabled: false
                    scheduleType: Daily
                    scheduleDisplayName: Disabled
                    lastModifiedDate: '2025-07-27T02:59:18.3197959+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: 98a2d3ef-6ad9-68bd-b2d9-3d121940e30f
                    originalUid: 5bf80578-ed55-43a3-b866-8919b1cc1ce8
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    organizationUid: 2da90254-8fe3-4df5-94c3-b68420fbfe23
                    name: WServerVolumeCloud_rlab2vbr
                    description: temp description
                    configUid: 37bf043e-a188-4f30-bab8-4efcd5bdaa0d
                    systemType: Windows
                    backupPolicyUid: ab9fc7e7-b809-44b5-a82b-e1ead4d73094
                    backupPolicyName: WServerVolumeCloud
                    backupPolicyAssignStatus: Assigned
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Server
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 
                    backupMode: Volume
                    targetType: CloudRepository
                    isEnabled: false
                    scheduleType: Daily
                    scheduleDisplayName: Disabled
                    lastModifiedDate: '2025-07-27T03:25:46.4736178+02:00'
                    lastModifiedBy: ResellerAdministrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/{backupAgentUid}/jobs/{backupAgentJobUid}/start':
    post:
      tags:
        - Backup Agent Jobs
      summary: Start Veeam Backup Agent Job
      description: Starts a Veeam backup agent job with the specified UID. Returns a positive response when the management agent receives the task and not when the task is executed.
      operationId: StartBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - $ref: '#/components/parameters/backupAgentJobUid_path'
        - $ref: '#/components/parameters/activeFullBackup_query'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/{backupAgentUid}/jobs/{backupAgentJobUid}/stop':
    post:
      tags:
        - Backup Agent Jobs
      summary: Stop Veeam Backup Agent Job
      description: Stops a Veeam backup agent job with the specified UID. Returns a positive response when the management agent receives the task and not when the task is executed.
      operationId: StopBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - $ref: '#/components/parameters/backupAgentJobUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/windows/jobs:
    get:
      tags:
        - Backup Agent Jobs
      summary: Get Jobs for All Veeam Agents for Microsoft Windows
      description: Returns a collection resource representation of all Veeam backup agent jobs protecting Windows computers.
      operationId: GetWindowsBackupAgentJobs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WindowsBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: f5940618-a720-6586-83b2-baabe8005fe0
                    backupAgentUid: 5bae3b42-31e4-51de-23c3-ff3b18bc8317
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: Job
                    description: Created by RESTV3VAW\Administrator at 5/30/2019 4:30 PM.
                    configUid: c0d6c588-40ca-4887-8568-7410fc16f77e
                    backupPolicyUid: 
                    backupPolicyName: 
                    backupPolicyAssignStatus: 
                    backupPolicyFailureMessage: 
                    status: Running
                    operationMode: Workstation
                    destination: C:\1\
                    restorePoints: 8
                    lastRun: '2025-07-24T07:17:06.3830000+02:00'
                    lastEndTime: 
                    lastDuration: 16
                    nextRun: '2025-07-25T00:30:00.0000000+02:00'
                    avgDuration: 68
                    backupMode: File
                    targetType: Local
                    isEnabled: true
                    scheduleType: Daily
                    scheduleEvents: [ ]
                    lastModifiedDate: 
                    lastModifiedBy: '-'
                    failureMessage: 
                    backedUpSize: 3454443520
                    freeSpace: 
                  - instanceUid: 3c7bc054-0135-6d42-825c-7b962d361d94
                    backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: Windows workstation - Personal files_rlab2em
                    description: This policy processes user profile folder including all user settings and data.
                    configUid: 4610eb17-b41c-4cc5-81d1-938ee6d89b7a
                    backupPolicyUid: 80c6c364-3cf0-4b5f-8270-578ea93f66ad
                    backupPolicyName: Windows workstation - Personal files
                    backupPolicyAssignStatus: Assigned
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Workstation
                    destination: restv3t1_rlab2em_Repository
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: '2025-07-24T09:30:00.0000000+02:00'
                    avgDuration: 0
                    backupMode: File
                    targetType: Cloud
                    isEnabled: true
                    scheduleType: Daily
                    scheduleEvents: [ ]
                    lastModifiedDate: 
                    lastModifiedBy: '-'
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: 733ae6ac-6e0c-698d-b76d-2b706201e9a1
                    backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: WServerVolumeCloud_rlab2em
                    description: temp description
                    configUid: 441824a4-02cf-4b17-bc3f-310dbfbc8d8d
                    backupPolicyUid: b7d8a20f-a205-4e98-ae66-c9f414270c9f
                    backupPolicyName: WServerVolumeCloud
                    backupPolicyAssignStatus: Assigned
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Server
                    destination: restv3t1_rlab2em_Repository
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: '2025-07-24T09:30:00.0000000+02:00'
                    avgDuration: 0
                    backupMode: Volume
                    targetType: Cloud
                    isEnabled: true
                    scheduleType: Daily
                    scheduleEvents: [ ]
                    lastModifiedDate: '2025-07-24T06:47:56.4074700+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: e0ed9a64-023f-6a05-af91-dc2700e44ec6
                    backupAgentUid: 07773b42-89fb-7227-9c6a-95e6908f25de
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: ServerEntireCloud_Custom
                    description: patched description
                    configUid: aff367e4-c1be-4931-a4b5-84ad7203f675
                    backupPolicyUid: 
                    backupPolicyName: 
                    backupPolicyAssignStatus: 
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Workstation
                    destination: Cloud Repository default
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: EntireComputer
                    targetType: Cloud
                    isEnabled: true
                    scheduleType: NotScheduled
                    scheduleEvents: [ ]
                    lastModifiedDate: '2025-07-24T06:54:49.4945923+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/jobs':
    get:
      tags:
        - Backup Agent Jobs
      summary: Get All Jobs for Veeam Agent for Microsoft Windows
      description: Returns a collection resource representation of all jobs configured for Veeam backup agent for Microsoft Windows with the specified UID.
      operationId: GetWindowsBackupAgentJobsByAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/WindowsBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: f5940618-a720-6586-83b2-baabe8005fe0
                    backupAgentUid: 5bae3b42-31e4-51de-23c3-ff3b18bc8317
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: Job
                    description: Created by RESTV3VAW\Administrator at 5/30/2019 4:30 PM.
                    configUid: c0d6c588-40ca-4887-8568-7410fc16f77e
                    backupPolicyUid: 
                    backupPolicyName: 
                    backupPolicyAssignStatus: 
                    backupPolicyFailureMessage: 
                    status: Running
                    operationMode: Workstation
                    destination: C:\1\
                    restorePoints: 8
                    lastRun: '2025-07-24T07:17:06.3830000+02:00'
                    lastEndTime: 
                    lastDuration: 16
                    nextRun: '2025-07-25T00:30:00.0000000+02:00'
                    avgDuration: 68
                    backupMode: File
                    targetType: Local
                    isEnabled: true
                    scheduleType: Daily
                    scheduleEvents: [ ]
                    lastModifiedDate: 
                    lastModifiedBy: '-'
                    failureMessage: 
                    backedUpSize: 3454443520
                    freeSpace: 
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid}':
    get:
      tags:
        - Backup Agent Jobs
      summary: Get Veeam Agent for Microsoft Windows Job
      description: Returns a resource representation of a Veeam Agent for Microsoft Windows job with the specified UID.
      operationId: GetWindowsBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: f5940618-a720-6586-83b2-baabe8005fe0
                  backupAgentUid: 5bae3b42-31e4-51de-23c3-ff3b18bc8317
                  organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                  name: Job
                  description: Created by RESTV3VAW\Administrator at 5/30/2019 4:30 PM.
                  configUid: c0d6c588-40ca-4887-8568-7410fc16f77e
                  backupPolicyUid: 
                  backupPolicyName: 
                  backupPolicyAssignStatus: 
                  backupPolicyFailureMessage: 
                  status: Running
                  operationMode: Workstation
                  destination: C:\1\
                  restorePoints: 8
                  lastRun: '2025-07-24T07:17:06.3830000+02:00'
                  lastEndTime: 
                  lastDuration: 16
                  nextRun: '2025-07-25T00:30:00.0000000+02:00'
                  avgDuration: 68
                  backupMode: File
                  targetType: Local
                  isEnabled: true
                  scheduleType: Daily
                  scheduleEvents: [ ]
                  lastModifiedDate: 
                  lastModifiedBy: '-'
                  failureMessage: 
                  backedUpSize: 3454443520
                  freeSpace: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Backup Agent Jobs
      summary: Delete Veeam Agent for Microsoft Windows Job
      description: Deletes a Veeam Agent for Microsoft Windows job with the specified UID. Returns a positive response when the management agent receives the task and not when the task is executed.
      operationId: DeleteWindowsBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Windows_path'
        - name: removeRestorePoints
          in: query
          description: Indicates whether restore points must be removed.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
    patch:
      tags:
        - Backup Agent Jobs
      summary: Modify Veeam Agent for Microsoft Windows Job
      description: Modifies a Veeam Agent for Microsoft Windows job with the specified UID.
      operationId: PatchWindowsBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Running
                path: /status
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  backupAgentUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  organizationUid: 6f213654-b538-4695-ac69-aa677e41862e
                  name: Windows workstation - Personal files - winsrv2
                  description: This policy processes user profile folder including all user settings and data.
                  configUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  backupPolicyUid: b2fb8f33-9675-46d9-a114-6664e1044860
                  backupPolicyName: Windows workstation - Personal files
                  backupPolicyAssignStatus: Custom
                  backupPolicyFailureMessage: 
                  status: Success
                  operationMode: Workstation
                  destination: repo2
                  restorePoints: 8
                  lastRun: '2025-07-29T23:30:01.1770000+02:00'
                  lastEndTime: '2025-07-29T23:38:12.3490000+02:00'
                  lastDuration: 491
                  nextRun: '2025-07-30T23:30:00.0000000+02:00'
                  avgDuration: 5
                  backupMode: File
                  targetType: Cloud
                  isEnabled: true
                  scheduleType: Daily
                  scheduleEvents: [ ]
                  lastModifiedDate: 
                  lastModifiedBy: '-'
                  failureMessage: ''
                  backedUpSize: 2810982400
                  freeSpace: 412699714938
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/WindowsBackupAgentJob'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid}/start':
    post:
      tags:
        - Backup Agent Jobs
      summary: Start Veeam Agent for Microsoft Windows Job
      description: Starts a Veeam Agent for Microsoft Windows job with the specified UID. Returns a positive response when the management agent receives the reboot task and not when the task is executed.
      operationId: StartWindowsBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Windows_path'
        - $ref: '#/components/parameters/activeFullBackup_query'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid}/stop':
    post:
      tags:
        - Backup Agent Jobs
      summary: Stop Veeam Agent for Microsoft Windows Job
      description: Stops a Veeam Agent for Microsoft Windows job with the specified UID. Returns a positive response when the management agent receives the task and not when the task is executed.
      operationId: StopWindowsBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/jobs/{backupAgentJobUid}/configuration':
    get:
      tags:
        - Backup Agent Jobs
      summary: Get Configuration of Job for Veeam Agent for Microsoft Windows
      description: Returns a resource representation of a configuration of the Veeam Agent for Microsoft Windows job with the specified UID.
      operationId: GetWindowsBackupAgentJobConfiguration
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsCustomJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: Windows workstation - Personal files - winsrv2
                  description: This policy processes user profile folder including all user settings and data.
                  operationMode: Workstation
                  cloudRepositoryConnectionSettings:
                    backupResourceUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                    username: vspc\admin
                    password: 
                  jobConfiguration:
                    backupSource:
                      backupMode: FilesFolders
                      computerLevelOptions: 
                      volumeLevelOptions: 
                      fileLevelOptions:
                        includeDirectories: 
                        excludeDirectories: 
                        inclusionMasks: 
                        exclusionMasks: 
                        osfilesIncluded: false
                        excludeOneDriveFolders: false
                        personalFilesIncluded: true
                        personalFilesAdvancedSettings:
                          inclusions:
                            - Desktop
                            - Documents
                            - Pictures
                            - Video
                            - Music
                            - Favorites
                            - Downloads
                            - ApplicationData
                            - OtherFilesAndFolders
                          excludeNetworkAccount: false
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      cloudRepository: 
                    serverModeSettings: 
                    workstationModeSettings:
                      scheduleSetting:
                        periodicalScheduleEnabled: true
                        periodicalScheduleSettings:
                          dailyScheduleSettings:
                            time: '2025-09-09T00:30:00.0000000+02:00'
                            dailyMode: Everyday
                            specificDays: 
                          shutdownAction: BackupOncePoweredOn
                          finalizingAction: KeepRunning
                        eventTriggerSettings:
                          backupOnLock: false
                          backupOnLogOff: false
                          backupOnTargetConnection: false
                          ejectTargetOnBackupComplete: false
                          backupNotOften: 2
                          notOftenTimeUnit: Hours
                      retentionSettings:
                        retentionDays: 7
                    advancedSettings:
                      backupStorage:
                        compressionLevel: Optimal
                        storageOptimization: Lan512KB
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                      scheduleSettings:
                        syntheticFullOnDays: 
                        activeFullSettings: 
                      maintenanceSettings:
                        backupHealthCheckSettings: 
                        fullBackupFileMaintenanceSettings:
                          enableDeletedFilesRetention: false
                          removeDeletedItemsDataAfter: 30
                          defragmentAndCompactFullBackupFileSettings: 
                        fullHealthCheck: false
                    gfsRetentionSettings: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/WindowsCustomJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Backup Agent Jobs
      summary: Modify Configuration of Veeam Agent for Microsoft Windows Job
      description: Modifies a configuration of a Veeam Agent for Microsoft Windows job with the specified UID.
      operationId: PatchWindowsBackupAgentJobConfiguration
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: FilesFolders
                path: /jobconfiguration/backupSource/backupMode
                op: add
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsCustomJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: Windows workstation - Personal files - winsrv2
                  description: This policy processes user profile folder including all user settings and data.
                  operationMode: Workstation
                  cloudRepositoryConnectionSettings:
                    backupResourceUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                    username: vspc\admin
                    password: 
                  jobConfiguration:
                    backupSource:
                      backupMode: FilesFolders
                      computerLevelOptions: 
                      volumeLevelOptions: 
                      fileLevelOptions:
                        includeDirectories: 
                        excludeDirectories: 
                        inclusionMasks: 
                        exclusionMasks: 
                        osfilesIncluded: false
                        excludeOneDriveFolders: false
                        personalFilesIncluded: true
                        personalFilesAdvancedSettings:
                          inclusions:
                            - Desktop
                            - Documents
                            - Pictures
                            - Video
                            - Music
                            - Favorites
                            - Downloads
                            - ApplicationData
                            - OtherFilesAndFolders
                          excludeNetworkAccount: false
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      cloudRepository: 
                    serverModeSettings: 
                    workstationModeSettings:
                      scheduleSetting:
                        periodicalScheduleEnabled: true
                        periodicalScheduleSettings:
                          dailyScheduleSettings:
                            time: '2025-09-09T00:30:00.0000000+02:00'
                            dailyMode: Everyday
                            specificDays: 
                          shutdownAction: BackupOncePoweredOn
                          finalizingAction: KeepRunning
                        eventTriggerSettings:
                          backupOnLock: false
                          backupOnLogOff: false
                          backupOnTargetConnection: false
                          ejectTargetOnBackupComplete: false
                          backupNotOften: 2
                          notOftenTimeUnit: Hours
                      retentionSettings:
                        retentionDays: 7
                    advancedSettings:
                      backupStorage:
                        compressionLevel: Optimal
                        storageOptimization: Lan512KB
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                      scheduleSettings:
                        syntheticFullOnDays: 
                        activeFullSettings: 
                      maintenanceSettings:
                        backupHealthCheckSettings: 
                        fullBackupFileMaintenanceSettings:
                          enableDeletedFilesRetention: false
                          removeDeletedItemsDataAfter: 30
                          defragmentAndCompactFullBackupFileSettings: 
                        fullHealthCheck: false
                    gfsRetentionSettings: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/WindowsCustomJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/windows/{backupAgentUid}/jobs/configuration':
    post:
      tags:
        - Backup Agent Jobs
      summary: Create Configuration of Veeam Agent for Microsoft Windows Job
      description: Creates a configuration of a Veeam backup agent job protecting a Windows computer with the specified UID.
      operationId: CreateWindowsBackupAgentJobConfiguration
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Windows_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Configuration of a Veeam Agent for Microsoft Windows job
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WindowsCustomJobConfiguration'
            example:
              name: Windows workstation - Personal files - winsrv2
              description: This policy processes user profile folder including all user settings and data.
              operationMode: Workstation
              cloudRepositoryConnectionSettings:
                backupResourceUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                username: vspc\admin
                password: 
              jobConfiguration:
                backupSource:
                  backupMode: FilesFolders
                  computerLevelOptions: 
                  volumeLevelOptions: 
                  fileLevelOptions:
                    includeDirectories: 
                    excludeDirectories: 
                    inclusionMasks: 
                    exclusionMasks: 
                    osfilesIncluded: false
                    excludeOneDriveFolders: false
                    personalFilesIncluded: true
                    personalFilesAdvancedSettings:
                      inclusions:
                        - Desktop
                        - Documents
                        - Pictures
                        - Video
                        - Music
                        - Favorites
                        - Downloads
                        - ApplicationData
                        - OtherFilesAndFolders
                      excludeNetworkAccount: false
                backupTarget:
                  targetType: CloudRepository
                  localPath: 
                  sharedFolder: 
                  backupRepository: 
                  cloudRepository: 
                serverModeSettings: 
                workstationModeSettings:
                  scheduleSetting:
                    periodicalScheduleEnabled: true
                    periodicalScheduleSettings:
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      shutdownAction: BackupOncePoweredOn
                      finalizingAction: KeepRunning
                    eventTriggerSettings:
                      backupOnLock: false
                      backupOnLogOff: false
                      backupOnTargetConnection: false
                      ejectTargetOnBackupComplete: false
                      backupNotOften: 2
                      notOftenTimeUnit: Hours
                  retentionSettings:
                    retentionDays: 7
                advancedSettings:
                  backupStorage:
                    compressionLevel: Optimal
                    storageOptimization: Lan512KB
                    encryptionEnabled: false
                    password: 
                    passwordHint: 
                  scheduleSettings:
                    syntheticFullOnDays: 
                    activeFullSettings: 
                  maintenanceSettings:
                    backupHealthCheckSettings: 
                    fullBackupFileMaintenanceSettings:
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                      defragmentAndCompactFullBackupFileSettings: 
                    fullHealthCheck: false
                gfsRetentionSettings: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/WindowsCustomJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: Windows workstation - Personal files - winsrv2
                  description: This policy processes user profile folder including all user settings and data.
                  operationMode: Workstation
                  cloudRepositoryConnectionSettings:
                    backupResourceUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                    username: vspc\admin
                    password: 
                  jobConfiguration:
                    backupSource:
                      backupMode: FilesFolders
                      computerLevelOptions: 
                      volumeLevelOptions: 
                      fileLevelOptions:
                        includeDirectories: 
                        excludeDirectories: 
                        inclusionMasks: 
                        exclusionMasks: 
                        osfilesIncluded: false
                        excludeOneDriveFolders: false
                        personalFilesIncluded: true
                        personalFilesAdvancedSettings:
                          inclusions:
                            - Desktop
                            - Documents
                            - Pictures
                            - Video
                            - Music
                            - Favorites
                            - Downloads
                            - ApplicationData
                            - OtherFilesAndFolders
                          excludeNetworkAccount: false
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      cloudRepository: 
                    serverModeSettings: 
                    workstationModeSettings:
                      scheduleSetting:
                        periodicalScheduleEnabled: true
                        periodicalScheduleSettings:
                          dailyScheduleSettings:
                            time: '2025-09-09T00:30:00.0000000+02:00'
                            dailyMode: Everyday
                            specificDays: 
                          shutdownAction: BackupOncePoweredOn
                          finalizingAction: KeepRunning
                        eventTriggerSettings:
                          backupOnLock: false
                          backupOnLogOff: false
                          backupOnTargetConnection: false
                          ejectTargetOnBackupComplete: false
                          backupNotOften: 2
                          notOftenTimeUnit: Hours
                      retentionSettings:
                        retentionDays: 7
                    advancedSettings:
                      backupStorage:
                        compressionLevel: Optimal
                        storageOptimization: Lan512KB
                        encryptionEnabled: false
                        password: 
                        passwordHint: 
                      scheduleSettings:
                        syntheticFullOnDays: 
                        activeFullSettings: 
                      maintenanceSettings:
                        backupHealthCheckSettings: 
                        fullBackupFileMaintenanceSettings:
                          enableDeletedFilesRetention: false
                          removeDeletedItemsDataAfter: 30
                          defragmentAndCompactFullBackupFileSettings: 
                        fullHealthCheck: false
                    gfsRetentionSettings: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/linux:
    get:
      tags:
        - Backup Agents
      summary: Get All Veeam Agents for Linux
      description: Returns a collection resource representation of all Veeam Agents for Linux.
      operationId: GetLinuxBackupAgents
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LinuxBackupAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    managementAgentUid: 1895de19-ba39-4d40-a834-348204e934fb
                  - instanceUid: 4211bca5-448b-b58b-d05d-e4e39b9ef349
                    managementAgentUid: a641b47d-ae0e-4cae-b675-f9d89c8bf292
                  - instanceUid: 4211242d-841b-deff-d4fd-1399a073135d
                    managementAgentUid: 32a1eddc-ada4-4805-ad18-2e7871588776
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/linux/{backupAgentUid}':
    get:
      tags:
        - Backup Agents
      summary: Get Veeam Agent for Linux
      description: Returns a resource representation of a Veeam Agent for Linux with the specified UID.
      operationId: GetLinuxBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxBackupAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 4211242d-841b-deff-d4fd-1399a073135d
                  managementAgentUid: 32a1eddc-ada4-4805-ad18-2e7871588776
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/linux/{backupAgentUid}/update':
    post:
      tags:
        - Deployment
      summary: Update Veeam Agent for Linux
      description: "Updates a Veeam Agent for Linux with the specified UID.\n> To track the deployment progress, you can use the `WaitDeploymentTask` operation.\n"
      operationId: UpdateLinuxBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DeploymentInformation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  deployTaskUid: 9fc2b022-be46-4971-8eb2-83bbfaba0163
                  deployTaskId: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/linux/assignedPolicies:
    get:
      tags:
        - Backup Agents
      summary: Get Policies Assigned to All Veeam Agents for Linux
      description: Returns a collection resource representation of all backup policies assigned to Veeam Agents for Linux.
      operationId: GetAllLinuxBackupAgentAssignedPolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupAgentAssignedBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - configUid: ca7d562a-eb7c-4585-94f7-927f4e8a84ac
                    backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    backupPolicyUid: 0b2a27ed-9419-4298-b735-07e64ba1f062
                    backupPolicyId: 4
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: 
                    assignedBy: 
                  - configUid: 04e43f66-1042-4102-956e-4754928780de
                    backupAgentUid: 4211bca5-448b-b58b-d05d-e4e39b9ef349
                    backupPolicyUid: 7be0c07f-803b-4099-a67d-83a39400b1fd
                    backupPolicyId: 12
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: 
                    assignedBy: 
                  - configUid: ca7d562a-eb7c-4585-94f7-927f4e8a84ac
                    backupAgentUid: 4211bca5-448b-b58b-d05d-e4e39b9ef349
                    backupPolicyUid: 0b2a27ed-9419-4298-b735-07e64ba1f062
                    backupPolicyId: 4
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: 
                    assignedBy: 
                  - configUid: ca7d562a-eb7c-4585-94f7-927f4e8a84ac
                    backupAgentUid: 4211242d-841b-deff-d4fd-1399a073135d
                    backupPolicyUid: 0b2a27ed-9419-4298-b735-07e64ba1f062
                    backupPolicyId: 4
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: 
                    assignedBy: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/linux/{backupAgentUid}/assignedPolicies':
    get:
      tags:
        - Backup Agents
      summary: Get All Policies Assigned to Veeam Agent for Linux
      description: Returns a collection resource representation of all backup policies assigned to a Veeam Agent for Linux with the specified UID.
      operationId: GetLinuxBackupAgentAssignedPolicies
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupAgentAssignedBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - configUid: ca7d562a-eb7c-4585-94f7-927f4e8a84ac
                    backupAgentUid: 42164848-7520-e599-da56-c589ed0ff258
                    backupPolicyUid: 4cecc062-ac2e-4e0e-a741-b9c8f4ca2c59
                    backupPolicyId: 4
                    status: Applied
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 
                    backupPolicyRevision: 
                    assignedDate: 
                    assignedBy: 
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Backup Agents
      summary: Assign Policy to Veeam Agent for Linux
      description: Assigns a backup policy to a Veeam Agent for Linux with the specified UID. Returns a positive response when the management agent receives the task and not when the task is executed.
      operationId: AssignLinuxPolicyOnBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - name: policyUid
          in: query
          description: Backup policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/linux/jobs:
    get:
      tags:
        - Backup Agent Jobs
      summary: Get Jobs for All Veeam Agents for Linux
      description: Returns a collection resource representation of all Veeam Agent jobs protecting Linux computers.
      operationId: GetLinuxBackupAgentJobs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LinuxBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 2b1ce32e-501c-6b3b-a8fc-12d115e5b969
                    backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: LServerEntireCloud_rlab2val
                    description: Linux Policy
                    configUid: 04e43f66-1042-4102-956e-4754928780de
                    backupPolicyUid: 7be0c07f-803b-4099-a67d-83a39400b1fd
                    backupPolicyName: LServerEntireCloud
                    backupPolicyAssignStatus: Assigned
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Server
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: EntireComputer
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T05:40:56.1820000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: 0fa5c1b9-1d7f-68cc-b319-bbfdf9d88ab6
                    backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: Linux server - Entire computer_rlab2val
                    description: 'This policy should be used if you want to create a backup of the entire Linux computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                    configUid: ca7d562a-eb7c-4585-94f7-927f4e8a84ac
                    backupPolicyUid: 0b2a27ed-9419-4298-b735-07e64ba1f062
                    backupPolicyName: Linux server - Entire computer
                    backupPolicyAssignStatus: Assigned
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Server
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: EntireComputer
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T05:44:03.5230000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: 2b66f8ae-209b-6afa-9d20-f1a3460ff17c
                    backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: ServerVolumeCloud_Job
                    description: patched but still awesome description
                    configUid: f927b0e7-707c-4ef7-8ae9-6515a6088ed5
                    backupPolicyUid: 
                    backupPolicyName: 
                    backupPolicyAssignStatus: 
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Workstation
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: Volume
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: NotScheduled
                    lastModifiedDate: '2025-07-24T05:52:39.9880000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: 468db095-9447-616c-be30-a6b1d476d916
                    backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: ServerEntireCloud_Custom
                    description: Linux Policy
                    configUid: f368dc3b-098e-4930-8d7d-e89ed63ca581
                    backupPolicyUid: 
                    backupPolicyName: 
                    backupPolicyAssignStatus: 
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Server
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: EntireComputer
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T05:51:06.7220000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/linux/{backupAgentUid}/jobs':
    get:
      tags:
        - Backup Agent Jobs
      summary: Get All Jobs for Veeam Agent for Linux
      description: Returns a collection resource representation of all jobs configured for a Veeam Agent for Linux with the specified UID.
      operationId: GetLinuxBackupAgentJobsByAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LinuxBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 2b1ce32e-501c-6b3b-a8fc-12d115e5b969
                    backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: LServerEntireCloud_r2val
                    description: Linux Policy
                    configUid: 04e43f66-1042-4102-956e-4754928780de
                    backupPolicyUid: 7be0c07f-803b-4099-a67d-83a39400b1fd
                    backupPolicyName: LServerEntireCloud
                    backupPolicyAssignStatus: Assigned
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Server
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: EntireComputer
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T05:40:56.1820000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: 0fa5c1b9-1d7f-68cc-b319-bbfdf9d88ab6
                    backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: Linux server - Entire computer_r2val
                    description: 'This policy should be used if you want to create a backup of the entire Linux computer image. When you restore data from such backup, you will be able to recover the entire computer image as well as data on specific computer volumes: files, folders, application data and so on.'
                    configUid: ca7d562a-eb7c-4585-94f7-927f4e8a84ac
                    backupPolicyUid: 0b2a27ed-9419-4298-b735-07e64ba1f062
                    backupPolicyName: Linux server - Entire computer
                    backupPolicyAssignStatus: Assigned
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Server
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: EntireComputer
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T05:44:03.5230000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: 2b66f8ae-209b-6afa-9d20-f1a3460ff17c
                    backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: ServerVolumeCloud_Job
                    description: patched but still awesome description
                    configUid: f927b0e7-707c-4ef7-8ae9-6515a6088ed5
                    backupPolicyUid: 
                    backupPolicyName: 
                    backupPolicyAssignStatus: 
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Workstation
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: Volume
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: NotScheduled
                    lastModifiedDate: '2025-07-24T05:52:39.9880000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: 468db095-9447-616c-be30-a6b1d476d916
                    backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                    organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                    name: ServerEntireCloud_Custom
                    description: Linux Policy
                    configUid: f368dc3b-098e-4930-8d7d-e89ed63ca581
                    backupPolicyUid: 
                    backupPolicyName: 
                    backupPolicyAssignStatus: 
                    backupPolicyFailureMessage: 
                    status: None
                    operationMode: Server
                    destination: vspc1.tech.local
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: EntireComputer
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T05:51:06.7220000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/linux/{backupAgentUid}/jobs/{backupAgentJobUid}':
    get:
      tags:
        - Backup Agent Jobs
      summary: Get Veeam Agent for Linux Job
      description: Returns a resource representation of a Veeam Agent for Linux job with the specified UID.
      operationId: GetLinuxBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Linux_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 2b1ce32e-501c-6b3b-a8fc-12d115e5b969
                  backupAgentUid: 4211e60c-c4c1-3b58-ae37-442f5194c977
                  organizationUid: 2350c281-951d-446f-bc67-8ae9321dc131
                  name: LServerEntireCloud_r2val
                  description: Linux Policy
                  configUid: 04e43f66-1042-4102-956e-4754928780de
                  backupPolicyUid: 7be0c07f-803b-4099-a67d-83a39400b1fd
                  backupPolicyName: LServerEntireCloud
                  backupPolicyAssignStatus: Assigned
                  backupPolicyFailureMessage: 
                  status: None
                  operationMode: Server
                  destination: vspc1.tech.local
                  restorePoints: 0
                  lastRun: 
                  lastEndTime: 
                  lastDuration: 
                  nextRun: 
                  avgDuration: 0
                  backupMode: EntireComputer
                  targetType: CloudRepository
                  isEnabled: true
                  scheduleType: Daily
                  lastModifiedDate: '2025-07-24T05:40:56.1820000+02:00'
                  lastModifiedBy: VSPC1\Administrator
                  failureMessage: 
                  backedUpSize: 
                  freeSpace: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Backup Agent Jobs
      summary: Delete Veeam Agent for Linux Job
      description: Deletes a Veeam Agent for Linux job with the specified UID. Returns a positive response if the restart task is added to the internal queue and not when the task is executed.
      operationId: DeleteLinuxBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Linux_path'
        - name: removeRestorePoints
          in: query
          description: Defines whether restore points must be deleted.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/linux/{backupAgentUid}/jobs/{backupAgentJobUid}/start':
    post:
      tags:
        - Backup Agent Jobs
      summary: Start Veeam Agent for Linux Job
      description: Starts a Veeam Agent for Linux job with the specified UID. Returns a positive response if the task is added to the internal queue and not when the task is executed.
      operationId: StartLinuxBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Linux_path'
        - $ref: '#/components/parameters/activeFullBackup_query'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/linux/{backupAgentUid}/jobs/{backupAgentJobUid}/stop':
    post:
      tags:
        - Backup Agent Jobs
      summary: Stop Veeam Agent for Linux Job
      description: Stops a Veeam Agent for Linux job with the specified UID. Returns a positive response if the task is added to the internal queue and not when the task is executed.
      operationId: StopLinuxBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Linux_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/linux/{backupAgentUid}/jobs/{backupAgentJobUid}/configuration':
    get:
      tags:
        - Backup Agent Jobs
      summary: Get Configuration of Veeam Agent for Linux Job
      description: Returns a resource representation of a configuration of a Veeam Agent for Linux job with the specified UID.
      operationId: GetLinuxBackupAgentJobConfiguration
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Linux_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxCustomJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: ServerVolumeCloud_Job
                  description: Created by admin
                  operationMode: Server
                  cloudRepositoryConnectionSettings:
                    backupResourceUid: 28428289-2557-41b5-a51d-95730a24f23a
                    username: restv3t1
                    password: 
                  jobConfiguration:
                    backupSource:
                      backupMode: Volume
                      volumeLevelOptions:
                        volumes:
                          - volumeType: Device
                            path: /dev/sda
                      fileLevelOptions: 
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                      isSnapshotRequired: true
                    indexingSettings:
                      indexingType: ExceptSpecifiedFolders
                      includedFolders: 
                      excludedFolders:
                        - home
                    scriptSettings:
                      enabled: false
                      preJobScript: 
                      postJobScript: 
                      preFreezeScript: 
                      postThawScript: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings:
                        scheduleType: NotScheduled
                        dayOfMonth: 
                        weeklyOnDays: 
                      retrySettings:
                        enabled: true
                        retryTimes: 3
                        waitTimeoutMinutes: 10
                    applicationAwareProcessingSettings:
                      oracleAapSettings:
                        processingType: TryProcess
                        credentials:
                          username: string
                          password: 
                        truncationConfig:
                          truncationMode: TruncateDisabled
                          sizeGB: 0
                          lifeTimeHours: 0
                        useOracleCredentials: true
                      mySqlAapSettings:
                        processingType: TryProcess
                        credentials:
                          username: string
                          password: 
                        authType: MySQLPassword
                        passwordFilePath: ''
                      postgreSqlAapSettings:
                        processingType: TryProcess
                        credentials:
                          username: string
                          password: 
                        authType: PSQLPassword
                    gfsRetentionSettings: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/LinuxCustomJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Backup Agent Jobs
      summary: Modify Configuration of Veeam Agent for Linux Job
      description: Modifies Veeam Agent for Linux job configuration with the specified UID.
      operationId: PatchLinuxBackupAgentJobConfiguration
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Linux_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: TryProcess
                path: /jobconfiguration/applicationawareprocessingsettings/oracleaapsettings/processingtype
                op: add
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxCustomJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: ServerVolumeCloud_Job
                  description: Created by admin
                  operationMode: Server
                  cloudRepositoryConnectionSettings:
                    backupResourceUid: 28428289-2557-41b5-a51d-95730a24f23a
                    username: restv3t1
                    password: 
                  jobConfiguration:
                    backupSource:
                      backupMode: Volume
                      volumeLevelOptions:
                        volumes:
                          - volumeType: Device
                            path: /dev/sda
                      fileLevelOptions: 
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                      isSnapshotRequired: true
                    indexingSettings:
                      indexingType: ExceptSpecifiedFolders
                      includedFolders: 
                      excludedFolders:
                        - home
                    scriptSettings:
                      enabled: false
                      preJobScript: 
                      postJobScript: 
                      preFreezeScript: 
                      postThawScript: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings:
                        scheduleType: NotScheduled
                        dayOfMonth: 
                        weeklyOnDays: 
                      retrySettings:
                        enabled: true
                        retryTimes: 3
                        waitTimeoutMinutes: 10
                    applicationAwareProcessingSettings:
                      oracleAapSettings:
                        processingType: TryProcess
                        credentials:
                          username: string
                          password: 
                        truncationConfig:
                          truncationMode: TruncateDisabled
                          sizeGB: 0
                          lifeTimeHours: 0
                        useOracleCredentials: true
                      mySqlAapSettings:
                        processingType: TryProcess
                        credentials:
                          username: string
                          password: 
                        authType: MySQLPassword
                        passwordFilePath: ''
                      postgreSqlAapSettings:
                        processingType: TryProcess
                        credentials:
                          username: string
                          password: 
                        authType: PSQLPassword
                    gfsRetentionSettings: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/LinuxCustomJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/linux/{backupAgentUid}/jobs/configuration':
    post:
      tags:
        - Backup Agent Jobs
      summary: Create Configuration of Veeam Agent for Linux Job
      description: Creates configuration of a Veeam backup agent job protecting Linux computer with the specified UID.
      operationId: CreateLinuxBackupAgentJobConfiguration
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Linux_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Veeam Agent for Linux job configuration
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LinuxCustomJobConfiguration'
            example:
              name: ServerEntireCloud_Custom
              description: Linux Policy
              operationMode: Server
              cloudRepositoryConnectionSettings:
                backupResourceUid: 28428289-2557-41b5-a51d-06730a24f23a
                username: admin
                password: Password1
              jobConfiguration:
                backupSource:
                  backupMode: EntireComputer
                  volumeLevelOptions: 
                  fileLevelOptions: 
                backupTarget:
                  targetType: CloudRepository
                  localPath: 
                  sharedFolder: 
                  backupRepository: 
                  enableDeletedFilesRetention: true
                  removeDeletedItemsDataAfter: 5
                backupStorage:
                  compressionLevel: Optimal
                  blockSize: Local
                  encryptionEnabled: false
                  password: 
                  passwordHint: 
                  isSnapshotRequired: true
                indexingSettings: 
                scriptSettings:
                  enabled: false
                  preJobScript: 
                  postJobScript: 
                  preFreezeScript: 
                  postThawScript: 
                retentionSettings:
                  restorePointsCount: 10
                scheduleSettings:
                  scheduleType: Daily
                  dailyScheduleSettings:
                    time: '2025-09-09T03:30:00.0000000+02:00'
                    dailyMode: Everyday
                    specificDays: 
                  monthlyScheduleSettings: 
                  periodicallyScheduleSettings: 
                  activeFullSettings:
                    scheduleType: Monthly
                    dayOfMonth: 2
                    weeklyOnDays:
                      - Saturday
                  retrySettings:
                    enabled: true
                    retryTimes: 3
                    waitTimeoutMinutes: 10
                applicationAwareProcessingSettings:
                  oracleAapSettings:
                    processingType: DisableProcess
                    credentials: 
                    truncationConfig:
                      truncationMode: TruncateDisabled
                      sizeGB: 1
                      lifeTimeHours: 1
                    useOracleCredentials: false
                  mySqlAapSettings:
                    processingType: DisableProcess
                    credentials:
                      username: admin
                      password: Password1
                    authType: MySQLPassword
                    passwordFilePath: 
                  postgreSqlAapSettings:
                    processingType: DisableProcess
                    credentials:
                      username: admin
                      password: Password1
                    authType: PSQLPassword
                gfsRetentionSettings:
                  weekly:
                    keepWeeklyBackupsForWeeks: 1
                    useFullBackupFrom: Tuesday
                  monthly:
                    keepMonthlyBackupsForMonths: 2
                    useWeeklyFullBackupForTheFollowingWeekOfMonth: Second
                  yearly:
                    keepYearlyBackupsForYears: 3
                    useMonthlyFullBackupForTheFollowingMonth: Jan
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LinuxCustomJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: ServerEntireCloud_Custom
                  description: Linux Policy
                  operationMode: Server
                  cloudRepositoryConnectionSettings:
                    backupResourceUid: 28428289-2557-41b5-a51d-95730a24f23a
                    username: admin
                    password: 
                  jobConfiguration:
                    backupSource:
                      backupMode: EntireComputer
                      volumeLevelOptions: 
                      fileLevelOptions: 
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: true
                      removeDeletedItemsDataAfter: 5
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                      isSnapshotRequired: true
                    indexingSettings: 
                    scriptSettings:
                      enabled: false
                      preJobScript: 
                      postJobScript: 
                      preFreezeScript: 
                      postThawScript: 
                    retentionSettings:
                      restorePointsCount: 10
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T03:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings:
                        scheduleType: Monthly
                        dayOfMonth: 2
                        weeklyOnDays:
                          - Saturday
                      retrySettings:
                        enabled: true
                        retryTimes: 3
                        waitTimeoutMinutes: 10
                    applicationAwareProcessingSettings:
                      oracleAapSettings:
                        processingType: DisableProcess
                        credentials: 
                        truncationConfig:
                          truncationMode: TruncateDisabled
                          sizeGB: 1
                          lifeTimeHours: 1
                        useOracleCredentials: false
                      mySqlAapSettings:
                        processingType: DisableProcess
                        credentials:
                          username: admin
                          password: 
                        authType: MySQLPassword
                        passwordFilePath: 
                      postgreSqlAapSettings:
                        processingType: DisableProcess
                        credentials:
                          username: admin
                          password: 
                        authType: PSQLPassword
                    gfsRetentionSettings:
                      weekly:
                        keepWeeklyBackupsForWeeks: 1
                        useFullBackupFrom: Tuesday
                      monthly:
                        keepMonthlyBackupsForMonths: 2
                        useWeeklyFullBackupForTheFollowingWeekOfMonth: Second
                      yearly:
                        keepYearlyBackupsForYears: 3
                        useMonthlyFullBackupForTheFollowingMonth: Jan
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}/configuration':
    get:
      tags:
        - Preview Operations
      summary: Get Configuration of Veeam Agent for Mac Job
      description: Returns a resource representation of a configuration of a Veeam Agent for Mac job with the specified UID.
      operationId: GetMacBackupAgentJobConfiguration
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Mac_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/MacCustomJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: ServerEntireCloud_Custom
                  description: Mac Policy
                  operationMode: Server
                  cloudRepositoryConnectionSettings:
                    backupResourceUid: 28428289-2557-41b5-a51d-95730a24f23a
                    username: admin
                    password: 
                  jobConfiguration:
                    backupSource:
                      backupDirectlyFromLiveFileSystem: true
                      includeUsbDrives: false
                      includeDirectories: 
                      inclusionMasks: 
                      excludeDirectories: 
                      exclusionMasks: 
                      personalFilesAdvancedSettings:
                        inclusions:
                          - Desktop
                          - Documents
                          - Downloads
                          - Video
                          - Music
                          - Pictures
                          - Favorites
                          - ApplicationData
                          - OtherFilesAndFolders
                          - Library
                        excludeNetworkAccount: true
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local1MB
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings: 
                      retrySettings:
                        enabled: false
                        retryTimes: 3
                        waitTimeoutMinutes: 10
                      backupHealthCheckScheduleSettings: 
                    gfsRetentionSettings: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/MacCustomJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Preview Operations
      summary: Modify Configuration of Veeam Agent for Mac Job
      description: Modifies configuration of a Veeam Agent for Mac job with the specified UID.
      operationId: PatchMacBackupAgentJobConfiguration
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - name: backupAgentJobUid
          in: path
          description: Veeam Agent for Mac job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: false
                path: /jobconfiguration/backupsource/includeusbdrives
                op: add
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/MacCustomJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: ServerEntireCloud_Custom
                  description: Mac Policy
                  operationMode: Server
                  cloudRepositoryConnectionSettings:
                    backupResourceUid: 28428289-2557-41b5-a51d-95730a24f23a
                    username: admin
                    password: 
                  jobConfiguration:
                    backupSource:
                      backupDirectlyFromLiveFileSystem: true
                      includeUsbDrives: false
                      includeDirectories: 
                      inclusionMasks: 
                      excludeDirectories: 
                      exclusionMasks: 
                      personalFilesAdvancedSettings:
                        inclusions:
                          - Desktop
                          - Documents
                          - Downloads
                          - Video
                          - Music
                          - Pictures
                          - Favorites
                          - ApplicationData
                          - OtherFilesAndFolders
                          - Library
                        excludeNetworkAccount: true
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local1MB
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings: 
                      retrySettings:
                        enabled: false
                        retryTimes: 3
                        waitTimeoutMinutes: 10
                      backupHealthCheckScheduleSettings: 
                    gfsRetentionSettings: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/MacCustomJobConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/mac/{backupAgentUid}/jobs/configuration':
    post:
      tags:
        - Preview Operations
      summary: Create Configuration of Job for Veeam Agent for Mac
      description: Creates a configuration of a Veeam backup agent job protecting Mac computer with the specified UID.
      operationId: CreateMacBackupAgentJobConfiguration
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Veeam Agent for Mac job configuration
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MacCustomJobConfiguration'
            example:
              name: ServerEntireCloud_Custom
              description: Mac Policy
              operationMode: Server
              cloudRepositoryConnectionSettings:
                backupResourceUid: 28428289-2557-41b5-a51d-95730a24f23a
                username: admin
                password: 
              jobConfiguration:
                backupSource:
                  backupDirectlyFromLiveFileSystem: true
                  includeUsbDrives: false
                  includeDirectories: 
                  inclusionMasks: 
                  excludeDirectories: 
                  exclusionMasks: 
                  personalFilesAdvancedSettings:
                    inclusions:
                      - Desktop
                      - Documents
                      - Downloads
                      - Video
                      - Music
                      - Pictures
                      - Favorites
                      - ApplicationData
                      - OtherFilesAndFolders
                      - Library
                    excludeNetworkAccount: true
                backupTarget:
                  targetType: CloudRepository
                  localPath: 
                  sharedFolder: 
                  backupRepository: 
                  enableDeletedFilesRetention: false
                  removeDeletedItemsDataAfter: 30
                backupStorage:
                  compressionLevel: Optimal
                  blockSize: Local1MB
                  encryptionEnabled: false
                  password: 
                  passwordHint: 
                retentionSettings:
                  restorePointsCount: 7
                scheduleSettings:
                  scheduleType: Daily
                  dailyScheduleSettings:
                    time: '2025-09-09T00:30:00.0000000+02:00'
                    dailyMode: Everyday
                    specificDays: 
                  monthlyScheduleSettings: 
                  periodicallyScheduleSettings: 
                  activeFullSettings: 
                  retrySettings:
                    enabled: false
                    retryTimes: 3
                    waitTimeoutMinutes: 10
                  backupHealthCheckScheduleSettings: 
                gfsRetentionSettings: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/MacCustomJobConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  name: ServerEntireCloud_Custom
                  description: Mac Policy
                  operationMode: Server
                  cloudRepositoryConnectionSettings:
                    backupResourceUid: 28428289-2557-41b5-a51d-95730a24f23a
                    username: admin
                    password: 
                  jobConfiguration:
                    backupSource:
                      backupDirectlyFromLiveFileSystem: true
                      includeUsbDrives: false
                      includeDirectories: 
                      inclusionMasks: 
                      excludeDirectories: 
                      exclusionMasks: 
                      personalFilesAdvancedSettings:
                        inclusions:
                          - Desktop
                          - Documents
                          - Downloads
                          - Video
                          - Music
                          - Pictures
                          - Favorites
                          - ApplicationData
                          - OtherFilesAndFolders
                          - Library
                        excludeNetworkAccount: true
                    backupTarget:
                      targetType: CloudRepository
                      localPath: 
                      sharedFolder: 
                      backupRepository: 
                      enableDeletedFilesRetention: false
                      removeDeletedItemsDataAfter: 30
                    backupStorage:
                      compressionLevel: Optimal
                      blockSize: Local1MB
                      encryptionEnabled: false
                      password: 
                      passwordHint: 
                    retentionSettings:
                      restorePointsCount: 7
                    scheduleSettings:
                      scheduleType: Daily
                      dailyScheduleSettings:
                        time: '2025-09-09T00:30:00.0000000+02:00'
                        dailyMode: Everyday
                        specificDays: 
                      monthlyScheduleSettings: 
                      periodicallyScheduleSettings: 
                      activeFullSettings: 
                      retrySettings:
                        enabled: false
                        retryTimes: 3
                        waitTimeoutMinutes: 10
                      backupHealthCheckScheduleSettings: 
                    gfsRetentionSettings: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/mac:
    get:
      tags:
        - Backup Agents
      summary: Get All Veeam Agents for Mac
      description: Returns a collection resource representation of all Veeam Agents for Mac.
      operationId: GetMacBackupAgents
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MacBackupAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 42164e26-7a64-ff0a-af1b-f52ca8eb0381
                    managementAgentUid: 63a0f72a-788f-47ae-899c-8db9541ffaac
                  - instanceUid: 42165496-893b-4877-4e6f-886e5c0cb873
                    managementAgentUid: 0a2b746c-da35-451a-bac5-ffde35d9ae7f
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/mac/{backupAgentUid}':
    get:
      tags:
        - Backup Agents
      summary: Get Veeam Agent for Mac
      description: Returns a resource representation of a Veeam Agent for Mac with the specified UID.
      operationId: GetMacBackupAgent
      parameters:
        - name: backupAgentUid
          in: path
          description: Veeam Agent for Mac UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/MacBackupAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 42164e26-7a64-ff0a-af1b-f52ca8eb0381
                  managementAgentUid: 63a0f72a-788f-47ae-899c-8db9541ffaac
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/mac/{backupAgentUid}/update':
    post:
      tags:
        - Deployment
      summary: Update Veeam Agent for Mac
      description: "Updates a Veeam Agent for Mac with the specified UID.\n> To track the deployment progress, you can use the `WaitDeploymentTask` operation.\n"
      operationId: UpdateMacBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DeploymentInformation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  deployTaskUid: 9fc2b022-be46-4971-8eb2-83bbfaba0163
                  deployTaskId: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/mac/assignedPolicies:
    get:
      tags:
        - Backup Agents
      summary: Get Policies Assigned to All Veeam Agents for Mac
      description: Returns a collection resource representation of all backup policies assigned to Veeam Agents for Mac.
      operationId: GetAllMacBackupAgentAssignedPolicies
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupAgentAssignedBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - configUid: 9d832db0-ffe5-4ec4-8a18-6f6b5a07e530
                    backupAgentUid: 42165496-893b-4877-4e6f-886e5c0cb873
                    backupPolicyUid: 63df86f1-bf79-49f3-bcdd-4832adf51c87
                    backupPolicyId: 5
                    status: Warning
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 'Full disk access privileges are not granted to the backup agent. Backup jobs may fail, or some sources may be skipped from backup.'
                    backupPolicyRevision: 
                    assignedDate: 
                    assignedBy: 
                  - configUid: 9d832db0-ffe5-4ec4-8a18-6f6b5a07e530
                    backupAgentUid: 42164e26-7a64-ff0a-af1b-f52ca8eb0381
                    backupPolicyUid: 63df86f1-bf79-49f3-bcdd-4832adf51c87
                    backupPolicyId: 5
                    status: Warning
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 'Full disk access privileges are not granted to the backup agent. Backup jobs may fail, or some sources may be skipped from backup.'
                    backupPolicyRevision: 
                    assignedDate: 
                    assignedBy: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/mac/{backupAgentUid}/assignedPolicies':
    get:
      tags:
        - Backup Agents
      summary: Get All Policies Assigned to Veeam Agent for Mac
      description: Returns a collection resource representation of all backup policies assigned to a Veeam Agent for Mac with the specified UID.
      operationId: GetMacBackupAgentAssignedPolicies
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupAgentAssignedBackupPolicy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - configUid: 9d832db0-ffe5-4ec4-8a18-6f6b5a07e530
                    backupAgentUid: 42165496-893b-4877-4e6f-886e5c0cb873
                    backupPolicyUid: 63df86f1-bf79-49f3-bcdd-4832adf51c87
                    backupPolicyId: 5
                    status: Warning
                    isCustom: false
                    isOutOfDate: false
                    backupPolicyFailureMessage: 'Full disk access privileges are not granted to the backup agent. Backup jobs may fail, or some sources may be skipped from backup.'
                    backupPolicyRevision: 
                    assignedDate: 
                    assignedBy: 
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Backup Agents
      summary: Assign Policy to Veeam Agent for Mac
      description: Assigns a backup policy to a Veeam Agent for Mac with the specified UID. Returns a positive response when the management agent receives the task and not when the task is executed.
      operationId: AssignMacPolicyOnBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - name: policyUid
          in: query
          description: Backup policy UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/backupAgents/mac/jobs:
    get:
      tags:
        - Backup Agent Jobs
      summary: Get Jobs for All Veeam Agents for Mac
      description: Returns a collection resource representation of all Veeam Agent for Mac jobs.
      operationId: GetMacBackupAgentJobs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MacBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 1f5136bb-8d54-62d2-bc1f-2a901ee15d96
                    backupAgentUid: 42165496-893b-4877-4e6f-886e5c0cb873
                    organizationUid: 0c600981-2136-4999-af1c-69477e79c0b4
                    name: Mac workstation - Users directory_mac15
                    description: This policy processes /Users directory.
                    configUid: 9d832db0-ffe5-4ec4-8a18-6f6b5a07e530
                    backupPolicyUid: 63df86f1-bf79-49f3-bcdd-4832adf51c87
                    backupPolicyName: Mac workstation - Users directory
                    backupPolicyAssignStatus: Warning
                    backupPolicyFailureMessage: 'Full disk access privileges are not granted to the backup agent. Backup jobs may fail, or some sources may be skipped from backup.'
                    status: None
                    operationMode: Workstation
                    destination: 172.25.48.98
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: File
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T03:40:36.0230000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: d1e49a2e-e96b-6460-abcf-84c60b5d4d51
                    backupAgentUid: 42164e26-7a64-ff0a-af1b-f52ca8eb0381
                    organizationUid: 0c600981-2136-4999-af1c-69477e79c0b4
                    name: Mac workstation - Users directory_mac15_2
                    description: This policy processes /Users directory.
                    configUid: 9d832db0-ffe5-4ec4-8a18-6f6b5a07e530
                    backupPolicyUid: 63df86f1-bf79-49f3-bcdd-4832adf51c87
                    backupPolicyName: Mac workstation - Users directory
                    backupPolicyAssignStatus: Warning
                    backupPolicyFailureMessage: 'Full disk access privileges are not granted to the backup agent. Backup jobs may fail, or some sources may be skipped from backup.'
                    status: None
                    operationMode: Workstation
                    destination: 172.25.48.98
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: File
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T03:37:58.9200000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/mac/{backupAgentUid}/jobs':
    get:
      tags:
        - Backup Agent Jobs
      summary: Get All Jobs for Veeam Agent for Mac
      description: Returns a collection resource representation of all jobs configured for Veeam Agent for Mac with the specified UID.
      operationId: GetMacBackupAgentJobsByAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/MacBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 1f5136bb-8d54-62d2-bc1f-2a901ee15d96
                    backupAgentUid: 42165496-893b-4877-4e6f-886e5c0cb873
                    organizationUid: 0c600981-2136-4999-af1c-69477e79c0b4
                    name: Mac workstation - Users directory_mac15
                    description: This policy processes /Users directory.
                    configUid: 9d832db0-ffe5-4ec4-8a18-6f6b5a07e530
                    backupPolicyUid: 63df86f1-bf79-49f3-bcdd-4832adf51c87
                    backupPolicyName: Mac workstation - Users directory
                    backupPolicyAssignStatus: Warning
                    backupPolicyFailureMessage: 'Full disk access privileges are not granted to the backup agent. Backup jobs may fail, or some sources may be skipped from backup.'
                    status: None
                    operationMode: Workstation
                    destination: 172.25.48.98
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: File
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T03:40:36.0230000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                  - instanceUid: d1e49a2e-e96b-6460-abcf-84c60b5d4d51
                    backupAgentUid: 42165496-893b-4877-4e6f-886e5c0cb873
                    organizationUid: 0c600981-2136-4999-af1c-69477e79c0b4
                    name: Mac workstation - Users directory_mac15_2
                    description: This policy processes /Users directory.
                    configUid: 9d832db0-ffe5-4ec4-8a18-6f6b5a07e530
                    backupPolicyUid: 63df86f1-bf79-49f3-bcdd-4832adf51c87
                    backupPolicyName: Mac workstation - Users directory
                    backupPolicyAssignStatus: Warning
                    backupPolicyFailureMessage: 'Full disk access privileges are not granted to the backup agent. Backup jobs may fail, or some sources may be skipped from backup.'
                    status: None
                    operationMode: Workstation
                    destination: 172.25.48.98
                    restorePoints: 0
                    lastRun: 
                    lastEndTime: 
                    lastDuration: 
                    nextRun: 
                    avgDuration: 0
                    backupMode: File
                    targetType: CloudRepository
                    isEnabled: true
                    scheduleType: Daily
                    lastModifiedDate: '2025-07-24T03:37:58.9200000+02:00'
                    lastModifiedBy: VSPC1\Administrator
                    failureMessage: 
                    backedUpSize: 
                    freeSpace: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}':
    get:
      tags:
        - Backup Agent Jobs
      summary: Get Job for Veeam Agent for Mac
      description: Returns a resource representation of a Veeam Agent for Mac job with the specified UID.
      operationId: GetMacBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Mac_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/MacBackupAgentJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d1e49a2e-e96b-6460-abcf-84c60b5d4d51
                  backupAgentUid: 42165496-893b-4877-4e6f-886e5c0cb873
                  organizationUid: 0c600981-2136-4999-af1c-69477e79c0b4
                  name: Mac workstation - Users directory_mac15_2
                  description: This policy processes /Users directory.
                  configUid: 9d832db0-ffe5-4ec4-8a18-6f6b5a07e530
                  backupPolicyUid: 63df86f1-bf79-49f3-bcdd-4832adf51c87
                  backupPolicyName: Mac workstation - Users directory
                  backupPolicyAssignStatus: Warning
                  backupPolicyFailureMessage: 'Full disk access privileges are not granted to the backup agent. Backup jobs may fail, or some sources may be skipped from backup.'
                  status: None
                  operationMode: Workstation
                  destination: 172.25.48.98
                  restorePoints: 0
                  lastRun: 
                  lastEndTime: 
                  lastDuration: 
                  nextRun: 
                  avgDuration: 0
                  backupMode: File
                  targetType: CloudRepository
                  isEnabled: true
                  scheduleType: Daily
                  lastModifiedDate: '2025-07-24T03:37:58.9200000+02:00'
                  lastModifiedBy: VSPC1\Administrator
                  failureMessage: 
                  backedUpSize: 
                  freeSpace: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Backup Agent Jobs
      summary: Delete Job for Veeam Agent for Mac
      description: Deletes a Veeam Agent for Mac job with the specified UID. Returns a positive response if the task is added to the internal queue and not when the task is executed.
      operationId: DeleteMacBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Mac_path'
        - name: removeRestorePoints
          in: query
          description: Defines whether restore point must be deleted.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}/start':
    post:
      tags:
        - Backup Agent Jobs
      summary: Start Job for Veeam Agent for Mac
      description: Starts a Veeam Agent for Mac job with the specified UID. Returns a positive response if the task is added to the internal queue and not when the task is executed.
      operationId: StartMacBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Mac_path'
        - $ref: '#/components/parameters/activeFullBackup_query'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/backupAgents/mac/{backupAgentUid}/jobs/{backupAgentJobUid}/stop':
    post:
      tags:
        - Backup Agent Jobs
      summary: Stop Job for Veeam Agent for Mac
      description: Stops a Veeam Agent for Mac job with the specified UID. Returns a positive response if the task is added to the internal queue and not when the task is executed.
      operationId: StopMacBackupAgentJob
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_Mac_path'
        - $ref: '#/components/parameters/backupAgentJobUid_Mac_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/sites:
    get:
      tags:
        - Cloud Connect
      summary: Get All Sites
      description: Returns a collection resource representation of all cloud agents installed on sites.
      operationId: GetSites
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    siteName: r2vac
                    description: ''
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    managementAgentUid: 50fc0692-8d76-40c3-866f-c211eae72043
                    maintenanceModeIsEnabled: false
                    tenantManagementInCloudConnectIsEnabled: true
                  - siteUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                    siteName: r2SecondCC
                    description: ''
                    backupServerUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                    managementAgentUid: d6ece7c4-3828-473f-8df1-26e514fa294c
                    maintenanceModeIsEnabled: false
                    tenantManagementInCloudConnectIsEnabled: true
                  - siteUid: 6f33878a-dd1b-4c44-9f4c-b9b1da249b1e
                    siteName: r2ThirdCC
                    description: ''
                    backupServerUid: 6f33878a-dd1b-4c44-9f4c-b9b1da249b1e
                    managementAgentUid: 2e0e699f-af1b-49e0-9d72-b5fd6a1299f0
                    maintenanceModeIsEnabled: false
                    tenantManagementInCloudConnectIsEnabled: true
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Site
      description: Returns a resource representation of a cloud agent installed on a Veeam Cloud Connect site with the specified UID.
      operationId: GetSite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  siteName: r2vac
                  description: ''
                  backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  managementAgentUid: 50fc0692-8d76-40c3-866f-c211eae72043
                  maintenanceModeIsEnabled: false
                  tenantManagementInCloudConnectIsEnabled: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/CloudAgent'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
    patch:
      tags:
        - Cloud Connect
      summary: Modify Site
      description: Modifies a cloud agent installed on a Veeam Cloud Connect site with the specified UID.
      operationId: PatchSite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Site1
                path: /siteName
                op: replace
              - value: Created by admin
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  siteName: Site1
                  description: Created by admin
                  backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  managementAgentUid: 50fc0692-8d76-40c3-866f-c211eae72043
                  maintenanceModeIsEnabled: false
                  tenantManagementInCloudConnectIsEnabled: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/CloudAgent'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
  '/infrastructure/sites/{siteUid}/maintenanceModeIsEnabled':
    put:
      tags:
        - Cloud Connect
      summary: Set Site Maintenance Mode
      description: Enables or disables the maintenance mode for a site with the specified UID.
      operationId: SetSiteMaintenanceMode
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: maintenanceMode
          in: query
          description: Pass the `true` value to enable maintenance mode and the `false` value to disable it.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: c9c0e1c7-c856-4d52-a790-eb9f51ea9091
                  siteName: r2vspc
                  description: ''
                  backupServerUid: c9c0e1c7-c856-4d52-a790-eb9f51ea9091
                  managementAgentUid: 50fc0692-9e76-40c3-866f-c211eae72043
                  maintenanceModeIsEnabled: true
                  tenantManagementInCloudConnectIsEnabled: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
  '/infrastructure/sites/{siteUid}/tenantManagementInCloudConnectIsEnabled':
    put:
      tags:
        - Cloud Connect
      summary: Set Tenant Management on Site
      description: Enables or disables tenant management on a Veeam Cloud Connect site with the specified UID.
      operationId: SetSiteTenantManagementMode
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: tenantManagementMode
          in: query
          description: Pass the `true` value to enable tenant management and the `false` value to disable it.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudAgent'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: c9c0e1c7-c856-4d52-a790-eb9f51ea9091
                  siteName: r2vspc
                  description: ''
                  backupServerUid: c9c0e1c7-c856-4d52-a790-eb9f51ea9091
                  managementAgentUid: 50fc0692-9e76-40c3-866f-c211eae72043
                  maintenanceModeIsEnabled: false
                  tenantManagementInCloudConnectIsEnabled: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
  /infrastructure/sites/hardwarePlans:
    get:
      tags:
        - Cloud Connect
      summary: Get All Hardware Plans
      description: Returns a collection resource representation of all hardware plans.
      operationId: GetBackupHardwarePlans
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupHardwarePlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: f698f368-7f29-4351-a822-ba2971f7649b
                    name: Hardware plan 1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    cpuQuota: 10000
                    isCpuQuotaUnlimited: false
                    memoryQuota: 20971520000
                    isMemoryQuotaUnlimited: false
                    networkWithInternetQuota: 0
                    networkWithoutInternetQuota: 1
                  - instanceUid: 982f7ef2-0b95-4b79-b0b9-b858ed3e6a75
                    name: Hardware plan 2
                    backupServerUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    cpuQuota: 1000
                    isCpuQuotaUnlimited: false
                    memoryQuota: 2097152000
                    isMemoryQuotaUnlimited: false
                    networkWithInternetQuota: 0
                    networkWithoutInternetQuota: 1
                  - instanceUid: 52c981c2-3937-4467-a27a-4122de927372
                    name: Hardware plan 3
                    backupServerUid: 0107365a-60f9-422a-832b-485db173d356
                    cpuQuota: 1000
                    isCpuQuotaUnlimited: false
                    memoryQuota: 2097152000
                    isMemoryQuotaUnlimited: false
                    networkWithInternetQuota: 0
                    networkWithoutInternetQuota: 1
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/hardwarePlans':
    get:
      tags:
        - Cloud Connect
      summary: Get All Hardware Plans Configured on Site
      description: Returns a collection resource representation of all hardware plans configured on a Veeam Cloud Connect site with the specified UID.
      operationId: GetBackupHardwarePlansBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupHardwarePlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: f698f368-7f29-4351-a822-ba2971f7649b
                    name: Hardware plan 1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    cpuQuota: 10000
                    isCpuQuotaUnlimited: false
                    memoryQuota: 20971520000
                    isMemoryQuotaUnlimited: false
                    networkWithInternetQuota: 0
                    networkWithoutInternetQuota: 1
                  - instanceUid: 982f7ef2-0b95-4b79-b0b9-b858ed3e6a75
                    name: Hardware plan 2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    cpuQuota: 1000
                    isCpuQuotaUnlimited: false
                    memoryQuota: 2097152000
                    isMemoryQuotaUnlimited: false
                    networkWithInternetQuota: 0
                    networkWithoutInternetQuota: 1
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/hardwarePlans/{instanceUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Hardware Plan
      description: Returns a resource representation of a hardware plan with the specified UID.
      operationId: GetBackupHardwarePlan
      parameters:
        - name: instanceUid
          in: path
          description: Hardware plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/BackupHardwarePlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: f698f368-7f29-4351-a822-ba2971f7649b
                  name: Hardware plan 1
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  cpuQuota: 10000
                  isCpuQuotaUnlimited: false
                  memoryQuota: 20971520000
                  isMemoryQuotaUnlimited: false
                  networkWithInternetQuota: 0
                  networkWithoutInternetQuota: 1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/hardwarePlans/storages:
    get:
      tags:
        - Cloud Connect
      summary: Get All Hardware Plan Storage Entities
      description: Returns a collection resource representation of all storage entities in all hardware plans.
      operationId: GetBackupHardwarePlansStorages
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupHardwarePlanStorage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: eb6a1905-774b-44ee-971c-b574e4f266f1
                    name: Storage 1
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    quota: 53687091200
                  - instanceUid: 0cd4a165-5adc-472b-bd41-01528907e782
                    name: Storage 2
                    hardwarePlanUid: 982f7ef2-0b95-4b79-b0b9-b858ed3e6a75
                    quota: 53687091200
                  - instanceUid: cefeb06b-dbd8-45b0-a019-44daf5ddeea8
                    name: Storage 3
                    hardwarePlanUid: 52c981c2-3937-4467-a27a-4122de927372
                    quota: 53687091200
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/hardwarePlans/{instanceUid}/storages':
    get:
      tags:
        - Cloud Connect
      summary: Get All Hardware Plan Storage Entities
      description: Returns a collection resource representation of all storage entities in a hardware plan with the specified UID.
      operationId: GetBackupHardwarePlanStorages
      parameters:
        - name: instanceUid
          in: path
          description: Hardware plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupHardwarePlanStorage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: eb6a1905-774b-44ee-971c-b574e4f266f1
                    name: Storage 1
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    quota: 53687091200
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/cloudgatewaypools:
    get:
      tags:
        - Cloud Connect
      summary: Get All Cloud Gateway Pools
      description: Returns a collection resource representation of all cloud gateway pools.
      operationId: GetCloudGatewayPools
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudGatewayPool'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 2c449807-d144-4845-80e7-09e4818fb4e4
                    name: Cloud gateway pool 1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    numberOfGateways: 3
                  - instanceUid: e8c59d16-7202-4212-8d4e-7890205c5aa2
                    name: Cloud gateway pool 2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    numberOfGateways: 4
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/cloudgatewaypools':
    get:
      tags:
        - Cloud Connect
      summary: Get All Cloud Gateway Pools Configured for Site
      description: Returns a collection resource representation of all cloud gateway pools configured for a Veeam Cloud Connect site with the specified UID.
      operationId: GetCloudGatewayPoolsBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudGatewayPool'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 2c449807-d144-4845-80e7-09e4818fb4e4
                    name: Cloud gateway pool 1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    numberOfGateways: 3
                  - instanceUid: e8c59d16-7202-4212-8d4e-7890205c5aa2
                    name: Cloud gateway pool 2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    numberOfGateways: 4
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/cloudgatewaypools/{instanceUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Cloud Gateway Pool
      description: Returns a resource representation of a cloud gateway pool with the specified UID.
      operationId: GetCloudGatewayPool
      parameters:
        - name: instanceUid
          in: path
          description: Cloud gateway pool UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudGatewayPool'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 2c449807-d144-4845-80e7-09e4818fb4e4
                  name: Cloud gateway pool 1
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  numberOfGateways: 3
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/cloudgatewaypools/{instanceUid}/cloudgateways':
    get:
      tags:
        - Cloud Connect
      summary: Get All Cloud Gateways in Pool
      description: Returns a collection resource representation of all cloud gateways included in a pool with the specified UID.
      operationId: GetCloudGatewaysByPool
      parameters:
        - name: instanceUid
          in: path
          description: Cloud gateway pool UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudGateway'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 54afd16d-fd84-451d-8cb4-d478b8745180
                    name: r2vaw.tech.local
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    gatewayPoolUid: 2c449807-d144-4845-80e7-09e4818fb4e4
                    port: 9999
                    externalPort: 6180
                    externalAddress: r2vaw.tech.local
                    externalIpList:
                      - r2vaw.tech.local
                    isOutOfDate: false
                    hostUid: 1be00e5c-5906-4e26-a86d-570d5e8bfaf1
                    isDisabled: false
                    status: Healthy
                  - instanceUid: b8e7ba24-2413-4143-a8a7-7e9bce0d6189
                    name: r2SecondCC
                    backupServerUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    gatewayPoolUid: 2c449807-d144-4845-80e7-09e4818fb4e4
                    port: 9999
                    externalPort: 6180
                    externalAddress: r2SecondCC.tech.local
                    externalIpList:
                      - r2SecondCC.tech.local
                    isOutOfDate: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    isDisabled: false
                    status: Healthy
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/cloudgateways:
    get:
      tags:
        - Cloud Connect
      summary: Get All Cloud Gateways
      description: Returns a collection resource representation of all cloud gateways.
      operationId: GetCloudGateways
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudGateway'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 70c87aaf-0498-4a92-beba-7e0a867d05af
                    name: VSPC1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    gatewayPoolUid: 
                    port: 9999
                    externalPort: 6180
                    externalAddress: VSPC1.tech.local
                    externalIpList:
                      - VSPC1.tech.local
                    isOutOfDate: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    isDisabled: false
                    status: Healthy
                  - instanceUid: 54afd16d-fd84-451d-8cb4-d478b8745180
                    name: r2vaw.tech.local
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    gatewayPoolUid: 2c449807-d144-4845-80e7-09e4818fb4e4
                    port: 9999
                    externalPort: 6180
                    externalAddress: r2vaw.tech.local
                    externalIpList:
                      - r2vaw.tech.local
                    isOutOfDate: false
                    hostUid: 1be00e5c-5906-4e26-a86d-570d5e8bfaf1
                    isDisabled: false
                    status: Healthy
                  - instanceUid: b8e7ba24-2413-4143-a8a7-7e9bce0d6189
                    name: r2SecondCC
                    backupServerUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    gatewayPoolUid: 
                    port: 9999
                    externalPort: 6180
                    externalAddress: r2SecondCC.tech.local
                    externalIpList:
                      - r2SecondCC.tech.local
                    isOutOfDate: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    isDisabled: false
                    status: Healthy
                  - instanceUid: 48a8a292-4a4e-4c5b-a821-74f1b30a316c
                    name: R2THIRDCC
                    backupServerUid: 0107365a-60f9-422a-832b-485db173d356
                    gatewayPoolUid: 
                    port: 9999
                    externalPort: 6180
                    externalAddress: 172.35.152.104
                    externalIpList:
                      - 172.35.152.104
                    isOutOfDate: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    isDisabled: false
                    status: Healthy
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/cloudgateways':
    get:
      tags:
        - Cloud Connect
      summary: Get All Cloud Gateways Configured for Site
      description: Returns a collection resource representation of all cloud gateways configured for a Veeam Cloud Connect site with the specified UID.
      operationId: GetCloudGatewaysBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudGateway'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 70c87aaf-0498-4a92-beba-7e0a867d05af
                    name: VSPC1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    gatewayPoolUid: 
                    port: 9999
                    externalPort: 6180
                    externalAddress: VSPC1.tech.local
                    externalIpList:
                      - VSPC1.tech.local
                    isOutOfDate: false
                    hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    isDisabled: false
                    status: Healthy
                  - instanceUid: 54afd16d-fd84-451d-8cb4-d478b8745180
                    name: r2vaw.tech.local
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    gatewayPoolUid: 2c449807-d144-4845-80e7-09e4818fb4e4
                    port: 9999
                    externalPort: 6180
                    externalAddress: r2vaw.tech.local
                    externalIpList:
                      - r2vaw.tech.local
                    isOutOfDate: false
                    hostUid: 1be00e5c-5906-4e26-a86d-570d5e8bfaf1
                    isDisabled: false
                    status: Healthy
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/cloudgateways/{gatewayUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Cloud Gateway
      description: Returns a resource representation of a cloud gateway with the specified UID.
      operationId: GetCloudGateway
      parameters:
        - name: gatewayUid
          in: path
          description: Cloud gateway pool UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudGateway'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 48a8a292-4a4e-4c5b-a821-74f1b30a316c
                  name: R2THIRDCC
                  backupServerUid: 0107365a-60f9-422a-832b-485db173d356
                  gatewayPoolUid: 
                  port: 9999
                  externalPort: 6180
                  externalAddress: 172.35.152.104
                  externalIpList:
                    - 172.35.152.104
                  isOutOfDate: false
                  hostUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                  isDisabled: false
                  status: Healthy
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/wanAccelerators:
    get:
      tags:
        - Cloud Connect
      summary: Get All Wan Accelerators
      description: Returns a collection resource representation of all WAN accelerators.
      operationId: GetSiteWanAcceleratorResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SiteWanAcceleratorResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 00bdb123-c35a-43d6-ad03-7ba78e156ac4
                    name: VSPC1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  - instanceUid: 5c601c47-e4f3-44d4-a0bd-fa5e120141d4
                    name: VSPC2
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/wanAccelerators':
    get:
      tags:
        - Cloud Connect
      summary: Get All Wan Accelerators Configured for Site
      description: Returns a collection resource representation of all WAN accelerators configured for a Veeam Cloud Connect site with the specified UID.
      operationId: GetSiteWanAcceleratorResourcesBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/SiteWanAcceleratorResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 00bdb123-c35a-43d6-ad03-7ba78e156ac4
                    name: VSPC1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  - instanceUid: 5c601c47-e4f3-44d4-a0bd-fa5e120141d4
                    name: VSPC2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/wanAccelerators/{wanAcceleratorUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Wan Accelerator
      description: Returns a resource representation of a WAN accelerator with the specified UID.
      operationId: GetSiteWanAcceleratorResource
      parameters:
        - name: wanAcceleratorUid
          in: path
          description: WAN accelerator UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/SiteWanAcceleratorResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 00bdb123-c35a-43d6-ad03-7ba78e156ac4
                  name: VSPC1
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/backups:
    get:
      tags:
        - Cloud Connect
      summary: Get All Site Backups
      description: Returns a collection resource representation of backups created by all Veeam Cloud Connect sites.
      operationId: GetCloudBackups
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 8bea41e5-1e73-405c-873d-c10776b10233
                    name: WServerVolumeCloud_r2vawServ1
                    tenantUid: b79d2d96-b3c9-43b2-b338-95aeee1b4b6b
                    subTenantUid: 993b560d-1458-4d6c-a9f5-671e5bc41228
                    type: Windows
                    siteUid: e9ac31e5-5377-4f9b-8fbf-1e3d32218ded
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    jobUid: ac2d90e8-50e4-480f-ae9a-3751e520a802
                    sourceInstallationUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    restorePointsCount: 1
                  - instanceUid: b8cbebe4-5b93-4f6d-b77f-e7fb23b4a9e0
                    name: Backup Job 1
                    tenantUid: cf3e0ebd-f242-4404-a9ef-fab8a5244064
                    subTenantUid: 
                    type: VSphere
                    siteUid: bfa1148c-f3cf-446b-8603-656f2e6e46c4
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    jobUid: 31be515a-a120-4b84-8e1a-f4ce8c635fa7
                    sourceInstallationUid: 1902af91-6026-4943-ad78-b89ef80de65f
                    restorePointsCount: 2
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/backups/{backupUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Site Backup
      description: Returns a resource representation of a backup with the specified UID created by a Veeam Cloud Connect site.
      operationId: GetCloudBackup
      parameters:
        - name: backupUid
          in: path
          description: UID assigned to a backup.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 8bea41e5-1e73-405c-873d-c10776b10233
                  name: WServerVolumeCloud_r2vawServ1
                  tenantUid: b79d2d96-b3c9-43b2-b338-95aeee1b4b6b
                  subTenantUid: 993b560d-1458-4d6c-a9f5-671e5bc41228
                  type: Windows
                  siteUid: e9ac31e5-5377-4f9b-8fbf-1e3d32218ded
                  repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                  jobUid: ac2d90e8-50e4-480f-ae9a-3751e520a802
                  sourceInstallationUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                  restorePointsCount: 1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/backups':
    get:
      tags:
        - Cloud Connect
      summary: Get All Backups Created by Site
      description: Returns a collection resource representation of all backups created by a Veeam Cloud Connect site with the specified UID.
      operationId: GetCloudBackupsBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 8bea41e5-1e73-405c-873d-c10776b10233
                    name: WServerVolumeCloud_r2vawServ1
                    tenantUid: b79d2d96-b3c9-43b2-b338-95aeee1b4b6b
                    subTenantUid: 993b560d-1458-4d6c-a9f5-671e5bc41228
                    type: Windows
                    siteUid: e9ac31e5-5377-4f9b-8fbf-1e3d32218ded
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    jobUid: ac2d90e8-50e4-480f-ae9a-3751e520a802
                    sourceInstallationUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    restorePointsCount: 1
                  - instanceUid: b8cbebe4-5b93-4f6d-b77f-e7fb23b4a9e0
                    name: Backup Job 1
                    tenantUid: cf3e0ebd-f242-4404-a9ef-fab8a5244064
                    subTenantUid: 
                    type: VSphere
                    siteUid: e9ac31e5-5377-4f9b-8fbf-1e3d32218ded
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    jobUid: 31be515a-a120-4b84-8e1a-f4ce8c635fa7
                    sourceInstallationUid: 1902af91-6026-4943-ad78-b89ef80de65f
                    restorePointsCount: 2
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/tenants:
    get:
      tags:
        - Cloud Connect
      summary: Get All Tenants
      description: Returns a collection resource representation of all tenants.
      operationId: GetTenants
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7d33c59e-e220-4496-a5cb-e6b40f06c6aa
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    siteName: r2vspc
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: 
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: gatewayPoolTenant
                      password: 
                    description: Created by Powershell at 7/17/2025 5:55:36 PM.
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: GatewayPool
                    gatewayPoolsUids:
                      - ddf4abc1-28be-4399-a305-006b84f07f4e
                    isGatewayFailoverEnabled: false
                    name: gatewayPoolTenant
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: true
                    isNativeReplicationResourcesEnabled: true
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: 6445321d-ca8e-4953-8ccc-2f95caa0452a
                  - instanceUid: 34e7b2d1-8bf1-4d8c-b723-9a3a155ad41f
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    siteName: r2vspc
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: '2025-07-18T10:48:00.0000000+02:00'
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: admin
                      password: 
                    description: Created by Powershell at 7/17/2025 5:07:10 PM.
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: StandaloneGateways
                    gatewayPoolsUids: [ ]
                    isGatewayFailoverEnabled: false
                    name: restv3t1
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: true
                    isNativeReplicationResourcesEnabled: true
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: 320a9260-b2dd-4d6f-8ceb-d574121ff881
                  - instanceUid: f5266e36-fef4-4231-9a9d-11afb11b7f9c
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    siteName: r2vspc
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: '2025-07-18T09:45:00.0000000+02:00'
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: daltenant
                      password: 
                    description: ''
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: StandaloneGateways
                    gatewayPoolsUids: [ ]
                    isGatewayFailoverEnabled: false
                    name: DallasTenant
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: true
                    isNativeReplicationResourcesEnabled: false
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: 1fb1e82c-dbd1-443d-99b7-0602cb3dfb0a
                  - instanceUid: db3e0f98-34d3-4f89-88bc-b8073805a845
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    siteName: r2vspc
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: '2025-07-18T06:29:00.0000000+02:00'
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: pittenant
                      password: 
                    description: ''
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: StandaloneGateways
                    gatewayPoolsUids: [ ]
                    isGatewayFailoverEnabled: false
                    name: PittsburghTenant
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: true
                    isNativeReplicationResourcesEnabled: false
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: f442e813-1cb5-4a41-98dd-9904a082ed02
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/{siteUid}/tenants':
    get:
      tags:
        - Cloud Connect
      summary: Get All Tenants Registered on Site
      description: Returns a collection resource representation of tenants registered on a Veeam Cloud Connect site with the specified UID.
      operationId: GetTenantsBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 717680a7-1a1e-48c1-aed4-204c8ae01201
                    siteUid: bfa1148c-f3cf-446b-8603-656f2e6e46c4
                    siteName: r2vspc
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: 
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: gatewayPoolTenant
                      password: 
                    description: Created by Powershell at 7/23/2025 6:46:52 PM.
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: GatewayPool
                    gatewayPoolsUids:
                      - b89ee2f8-027b-4307-b87f-41f8d8bbbac5
                    isGatewayFailoverEnabled: false
                    name: gatewayPoolTenant
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: true
                    isNativeReplicationResourcesEnabled: true
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: c70316fc-a347-42c4-bc1d-524312815591
                  - instanceUid: cf3e0ebd-f242-4404-a9ef-fab8a5244064
                    siteUid: bfa1148c-f3cf-446b-8603-656f2e6e46c4
                    siteName: r2vspc
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: '2025-07-24T07:19:00.0000000+02:00'
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: admin
                      password: 
                    description: Created by Powershell at 7/23/2025 5:52:55 PM.
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: StandaloneGateways
                    gatewayPoolsUids: [ ]
                    isGatewayFailoverEnabled: false
                    name: restv3t1
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: true
                    isNativeReplicationResourcesEnabled: true
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: 2350c281-951d-446f-bc67-8ae9321dc131
                  - instanceUid: 7829b7b9-46e5-4dd5-a928-ac09898e1385
                    siteUid: bfa1148c-f3cf-446b-8603-656f2e6e46c4
                    siteName: r2vspc
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: 
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: daltenant
                      password: 
                    description: ''
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: StandaloneGateways
                    gatewayPoolsUids: [ ]
                    isGatewayFailoverEnabled: false
                    name: DallasTenant
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: false
                    isNativeReplicationResourcesEnabled: false
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: c4381df0-401c-4d37-a4c5-14cec56c4416
                  - instanceUid: 7a5dafb1-e526-42ca-8bc7-4672709c6c2f
                    siteUid: bfa1148c-f3cf-446b-8603-656f2e6e46c4
                    siteName: r2vspc
                    type: General
                    vCloudOrganizationUid: 
                    lastActive: 
                    isLeaseExpirationEnabled: false
                    leaseExpirationDate: 
                    credentials:
                      userName: PittsburghTenant
                      password: 
                    description: ''
                    isThrottlingEnabled: false
                    throttlingValue: 
                    throttlingUnit: 
                    maxConcurrentTask: 1
                    isBackupProtectionEnabled: false
                    backupProtectionPeriod: 
                    gatewaySelectionType: StandaloneGateways
                    gatewayPoolsUids: [ ]
                    isGatewayFailoverEnabled: false
                    name: PittsburghTenant
                    hashedPassword: 
                    isEnabled: true
                    isBackupResourcesEnabled: false
                    isNativeReplicationResourcesEnabled: false
                    isVcdReplicationResourcesEnabled: false
                    assignedForCompany: 102b8f4d-0984-4204-bfe8-59e0c0063e86
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Cloud Connect
      summary: Create Tenant on Site
      description: Creates a new tenant on a Veeam Cloud Connect site with the specified UID.
      operationId: CreateTenant
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Tenant properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudTenant'
            example:
              type: General
              vCloudOrganizationUid: 
              isLeaseExpirationEnabled: false
              leaseExpirationDate: 
              credentials:
                userName: admin
                password: Password1
              description: Tenant for Alpha company
              isThrottlingEnabled: false
              throttlingValue: 
              throttlingUnit: 
              maxConcurrentTask: 1
              isBackupProtectionEnabled: false
              backupProtectionPeriod: 
              gatewaySelectionType: StandaloneGateways
              gatewayPoolsUids: [ ]
              isGatewayFailoverEnabled: false
              isNativeReplicationResourcesEnabled: false
              isVcdReplicationResourcesEnabled: false
              assignedForCompany: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  siteUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  siteName: ccsrv1
                  type: General
                  vCloudOrganizationUid: 
                  lastActive: 
                  isLeaseExpirationEnabled: false
                  leaseExpirationDate: 
                  credentials:
                    userName: admin
                    password: 
                  description: Tenant for Alpha company
                  isThrottlingEnabled: false
                  throttlingValue: 
                  throttlingUnit: 
                  maxConcurrentTask: 1
                  isBackupProtectionEnabled: false
                  backupProtectionPeriod: 
                  gatewaySelectionType: StandaloneGateways
                  gatewayPoolsUids: [ ]
                  isGatewayFailoverEnabled: false
                  name: tnt1
                  hashedPassword: 
                  isEnabled: true
                  isBackupResourcesEnabled: false
                  isNativeReplicationResourcesEnabled: false
                  isVcdReplicationResourcesEnabled: false
                  assignedForCompany: 6f213654-b538-4695-ac69-aa677e41862e
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/sites/tenants/{tenantUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Tenant
      description: Returns a resource representation of a tenant with the specified UID.
      operationId: GetTenant
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 717680a7-1a1e-48c1-aed4-204c8ae01201
                  siteUid: bfa1148c-f3cf-446b-8603-656f2e6e46c4
                  siteName: r2vspc
                  type: General
                  vCloudOrganizationUid: 
                  lastActive: 
                  isLeaseExpirationEnabled: false
                  leaseExpirationDate: 
                  credentials:
                    userName: gatewayPoolTenant
                    password: 
                  description: Created by Powershell at 7/23/2025 6:46:52 PM.
                  isThrottlingEnabled: false
                  throttlingValue: 
                  throttlingUnit: 
                  maxConcurrentTask: 1
                  isBackupProtectionEnabled: false
                  backupProtectionPeriod: 
                  gatewaySelectionType: GatewayPool
                  gatewayPoolsUids:
                    - b89ee2f8-027b-4307-b87f-41f8d8bbbac5
                  isGatewayFailoverEnabled: false
                  name: gatewayPoolTenant
                  hashedPassword: 
                  isEnabled: true
                  isBackupResourcesEnabled: true
                  isNativeReplicationResourcesEnabled: true
                  isVcdReplicationResourcesEnabled: false
                  assignedForCompany: c70316fc-a347-42c4-bc1d-524312815591
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/CloudTenant'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Cloud Connect
      summary: Modify Tenant
      description: Modifies a tenant with the specified UID.
      operationId: PatchTenant
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Tenant for Alpha company
                path: /description
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  siteUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  siteName: ccsrv1
                  type: General
                  vCloudOrganizationUid: 
                  lastActive: 
                  isLeaseExpirationEnabled: false
                  leaseExpirationDate: 
                  credentials:
                    userName: admin
                    password: 
                  description: Tenant for Alpha company
                  isThrottlingEnabled: false
                  throttlingValue: 
                  throttlingUnit: 
                  maxConcurrentTask: 1
                  isBackupProtectionEnabled: false
                  backupProtectionPeriod: 
                  gatewaySelectionType: StandaloneGateways
                  gatewayPoolsUids: [ ]
                  isGatewayFailoverEnabled: false
                  name: tnt1
                  hashedPassword: 
                  isEnabled: true
                  isBackupResourcesEnabled: false
                  isNativeReplicationResourcesEnabled: false
                  isVcdReplicationResourcesEnabled: false
                  assignedForCompany: 6f213654-b538-4695-ac69-aa677e41862e
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/CloudTenant'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    delete:
      tags:
        - Cloud Connect
      summary: Delete Tenant
      description: "Deletes a tenant with the specified UID.\n"
      operationId: DeleteTenant
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: deleteBackups
          in: query
          description: Defines if all backup files of a tenant must be deleted.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /infrastructure/sites/tenants/backupResources:
    get:
      tags:
        - Cloud Connect
      summary: Get All Tenant Backup Resources
      description: Returns a collection resource representation of all tenant cloud backup resources.
      operationId: GetTenantsBackupResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: bbd634fd-e881-4e03-8aaf-bec7beccd5fb
                    companyUid: bb591af2-7c6b-4bca-856b-603ae6088a1a
                    tenantUid: ed75e0e5-f56e-4957-b131-a677c390f99d
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    cloudRepositoryName: r1 repo
                    storageQuota: 4294967296
                    usedSpace: 0
                    serversQuota: 
                    isServersQuotaUnlimited: true
                    workstationsQuota: 
                    isWorkstationsQuotaUnlimited: true
                    vmsQuota: 
                    isVmsQuotaUnlimited: true
                    isWanAccelerationEnabled: false
                    wanAcceleratorUid: 
                    isDefault: true
                  - instanceUid: cfbfa0ec-702f-4a45-899e-9666b7446ce5
                    companyUid: 
                    tenantUid: 502b8967-b7b8-4196-9518-104572cf9525
                    siteUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    cloudRepositoryName: lrepo1
                    storageQuota: 107374182400
                    usedSpace: 0
                    serversQuota: 
                    isServersQuotaUnlimited: true
                    workstationsQuota: 
                    isWorkstationsQuotaUnlimited: true
                    vmsQuota: 
                    isVmsQuotaUnlimited: true
                    isWanAccelerationEnabled: true
                    wanAcceleratorUid: 5c601c47-e4f3-44d4-a0bd-fa5e120141d4
                    isDefault: true
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/backupResources':
    get:
      tags:
        - Cloud Connect
      summary: Get All Backup Resources Allocated to Tenant
      description: Returns a collection resource representation of all cloud backup resources allocated to a tenant with the specified UID.
      operationId: GetTenantBackupResources
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: bbd634fd-e881-4e03-8aaf-bec7beccd5fb
                    companyUid: bb591af2-7c6b-4bca-856b-603ae6088a1a
                    tenantUid: ed75e0e5-f56e-4957-b131-a677c390f99d
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    cloudRepositoryName: r1 repo
                    storageQuota: 4294967296
                    usedSpace: 0
                    serversQuota: 
                    isServersQuotaUnlimited: true
                    workstationsQuota: 
                    isWorkstationsQuotaUnlimited: true
                    vmsQuota: 
                    isVmsQuotaUnlimited: true
                    isWanAccelerationEnabled: false
                    wanAcceleratorUid: 
                    isDefault: true
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Cloud Connect
      summary: Create Tenant Backup Resource
      description: Allocate a new cloud backup resource to a tenant with the specified UID.
      operationId: CreateTenantBackupResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Cloud backup resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantBackupResourceInput'
            example:
              repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
              cloudRepositoryName: repo1
              storageQuota: 1073741824
              serversQuota: 1
              isServersQuotaUnlimited: false
              workstationsQuota: 1
              isWorkstationsQuotaUnlimited: false
              vmsQuota: 1
              isVmsQuotaUnlimited: false
              isWanAccelerationEnabled: true
              wanAcceleratorUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
              isDefault: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 6f213654-b538-4695-ac69-aa677e41862e
                  companyUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  tenantUid: b2fb8f33-9675-46d9-a114-6664e1044860
                  siteUid: c9a5bc4d-4577-4408-a309-9960b6107c4b
                  repositoryUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  cloudRepositoryName: repo1
                  storageQuota: 1073741824
                  usedSpace: 0
                  serversQuota: 1
                  isServersQuotaUnlimited: false
                  workstationsQuota: 1
                  isWorkstationsQuotaUnlimited: false
                  vmsQuota: 1
                  isVmsQuotaUnlimited: false
                  isWanAccelerationEnabled: true
                  wanAcceleratorUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  isDefault: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/sites/tenants/{tenantUid}/backupResources/usage':
    get:
      tags:
        - Cloud Connect
      summary: Get Usage of All Backup Resources Allocated to Tenant
      description: Returns a resource representation of cloud backup resource usage by a tenant with the specified UID.
      operationId: GetTenantBackupResourcesUsage
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantBackupResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - companyUid: c3436305-1731-4b05-bea7-958bb9812f01
                    tenantUid: babeac30-87de-4868-b5a3-f3ec112b41e8
                    backupResourceUid: 2c761a24-a0c5-4937-97ec-e59519eb9da5
                    storageQuota: 1073741824
                    usedStorageQuota: 0
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 0
                    workstationBackups: 0
                    vmBackups: 0
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/sites/tenants/backupResources/usage:
    get:
      tags:
        - Cloud Connect
      summary: Get Usage of All Tenant Backup Resources
      description: Returns a collection resource representation of cloud backup resource usage by all tenants.
      operationId: GetTenantsBackupResourcesUsages
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantBackupResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - companyUid: 6445321d-ca8e-4953-8ccc-2f95caa0452a
                    tenantUid: 7d33c59e-e220-4496-a5cb-e6b40f06c6aa
                    backupResourceUid: 44e8475a-3f8c-464d-a4f4-376cf3786e0a
                    storageQuota: 2147483648
                    usedStorageQuota: 0
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 0
                    workstationBackups: 0
                    vmBackups: 0
                  - companyUid: 320a9260-b2dd-4d6f-8ceb-d574121ff881
                    tenantUid: 34e7b2d1-8bf1-4d8c-b723-9a3a155ad41f
                    backupResourceUid: 01e9ad69-6ed2-479d-be93-e34140eb3061
                    storageQuota: 53687091200
                    usedStorageQuota: 14454620160
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 2
                    workstationBackups: 0
                    vmBackups: 1
                  - companyUid: 1fb1e82c-dbd1-443d-99b7-0602cb3dfb0a
                    tenantUid: f5266e36-fef4-4231-9a9d-11afb11b7f9c
                    backupResourceUid: bacf51a6-fd0e-45f6-9688-11480f2cd5a6
                    storageQuota: 10737418240
                    usedStorageQuota: 800063488
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 0
                    workstationBackups: 1
                    vmBackups: 0
                  - companyUid: f442e813-1cb5-4a41-98dd-9904a082ed02
                    tenantUid: db3e0f98-34d3-4f89-88bc-b8073805a845
                    backupResourceUid: cfba14fc-1e7d-49d0-b739-0a73bca8628a
                    storageQuota: 10737418240
                    usedStorageQuota: 9437184
                    archiveTierUsage: 0
                    capacityTierUsage: 0
                    performanceTierUsage: 0
                    serverBackups: 0
                    workstationBackups: 0
                    vmBackups: 0
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/backupResources/{resourceUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Tenant Backup Resource
      description: Returns a resource representation of tenant cloud backup resource with the specified UID.
      operationId: GetTenantBackupResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: resourceUid
          in: path
          description: Cloud backup resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 9eceb78d-9a56-481b-bbda-7e8fac5e0a89
                  companyUid: 
                  tenantUid: 1635f6f5-7542-4069-a11e-f7090eea6deb
                  siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                  repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                  cloudRepositoryName: r1 repo
                  storageQuota: 2147483648
                  usedSpace: 0
                  serversQuota: 1
                  isServersQuotaUnlimited: false
                  workstationsQuota: 1
                  isWorkstationsQuotaUnlimited: false
                  vmsQuota: 1
                  isVmsQuotaUnlimited: false
                  isWanAccelerationEnabled: true
                  wanAcceleratorUid: 5644e486-317c-4f04-9e97-30cc3997c2f9
                  isDefault: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/TenantBackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Cloud Connect
      summary: Modify Tenant Backup Resource
      description: Modifies a tenant cloud backup resource with the specified UID.
      operationId: PatchTenantBackupResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: resourceUid
          in: path
          description: Cloud backup resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 3221225472
                path: /StorageQuota
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantBackupResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  companyUid: 
                  tenantUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  siteUid: 6f213654-b538-4695-ac69-aa677e41862e
                  repositoryUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  cloudRepositoryName: rest repo
                  storageQuota: 3221225472
                  usedSpace: 0
                  serversQuota: 
                  isServersQuotaUnlimited: true
                  workstationsQuota: 
                  isWorkstationsQuotaUnlimited: true
                  vmsQuota: 
                  isVmsQuotaUnlimited: true
                  isWanAccelerationEnabled: true
                  wanAcceleratorUid: b2fb8f33-9675-46d9-a114-6664e1044860
                  isDefault: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/TenantBackupResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    delete:
      tags:
        - Cloud Connect
      summary: Delete Tenant Backup Resource
      description: Deletes a tenant cloud backup resource with the specified UID.
      operationId: DeleteTenantBackupResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: resourceUid
          in: path
          description: Cloud backup resource UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/sites/tenants/{tenantUid}/traffic':
    get:
      tags:
        - Cloud Connect
      summary: Get Tenant Traffic Resource
      description: Returns a resource representation of a cloud traffic quota configured for a tenant with the specified UID.
      operationId: GetTenantTrafficResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantTrafficResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                  tenantUid: 1070bd6b-8063-487c-ac9c-c95ca850175c
                  companyUid: c3436305-1731-4b05-bea7-958bb9812f01
                  dataTransferOutQuota: 
                  isDataTransferOutQuotaUnlimited: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/TenantTrafficResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Cloud Connect
      summary: Modify Tenant Traffic Resource
      description: Modifies cloud traffic quota configured for a tenant with the specified UID.
      operationId: PatchTenantTrafficResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 53687091200
                path: /dataTransferOutQuota
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantTrafficResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  siteUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  tenantUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  companyUid: 6f213654-b538-4695-ac69-aa677e41862e
                  dataTransferOutQuota: 53687091200
                  isDataTransferOutQuotaUnlimited: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/TenantTrafficResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /infrastructure/sites/tenants/replicationResources:
    get:
      tags:
        - Cloud Connect
      summary: Get All Tenant Replication Resources
      description: Returns a collection resource representation of all tenant cloud replication resources.
      operationId: GetTenantsReplicationResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7d33c59e-e220-4496-a5cb-e6b40f06c6aa
                    tenantUid: 7d33c59e-e220-4496-a5cb-e6b40f06c6aa
                    companyUid: 6445321d-ca8e-4953-8ccc-2f95caa0452a
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    hardwarePlans:
                      - hardwarePlanUid: bb41f407-412b-4928-9005-bfdc7690857b
                        isWanAccelerationEnabled: false
                        wanAcceleratorUid: 
                    isFailoverCapabilitiesEnabled: false
                    isPublicAllocationEnabled: false
                    numberOfPublicIps: 0
                  - instanceUid: 34e7b2d1-8bf1-4d8c-b723-9a3a155ad41f
                    tenantUid: 34e7b2d1-8bf1-4d8c-b723-9a3a155ad41f
                    companyUid: 320a9260-b2dd-4d6f-8ceb-d574121ff881
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    hardwarePlans:
                      - hardwarePlanUid: bb41f407-412b-4928-9005-bfdc7690857b
                        isWanAccelerationEnabled: false
                        wanAcceleratorUid: 
                    isFailoverCapabilitiesEnabled: false
                    isPublicAllocationEnabled: false
                    numberOfPublicIps: 0
                  - instanceUid: 7d8ad065-a11e-4d74-90b5-22eec69dd502
                    tenantUid: 7d8ad065-a11e-4d74-90b5-22eec69dd502
                    companyUid: c3436305-1731-4b05-bea7-958bb9812f01
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    hardwarePlans:
                      - hardwarePlanUid: bb41f407-412b-4928-9005-bfdc7690857b
                        isWanAccelerationEnabled: false
                        wanAcceleratorUid: 
                    isFailoverCapabilitiesEnabled: false
                    isPublicAllocationEnabled: false
                    numberOfPublicIps: 0
                  - instanceUid: 6a712d2a-e05e-46e1-9e57-34cf6eaa26d3
                    tenantUid: 6a712d2a-e05e-46e1-9e57-34cf6eaa26d3
                    companyUid: 72985f1c-5d52-4e0e-a0bd-51054a333c37
                    siteUid: 122160a7-d695-4a13-bc75-fcb32e8fe021
                    hardwarePlans:
                      - hardwarePlanUid: 39eb2caa-61d8-46f3-ac12-810f427223de
                        isWanAccelerationEnabled: false
                        wanAcceleratorUid: 
                    isFailoverCapabilitiesEnabled: false
                    isPublicAllocationEnabled: false
                    numberOfPublicIps: 0
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/replicationResources':
    get:
      tags:
        - Cloud Connect
      summary: Get All Replication Resources Allocated to Tenant
      description: Returns a collection resource representation of all cloud replication resources allocated to a tenant with the specified UID.
      operationId: GetTenantReplicationResources
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d9d61ec6-9cdb-4890-baf0-351b7091bde8
                  tenantUid: d9d61ec6-9cdb-4890-baf0-351b7091bde8
                  companyUid: 2b3f309c-34de-4c83-a23b-499ab1203cba
                  siteUid: bd295f5d-a805-43f2-9668-7e1efcc9a679
                  hardwarePlans:
                    - hardwarePlanUid: 0be241aa-7723-410e-be47-1f8e0a53bb56
                      isWanAccelerationEnabled: false
                      wanAcceleratorUid: 
                  isFailoverCapabilitiesEnabled: false
                  isPublicAllocationEnabled: false
                  numberOfPublicIps: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/TenantReplicationResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Cloud Connect
      summary: Create Tenant Replication Resource
      description: Allocates a new cloud replication resource to a tenant.
      operationId: CreateTenantReplicationResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Cloud replication resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantReplicationResourceInput'
            example:
              hardwarePlans:
                - hardwarePlanUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  isWanAccelerationEnabled: false
                  wanAcceleratorUid: 
              isFailoverCapabilitiesEnabled: false
              isPublicAllocationEnabled: false
              numberOfPublicIps: 0
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  tenantUid: 6f213654-b538-4695-ac69-aa677e41862e
                  companyUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  siteUid: b2fb8f33-9675-46d9-a114-6664e1044860
                  hardwarePlans:
                    - hardwarePlanUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                      isWanAccelerationEnabled: false
                      wanAcceleratorUid: 
                  isFailoverCapabilitiesEnabled: false
                  isPublicAllocationEnabled: false
                  numberOfPublicIps: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    patch:
      tags:
        - Cloud Connect
      summary: Modify Tenant Replication Resource
      description: Modifies a cloud replication resource allocated to a tenant with the specified UID.
      operationId: PatchTenantReplicationResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /IsFailoverCapabilitiesEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  tenantUid: 6f213654-b538-4695-ac69-aa677e41862e
                  companyUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  siteUid: b2fb8f33-9675-46d9-a114-6664e1044860
                  hardwarePlans:
                    - hardwarePlanUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                      isWanAccelerationEnabled: false
                      wanAcceleratorUid: 
                  isFailoverCapabilitiesEnabled: true
                  isPublicAllocationEnabled: false
                  numberOfPublicIps: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/TenantReplicationResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/sites/tenants/{tenantUid}/replicationResources/hardwarePlans/{hardwarePlanUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Tenant Hardware Plan
      description: Returns a resource representation of a tenant hardware plan with the specified UID.
      operationId: GetTenantReplicationResourceHardwarePlan
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: hardwarePlanUid
          in: path
          description: Hardware plan UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantReplicationResourceHardwarePlan'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  hardwarePlanUid: bb41f407-412b-4928-9005-bfdc7690857b
                  isWanAccelerationEnabled: false
                  wanAcceleratorUid: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/replicationResources/networkextensionAppliance':
    get:
      tags:
        - Cloud Connect
      summary: Get All Network Extension Appliances Allocated to Tenant
      description: Returns a collection resource representation of a network extension appliances configured for a tenant with the specified UID.
      operationId: GetTenantReplicationResourcesNetworkAppliances
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantReplicationResourceNetworkAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: ac2f4678-69ce-6efb-b479-c1797627adfe
                    name: r2_SP_NetworkAppliance
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    hostName: pdc159.tech.local
                    rootHostName: moonvc.tech.local
                    externalNetworkName: VM Network
                    tcpIpSettings:
                      dhcpEnabled: false
                      ipAddress: 172.27.21.165
                      subnetMask: 255.255.255.0
                      defaultGateway: 8.8.8.8
                  - instanceUid: 303ab2de-639f-4f4e-b0a5-2af4eaa2d718
                    name: nea1
                    hardwarePlanUid: 5e6bee18-a91e-4b1d-a77e-f9ae815b6730
                    hostName: nea1.tech.local
                    rootHostName: vc4.tech.local
                    externalNetworkName: VM Network
                    tcpIpSettings:
                      dhcpEnabled: false
                      ipAddress: 172.27.21.165
                      subnetMask: 255.255.255.0
                      defaultGateway: 8.8.8.8
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/replicationResources/networkextensionAppliance/{applianceUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Tenant Network Extension Appliance
      description: Returns a resource representation of a tenant network extension appliance with the specified UID.
      operationId: GetTenantReplicationResourcesNetworkAppliance
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: applianceUid
          in: path
          description: Network extension appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantReplicationResourceNetworkAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/TenantReplicationResourceNetworkAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Cloud Connect
      summary: Modify Tenant Network Extension Appliance
      description: Modifies a tenant network extension appliance with the specified UID.
      operationId: PatchTenantReplicationResourcesNetworkAppliance
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: applianceUid
          in: path
          description: Network extension appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: r2_SP_NetworkAppliance
                path: /Name
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantReplicationResourceNetworkAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: ac2f4678-69ce-6efb-b479-c1797627adfe
                  name: r2_SP_NetworkAppliance
                  hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                  hostName: pdc159.tech.local
                  rootHostName: moonvc.tech.local
                  externalNetworkName: VM Network
                  tcpIpSettings:
                    dhcpEnabled: false
                    ipAddress: 172.27.21.165
                    subnetMask: 255.255.255.0
                    defaultGateway: 8.8.8.8
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/TenantReplicationResourceNetworkAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /infrastructure/sites/tenants/replicationResources/usage:
    get:
      tags:
        - Cloud Connect
      summary: Get Usage of All Tenant Replication Resources
      description: Returns a collection resource representation of usage of all tenant replication resources.
      operationId: GetTenantsReplicationResourcesUsages
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantReplicationResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - hardwarePlanUid: 97fbce82-59f5-4140-99c7-27259641ae38
                    companyUid: 320a9260-b2dd-4d6f-8ceb-d574121ff881
                    tenantUid: 34e7b2d1-8bf1-4d8c-b723-9a3a155ad41f
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    vCPUsConsumed: 2
                    memoryUsage: 4294967296
                    storageUsage: 24296592528
                    hostsCoresCount: 0
                    numberOfVms: 1
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/replicationResources/usage':
    get:
      tags:
        - Cloud Connect
      summary: Get Usage of All Replication Resources Allocated to Tenant
      description: Returns a collection resource representation of usage of all cloud replication resources allocated to a tenant with the specified UID.
      operationId: GetTenantReplicationResourcesUsage
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantReplicationResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - hardwarePlanUid: 97fbce82-59f5-4140-99c7-27259641ae38
                    companyUid: 320a9260-b2dd-4d6f-8ceb-d574121ff881
                    tenantUid: 34e7b2d1-8bf1-4d8c-b723-9a3a155ad41f
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    vCPUsConsumed: 2
                    memoryUsage: 4294967296
                    storageUsage: 24296592528
                    hostsCoresCount: 0
                    numberOfVms: 1
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/sites/tenants/vcdReplicationResources:
    get:
      tags:
        - Cloud Connect
      summary: Get All Tenant VMware Cloud Director Replication Resources
      description: Returns a collection resource representation of all tenant VMware Cloud Director replication resources.
      operationId: GetTenantsVcdReplicationResources
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantVcdReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: b7ff8dae-7055-65cf-875e-07f13f8c3acb
                    tenantUid: 0e6480d7-a783-4c52-8d64-643e374448e9
                    companyUid: 5b47cffb-5c52-4e2b-9acf-a517cc5fd29e
                    siteUid: 554f80b2-1397-4d41-95bf-bb68443c6018
                    dataCenters:
                      - dataCenterUid: ca7d7f05-f43c-45bf-9b4b-343ee61d62c9
                        isWanAccelerationEnabled: false
                        wanAcceleratorUid: 
                    isFailoverCapabilitiesEnabled: false
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/vcdReplicationResources':
    get:
      tags:
        - Cloud Connect
      summary: Get All VMware Cloud Director Replication Resources Allocated to Tenant
      description: Returns a collection resource representation of all VMware Cloud Director replication resources allocated to a tenant with the specified UID.
      operationId: GetTenantVcdReplicationResources
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantVcdReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: b7ff8dae-7055-65cf-875e-07f13f8c3acb
                  tenantUid: 0e6480d7-a783-4c52-8d64-643e374448e9
                  companyUid: 5b47cffb-5c52-4e2b-9acf-a517cc5fd29e
                  siteUid: 554f80b2-1397-4d41-95bf-bb68443c6018
                  dataCenters:
                    - dataCenterUid: ca7d7f05-f43c-45bf-9b4b-343ee61d62c9
                      isWanAccelerationEnabled: false
                      wanAcceleratorUid: 
                  isFailoverCapabilitiesEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/TenantVcdReplicationResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Cloud Connect
      summary: Create Tenant VMware Cloud Director Replication Resource on Site
      description: Allocates a new VMware Cloud Director replication resource to a tenant with the specified UID.
      operationId: CreateTenantVcdReplicationResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: VMware Cloud Director replication resource properties.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TenantVcdReplicationResourceInput'
            example:
              dataCenters:
                - dataCenterUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  isWanAccelerationEnabled: false
                  wanAcceleratorUid: 
              isFailoverCapabilitiesEnabled: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantVcdReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  tenantUid: 6f213654-b538-4695-ac69-aa677e41862e
                  companyUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  siteUid: b2fb8f33-9675-46d9-a114-6664e1044860
                  dataCenters:
                    - dataCenterUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                      isWanAccelerationEnabled: false
                      wanAcceleratorUid: 
                  isFailoverCapabilitiesEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    patch:
      tags:
        - Cloud Connect
      summary: Modify Tenant VMware Cloud Director Replication Resource
      description: Modifies a VMware Cloud Director replication resource allocated to a tenant with the specified UID.
      operationId: PatchTenantVcdReplicationResource
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /IsFailoverCapabilitiesEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantVcdReplicationResource'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  tenantUid: 6f213654-b538-4695-ac69-aa677e41862e
                  companyUid: 716adb1a-49ab-42a1-84d9-103b96737834
                  siteUid: b2fb8f33-9675-46d9-a114-6664e1044860
                  dataCenters:
                    - dataCenterUid: ae61e533-82c7-4cb6-a030-78ae589cf49d
                      isWanAccelerationEnabled: true
                      wanAcceleratorUid: 
                  isFailoverCapabilitiesEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/TenantVcdReplicationResource'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/sites/tenants/{tenantUid}/vcdReplicationResources/dataCenters/{dataCenterUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Tenant Organization VDC
      description: Returns a resource representation of a tenant organization VDC with the specified UID.
      operationId: GetTenantVcdReplicationResourceDataCenter
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: dataCenterUid
          in: path
          description: Organization vDC UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantVcdReplicationResourceDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  dataCenterUid: 3fa85f64-5717-4562-b3fc-2c963f66afa6
                  isWanAccelerationEnabled: true
                  wanAcceleratorUid: 5e6bee18-a91e-4b1d-a77e-f9ae815b6730
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/sites/tenants/vcdReplicationResources/usage:
    get:
      tags:
        - Cloud Connect
      summary: Get Usage of All Tenant VMware Cloud Director Replication Resources
      description: Returns a collection resource representation of VMware Cloud Director replication resource usage by all tenants.
      operationId: GetTenantsVcdReplicationResourcesUsages
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantVcdReplicationResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - dataCenterUid: ca7d7f05-f43c-45bf-9b4b-343ee61d62c9
                    companyUid: b090d159-f5f1-40bc-86c0-02bb16ec356a
                    tenantUid: 75e1a597-f8ce-4c10-9632-f888ae08d2a5
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    cpuCountConsumed: 0
                    memoryUsage: 0
                    storageUsage: 1073741824
                  - dataCenterUid: 462228cd-ed1b-4aec-9cf8-14c9d7c28533
                    companyUid: 5f6e5f1c-03f3-4ac2-98cb-b2937fd5cc3c
                    tenantUid: 19605e1d-1aca-42a9-821d-fa54ee35cb29
                    siteUid: 4bc08f55-bb47-4af6-8cba-a9d5be445954
                    cpuCountConsumed: 0
                    memoryUsage: 0
                    storageUsage: 1073741824
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/vcdReplicationResources/usage':
    get:
      tags:
        - Cloud Connect
      summary: Get Usage of All VMware Cloud Director Replication Resources Allocated to Tenant
      description: Returns a collection resource representation of usage of all VMware Cloud Director replication resources allocated to a tenant with the specified UID.
      operationId: GetTenantVcdReplicationResourcesUsage
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantVcdReplicationResourceUsage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - dataCenterUid: ca7d7f05-f43c-45bf-9b4b-343ee61d62c9
                    companyUid: b090d159-f5f1-40bc-86c0-02bb16ec356a
                    tenantUid: 75e1a597-f8ce-4c10-9632-f888ae08d2a5
                    siteUid: 4d32d061-993c-4b69-b9a9-0ea2c9aa891e
                    cpuCountConsumed: 0
                    memoryUsage: 0
                    storageUsage: 1073741824
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/vcdReplicationResources/networkExtensionAppliance':
    get:
      tags:
        - Cloud Connect
      summary: Get All Network Extension Appliances Configured for Tenant
      description: Returns a collection resource representation of all network extension appliances configured for a tenant with the specified system ID.
      operationId: GetTenantVcdReplicationResourcesNetworkAppliances
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/TenantReplicationResourceVcdNetworkAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: fc639c0b-fc65-60f6-9e9f-89a3da15d93b
                    name: Alpha Network Extension Appliance
                    dataCenterUid: 462228cd-ed1b-4aec-9cf8-14c9d7c28533
                    dataCenterName: Alpha VDC
                    tcpIpSettings:
                      dhcpEnabled: true
                      ipAddress: 172.16.21.125
                      subnetMask: 255.255.255.0
                      defaultGateway: 8.8.8.8
                  - instanceUid: 57c03e1c-77c4-65eb-9f2d-796275a2fdd3
                    name: Alpha Network Extension Appliance
                    dataCenterUid: 9bb7e31a-52f9-45cc-85ae-6db2a8086400
                    dataCenterName: Beta VDC
                    tcpIpSettings:
                      dhcpEnabled: true
                      ipAddress: ''
                      subnetMask: ''
                      defaultGateway: ''
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/sites/tenants/{tenantUid}/vcdReplicationResources/networkExtensionAppliance/{applianceUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Tenant Network Extension Appliance
      description: Returns a resource representation of a tenant network extension appliance with the specified UID.
      operationId: GetTenantVcdReplicationResourcesNetworkAppliance
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: applianceUid
          in: path
          description: Network extension appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantReplicationResourceVcdNetworkAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: fc639c0b-fc65-60f6-9e9f-89a3da15d93b
                  name: Alpha Network Extension Appliance
                  dataCenterUid: 462228cd-ed1b-4aec-9cf8-14c9d7c28533
                  dataCenterName: Alpha VDC
                  tcpIpSettings:
                    dhcpEnabled: true
                    ipAddress: 172.16.21.125
                    subnetMask: 255.255.255.0
                    defaultGateway: 8.8.8.8
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/TenantReplicationResourceVcdNetworkAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Cloud Connect
      summary: Modify Tenant Network Extension Appliance
      description: Modifies a tenant network extension appliance with the specified UID.
      operationId: PatchTenantVcdReplicationResourcesNetworkAppliance
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: applianceUid
          in: path
          description: Network extension appliance UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: true
                path: /IsFailoverCapabilitiesEnabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/TenantReplicationResourceVcdNetworkAppliance'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 57c03e1c-77c4-65eb-9f2d-796275a2fdd3
                  name: r3 Network Extension Appliance
                  dataCenterUid: 9bb7e31a-52f9-45cc-85ae-6db2a8086400
                  dataCenterName: 2myVDC
                  tcpIpSettings:
                    dhcpEnabled: false
                    ipAddress: 172.27.21.165
                    subnetMask: 255.255.255.0
                    defaultGateway: 8.8.8.8
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/TenantReplicationResourceVcdNetworkAppliance'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /infrastructure/sites/tenants/subtenants:
    get:
      tags:
        - Cloud Connect
      summary: Get All Subtenants
      description: Returns a collection resource representation of all subtenants.
      operationId: GetSubTenants
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudSubTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 31ff2fde-7634-480e-873c-65a726e21517
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2valNet
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:54:45 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                  - instanceUid: 4b4eaf3b-312a-4411-9c88-ae5307d2b269
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2val
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:57:04 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                  - instanceUid: 08f0e030-ae78-40b6-b24b-118b870a7151
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2em
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:56:41 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                  - instanceUid: b4adff4c-9372-42ad-845a-c1ee106c8268
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2valRule
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:58:29 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/tenants/subtenants':
    get:
      tags:
        - Cloud Connect
      summary: Get All Subtenants Registered on Site
      description: Returns a collection resource representation of all subtenants provided with resources of a Veeam Cloud Connect site with the specified UID.
      operationId: GetSubTenantsBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudSubTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 31ff2fde-7634-480e-873c-65a726e21517
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2valNet
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:54:45 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                  - instanceUid: 4b4eaf3b-312a-4411-9c88-ae5307d2b269
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2val
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:57:04 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                  - instanceUid: 08f0e030-ae78-40b6-b24b-118b870a7151
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2em
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:56:41 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                  - instanceUid: b4adff4c-9372-42ad-845a-c1ee106c8268
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2valRule
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:58:29 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/tenants/{tenantUid}/subtenants':
    get:
      tags:
        - Cloud Connect
      summary: Get All Subtenants Registered by Tenant
      description: Returns a collection resource representation of all subtenants registered by a tenant with the specified UID.
      operationId: GetSubTenantsByTenant
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudSubTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 31ff2fde-7634-480e-873c-65a726e21517
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2valNet
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:54:45 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                  - instanceUid: 4b4eaf3b-312a-4411-9c88-ae5307d2b269
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2val
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:57:04 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                  - instanceUid: 08f0e030-ae78-40b6-b24b-118b870a7151
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2em
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:56:41 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                  - instanceUid: b4adff4c-9372-42ad-845a-c1ee106c8268
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    name: 3t1_r2valRule
                    description: Created by Veeam Service Provider Console at 1/18/2023 8:58:29 PM
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    isEnabled: true
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/tenants/subtenants/{subtenantUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Subtenant
      description: Returns a resource representation of a subtenant with the specified UID.
      operationId: GetSubTenant
      parameters:
        - name: subtenantUid
          in: path
          description: Subtenant UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/CloudSubTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 31ff2fde-7634-480e-873c-65a726e21517
                  tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                  name: t1_r2valNet
                  description: Created by Veeam Service Provider Console at 1/18/2023 8:54:45 PM
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  isEnabled: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/tenants/{tenantUid}/cloudGatewayPools':
    get:
      tags:
        - Cloud Connect
      summary: Get All Cloud Gateway Pools Assigned to Tenant
      description: Returns a collection resource representation of all cloud gateway pools assigned to a tenant with the specified UID.
      operationId: GetCloudGatewayPoolsByTenant
      parameters:
        - $ref: '#/components/parameters/tenantUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudGatewayPool'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 2c449807-d144-4845-80e7-09e4818fb4e4
                    name: Cloud gateway pool 1
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    numberOfGateways: 3
                  - instanceUid: e8c59d16-7202-4212-8d4e-7890205c5aa2
                    name: Cloud gateway pool 2
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    numberOfGateways: 4
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/tenants/products:
    get:
      tags:
        - Cloud Connect
      summary: Get Tenant Veeam Products
      description: Returns a collection resource representation of tenant Veeam products that generated cloud data the latest.
      operationId: GetCloudTenantsProducts
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudTenantProductVersionInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    productType: VBR
                    version: 12.0.0.1379
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    companyUid: 30780260-6bed-47eb-b1ac-d12de2ce5b9d
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    isVersionInfoAvailable: true
                  - instanceUid: d4d295a1-5a7e-4135-830a-f44c5bf15046
                    productType: Unknown
                    version: 6.0.0.958
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    companyUid: ada1a61e-caaf-4352-85ef-fae903037163
                    tenantUid: d4d295a1-5a7e-4135-830a-f44c5bf15046
                    isVersionInfoAvailable: true
                  - instanceUid: 904bcc58-c676-4f70-a4a6-754a5b50cc47
                    productType: Unknown
                    version: 5.0.0.4301
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    companyUid: ec1f3101-3703-4b6b-8d19-5b68b1fdf795
                    tenantUid: 904bcc58-c676-4f70-a4a6-754a5b50cc47
                    isVersionInfoAvailable: true
                  - instanceUid: 9de8e2f8-9272-4371-8c24-b86499446958
                    productType: Unknown
                    version: 6.0.0.958
                    siteUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    companyUid: ff98a69f-19dd-4a08-898e-a8a3562fe974
                    tenantUid: 9de8e2f8-9272-4371-8c24-b86499446958
                    isVersionInfoAvailable: true
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
  '/infrastructure/sites/{siteUid}/tenants/products':
    get:
      tags:
        - Cloud Connect
      summary: Get Tenant Veeam Products on Site
      description: Returns a collection resource representation of tenant Veeam products that generated the latest cloud data managed by a Veeam Cloud Connect site with the specified UID.
      operationId: GetCloudTenantsProductsBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/CloudTenantProductVersionInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    productType: VBR
                    version: 12.0.0.1379
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    companyUid: 30780260-6bed-47eb-b1ac-d12de2ce5b9d
                    tenantUid: 97f972eb-7f69-4340-be0b-132b8ad4bb11
                    isVersionInfoAvailable: true
                  - instanceUid: d4d295a1-5a7e-4135-830a-f44c5bf15046
                    productType: Unknown
                    version: 6.0.0.958
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    companyUid: ada1a61e-caaf-4352-85ef-fae903037163
                    tenantUid: d4d295a1-5a7e-4135-830a-f44c5bf15046
                    isVersionInfoAvailable: true
                  - instanceUid: 904bcc58-c676-4f70-a4a6-754a5b50cc47
                    productType: Unknown
                    version: 5.0.0.4301
                    siteUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    companyUid: ec1f3101-3703-4b6b-8d19-5b68b1fdf795
                    tenantUid: 904bcc58-c676-4f70-a4a6-754a5b50cc47
                    isVersionInfoAvailable: true
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - SiteAdministrator
  /infrastructure/sites/vcdServers:
    get:
      tags:
        - Cloud Connect
      summary: Get VMware Cloud Director Servers Managed by All Veeam Cloud Connect Sites
      description: Returns a collection resource representation of VMware Cloud Director servers managed by all Veeam Cloud Connect Sites.
      operationId: GetSitesVcdServers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e00d8da1-aad9-4180-979e-33dc7ae964db
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    name: vcd103.tech.local
                  - instanceUid: 1c353b11-a307-4369-8f83-265ae3984d63
                    backupServerUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    name: vcd103.tech.local
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers':
    get:
      tags:
        - Cloud Connect
      summary: Get All VMware Cloud Director Servers Managed by Veeam Cloud Connect Site
      description: Returns a collection resource representation of all VMware Cloud Director servers managed by a Veeam Cloud Connect site with the specified UID.
      operationId: GetVcdServersBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e00d8da1-aad9-4180-979e-33dc7ae964db
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    name: vcd103.tech.local
                  - instanceUid: 1c353b11-a307-4369-8f83-265ae3984d63
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    name: vcd103.tech.local
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers/{vcdServerUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get VMware Cloud Director Server Managed by Veeam Cloud Connect Site
      description: Returns a resource representation of a VMware Cloud Director server with the specified UID managed by a Veeam Cloud Connect site.
      operationId: GetSiteVcdServer
      parameters:
        - $ref: '#/components/parameters/vcdServerUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VcdServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: e00d8da1-aad9-4180-979e-33dc7ae964db
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  name: vcd103.tech.local
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/vcdServers/vcdOrganizations:
    get:
      tags:
        - Cloud Connect
      summary: Get VMware Cloud Director Organizations Managed by All Veeam Cloud Connect Sites
      description: Returns a collection resource representation of VMware Cloud Director organizations managed by all Veeam Cloud Connect sites.
      operationId: GetSitesVcdOrganizations
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0ab5b7e9-26e2-4a60-a264-44e8a16e4837
                    urn: urn:vcloud:org:0ab5b7e9-26e2-4a60-a264-44e8a16e4837
                    name: ivzMacOrg
                    vcdServerUid: fc84bb95-1f36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 0f040d72-b992-4bab-8b71-19a020a63501
                    urn: urn:vcloud:org:0f040d72-b992-4bab-8b71-19a020a63501
                    name: lis-2
                    vcdServerUid: fc84bb95-1f36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 114a3c6d-4754-4092-b346-d7a32c7bf720
                    urn: urn:vcloud:org:114a3c6d-4754-4092-b346-d7a32c7bf720
                    name: lis-3
                    vcdServerUid: fc84bb95-1f36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 1238f100-ccef-463b-9417-54d8e7bd5626
                    urn: urn:vcloud:org:1238f100-ccef-463b-9417-54d8e7bd5626
                    name: ESH1_org
                    vcdServerUid: fc84bb95-1f36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations':
    get:
      tags:
        - Cloud Connect
      summary: Get All VMware Cloud Director Organizations Managed by Veeam Cloud Connect Site
      description: Returns a collection resource representation of all VMware Cloud Director organizations managed by a Veeam Cloud Connect site with the specified UID.
      operationId: GetVcdOrganizationsBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0ab5b7e9-37e2-4a60-a264-44e8a16e4837
                    urn: urn:vcloud:org:0ab5b7e9-37e2-4a60-a264-44e8a16e4837
                    name: ivzMacOrg
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 0f040d72-c092-4bab-8b71-19a020a63501
                    urn: urn:vcloud:org:0f040d72-c092-4bab-8b71-19a020a63501
                    name: lis-2
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 114a3c6d-5854-4092-b346-d7a32c7bf720
                    urn: urn:vcloud:org:114a3c6d-5854-4092-b346-d7a32c7bf720
                    name: lis-3
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    urn: urn:vcloud:org:1238f100-ddef-463b-9417-54d8e7bd5626
                    name: ESH1_org
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers/{vcdServerUid}/vcdOrganizations':
    get:
      tags:
        - Cloud Connect
      summary: Get All Organizations Configured on VMware Cloud Director Server Managed by Veeam Cloud Connect Site
      description: Returns a collection resource representation of all VMware Cloud Director organizations configured on a VMware Cloud Director server with the specified UID managed by a Veeam Cloud Connect site.
      operationId: GetSitesVcdOrganizationsByVcd
      parameters:
        - name: vcdServerUid
          in: path
          description: VMware Cloud Director server UID.
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 0ab5b7e9-37e2-4a60-a264-44e8a16e4837
                    urn: urn:vcloud:org:0ab5b7e9-37e2-4a60-a264-44e8a16e4837
                    name: ivzMacOrg
                    vcdServerUid: ce41f4c8-f9fe-4e1c-a6f0-776cbbccbe66
                    backupServerUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 0f040d72-c092-4bab-8b71-19a020a63501
                    urn: urn:vcloud:org:0f040d72-c092-4bab-8b71-19a020a63501
                    name: lis-2
                    vcdServerUid: ce41f4c8-f9fe-4e1c-a6f0-776cbbccbe66
                    backupServerUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 114a3c6d-5854-4092-b346-d7a32c7bf720
                    urn: urn:vcloud:org:114a3c6d-5854-4092-b346-d7a32c7bf720
                    name: lis-3
                    vcdServerUid: ce41f4c8-f9fe-4e1c-a6f0-776cbbccbe66
                    backupServerUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    urn: urn:vcloud:org:1238f100-ddef-463b-9417-54d8e7bd5626
                    name: ESH1_org
                    vcdServerUid: ce41f4c8-f9fe-4e1c-a6f0-776cbbccbe66
                    backupServerUid: 6a467ae9-db57-4c61-ae5e-8c02c8a58a6f
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations/{vcdOrganizationUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get VMware Cloud Director Organization Managed by Veeam Cloud Connect Site
      description: Returns a resource representation of a VMware Cloud Director organization with the specified UID managed by Veeam Cloud Connect Site.
      operationId: GetSiteVcdOrganization
      parameters:
        - $ref: '#/components/parameters/vcdOrganizationUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VcdOrganization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 0ab5b7e9-37e2-4a60-a264-44e8a16e4837
                  urn: urn:vcloud:org:0ab5b7e9-37e2-4a60-a264-44e8a16e4837
                  name: ivzMacOrg
                  vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                  backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  hostedBackupServer: false
                  canBeMappedAsHostedResource: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/vcdServers/vcdOrganizations/vDCs:
    get:
      tags:
        - Cloud Connect
      summary: Get Organization VDCs Managed by All Veeam Cloud Connect Sites
      description: Returns a collection resource representation of organization VDCs managed by all Veeam Cloud Connect Sites.
      operationId: GetSitesVcdOrganizationVDCs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7aef4fbb-1a86-4250-ba97-aa98acd3e1f8
                    urn: urn:vcloud:vdc:7aef4fbb-1a86-4250-ba97-aa98acd3e1f8
                    vcdOrganizationUid: 0ab5b7e9-48e2-4a60-a264-44e8a16e4837
                    vcdOrganizationName: ivzMacOrg
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: macVdc
                  - instanceUid: 6968c137-f4aa-4110-876e-5c3c9c18769c
                    urn: urn:vcloud:vdc:6968c137-f4aa-4110-876e-5c3c9c18769c
                    vcdOrganizationUid: 0f040d72-c092-4bab-8b71-19a020a63501
                    vcdOrganizationName: lis-2
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: lis-vcd2
                  - instanceUid: c8bdc837-98bb-4e79-811b-ca2361b398be
                    urn: urn:vcloud:vdc:c8bdc837-98bb-4e79-811b-ca2361b398be
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    vcdOrganizationName: ESH1_org
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: ESH1_prg_vdc1
                  - instanceUid: 47a6ca3a-2628-4caf-a90b-c2276670b3bc
                    urn: urn:vcloud:vdc:47a6ca3a-2628-4caf-a90b-c2276670b3bc
                    vcdOrganizationUid: 210a8cbe-4407-4c7f-bb84-2c0137bd23a4
                    vcdOrganizationName: AEGVB
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: AEG_VB
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations/vDCs':
    get:
      tags:
        - Cloud Connect
      summary: Get All Organization VDCs Managed by Veeam Cloud Connect Site
      description: Returns a collection resource representation of all organization VDCs managed by a Veeam Cloud Connect site with the specified UID.
      operationId: GetVcdOrganizationVDCsBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7aef4fbb-1a86-4250-ba97-aa98acd3e1f8
                    urn: urn:vcloud:vdc:7aef4fbb-1a86-4250-ba97-aa98acd3e1f8
                    vcdOrganizationUid: 0ab5b7e9-37e2-4a60-a264-44e8a16e4837
                    vcdOrganizationName: ivzMacOrg
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: macVdc
                  - instanceUid: 6968c137-e3aa-4110-876e-5c3c9c18769c
                    urn: urn:vcloud:vdc:6968c137-e3aa-4110-876e-5c3c9c18769c
                    vcdOrganizationUid: 0f040d72-c092-4bab-8b71-19a020a63501
                    vcdOrganizationName: lis-2
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: lis-vcd2
                  - instanceUid: c8bdc837-98bb-4e79-811b-ca2361b398be
                    urn: urn:vcloud:vdc:c8bdc837-98bb-4e79-811b-ca2361b398be
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    vcdOrganizationName: ESH1_org
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: ESH1_prg_vdc1
                  - instanceUid: 47a6ca3a-2628-4caf-a90b-c2276670b3bc
                    urn: urn:vcloud:vdc:47a6ca3a-2628-4caf-a90b-c2276670b3bc
                    vcdOrganizationUid: 210a8cbe-4407-4c7f-bb84-2c0137bd23a4
                    vcdOrganizationName: AEGVB
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: AEG_VB
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations/{vcdOrganizationUid}/vDCs':
    get:
      tags:
        - Cloud Connect
      summary: Get All VDCs Providing Resources to VMware Cloud Director Organization Managed by Veeam Cloud Connect Site
      description: Returns a collection resource representation of all VDCs that provide resources to a VMware Cloud Director organization with the specified UID managed by a Veeam Cloud Connect Site.
      operationId: GetSitesVcdOrganizationVDCsByOrganization
      parameters:
        - $ref: '#/components/parameters/vcdOrganizationUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 462228cd-fe1b-4aec-9cf8-14c9d7c28533
                    urn: urn:vcloud:vdc:462228cd-fe1b-4aec-9cf8-14c9d7c28533
                    vcdOrganizationUid: 7b97bd44-d032-4bdb-aaae-841cb453312a
                    vcdOrganizationName: ivzOrg
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: myVDC
                  - instanceUid: 9bb7e31a-63f9-45cc-85ae-6db2a8086400
                    urn: urn:vcloud:vdc:9bb7e31a-63f9-45cc-85ae-6db2a8086400
                    vcdOrganizationUid: 7b97bd44-d032-4bdb-aaae-841cb453312a
                    vcdOrganizationName: ivzOrg
                    vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                    name: 2myVDC
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations/vDCs/{vdcUid}':
    get:
      tags:
        - Cloud Connect
      summary: Get Organization VDC Managed by Veeam Cloud Connect Site
      description: Returns a resource representation of an organization VDC with the specified UID managed by a Veeam Cloud Connect site.
      operationId: GetSiteVcdOrganizationVDC
      parameters:
        - name: vdcUid
          in: path
          description: Organization VDC UID.
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/siteUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VcdOrganizationDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 7aef4fbb-1a86-4250-ba97-aa98acd3e1f8
                  urn: urn:vcloud:vdc:7aef4fbb-1a86-4250-ba97-aa98acd3e1f8
                  vcdOrganizationUid: 0ab5b7e9-37e2-4a60-a264-44e8a16e4837
                  vcdOrganizationName: ivzMacOrg
                  vcdServerUid: fc84bb95-2a36-4cc7-9887-3a3213fca186
                  backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  name: macVdc
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/sites/vcdServers/vcdOrganizations/users:
    get:
      tags:
        - Cloud Connect
      summary: Get Users of VMware Cloud Director Organizations Managed by All Veeam Cloud Connect Sites
      description: Returns a collection resource representation of users of VMware Cloud Director organizations managed by all Veeam Cloud Connect sites.
      operationId: GetSitesVcdOrganizationUsers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationUser'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: urn:vcloud:user:5dfbdcc0-a757-444e-8f51-164d15e6660a
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user7
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  - instanceUid: urn:vcloud:user:61a49d91-cf23-48a6-a9e6-9af359924e15
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user1
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  - instanceUid: urn:vcloud:user:aa4da0b9-9e91-4857-8229-61c434dfd4b9
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user4
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  - instanceUid: urn:vcloud:user:c6648732-4347-4bfe-8e3d-9b9e6d451b5a
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user2
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations/users':
    get:
      tags:
        - Cloud Connect
      summary: Get Users of All VMware Cloud Director Organizations Managed by Veeam Cloud Connect Site
      description: Returns a collection resource representation of users of all VMware Cloud Director organizations managed by a Veeam Cloud Connect site with the specified UID.
      operationId: GetVcdOrganizationUsersBySite
      parameters:
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationUser'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: urn:vcloud:user:5dfbdcc0-a757-444e-8f51-164d15e6660a
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user7
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  - instanceUid: urn:vcloud:user:61a49d91-cf23-48a6-a9e6-9af359924e15
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user1
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  - instanceUid: urn:vcloud:user:aa4da0b9-9e91-4857-8229-61c434dfd4b9
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user4
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  - instanceUid: urn:vcloud:user:c6648732-4347-4bfe-8e3d-9b9e6d451b5a
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user2
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/sites/{siteUid}/vcdServers/vcdOrganizations/{vcdOrganizationUid}/users':
    get:
      tags:
        - Cloud Connect
      summary: Get Users of VMware Cloud Director Organization Managed by Veeam Cloud Connect Site
      description: Returns a collection resource representation of all users of a VMware Cloud Director organization with the specified UID managed by a Veeam Cloud Connect site.
      operationId: GetSiteVcdOrganizationUsersByOrganization
      parameters:
        - $ref: '#/components/parameters/vcdOrganizationUid_path'
        - $ref: '#/components/parameters/siteUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationUser'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: urn:vcloud:user:5dfbdcc0-a757-444e-8f51-164d15e6660a
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user7
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  - instanceUid: urn:vcloud:user:61a49d91-cf23-48a6-a9e6-9af359924e15
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user1
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  - instanceUid: urn:vcloud:user:aa4da0b9-9e91-4857-8229-61c434dfd4b9
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user4
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                  - instanceUid: urn:vcloud:user:c6648732-4347-4bfe-8e3d-9b9e6d451b5a
                    vcdOrganizationUid: 1238f100-ddef-463b-9417-54d8e7bd5626
                    name: esh1_user2
                    backupServerUid: c9c0e1c7-b756-4d52-a790-eb9f51ea9091
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /infrastructure/backupServers/vcdServers:
    get:
      tags:
        - Backup Servers
      summary: Get All VMware Cloud Director Servers
      description: Returns a collection resource representation of all VMware Cloud Director servers.
      operationId: GetVcdServers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e00d8da1-aad9-4180-979e-33dc7ae964db
                    backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                    name: vcd103.tech.local
                  - instanceUid: 1c353b11-a307-4369-8f83-265ae3984d63
                    backupServerUid: 56c7aef2-de29-4ab4-af54-9c29a34dcdb0
                    name: vcd103.tech.local
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers':
    get:
      tags:
        - Backup Servers
      summary: Get All VMware Cloud Director Servers Managed by Veeam Backup & Replication Server
      description: Returns a collection resource representation of all VMware Cloud Director servers managed by a Veeam Backup & Replication Server with the specified UID.
      operationId: GetVcdServersByBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-345f-4234-b8e8-5c8a559d6d3a
                    name: vcd10
                  - instanceUid: abf9889d-e147-4a6e-95b8-e98b768486ef
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    name: vcd103
                  - instanceUid: 2b955dd4-9e62-402d-b044-9635b0bca52c
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    name: vcd105
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/{vcdServerUid}':
    get:
      tags:
        - Backup Servers
      summary: Get VMware Cloud Director Server
      description: Returns a resource representation of a VMware Cloud Director server with the specified UID.
      operationId: GetVcdServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - $ref: '#/components/parameters/vcdServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VcdServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: e00d8da1-aad9-4180-979e-33dc7ae964db
                  backupServerUid: d83442bc-03fc-469b-be4e-f0761bfc9ddd
                  name: vcd103.tech.local
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/vcdServers/vcdOrganizations:
    get:
      tags:
        - Backup Servers
      summary: Get All VMware Cloud Director Organizations
      description: Returns a collection resource representation of all VMware Cloud Director organizations.
      operationId: GetVcdOrganizations
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    urn: urn:vcloud:org:066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: amg4
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 12424785-85b6-4415-a1a0-1cf904c9d033
                    urn: urn:vcloud:org:12424785-85b6-4415-a1a0-1cf904c9d033
                    name: rep
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 191d7960-cd70-468d-8287-c80b2afcce62
                    urn: urn:vcloud:org:191d7960-cd70-468d-8287-c80b2afcce62
                    name: ATVCD
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/vcdOrganizations':
    get:
      tags:
        - Backup Servers
      summary: Get All VMware Cloud Director Organizations Managed by Veeam Backup & Replication Server
      description: Returns a collection resource representation of all VMware Cloud Director organizations managed by a Veeam Backup & Replication server with the specified UID.
      operationId: GetVcdOrganizationsByBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: companyUid
          in: query
          description: "Company UID.\n>If you provide UID of a company with hosted resources, the operation returns only the VMware Cloud Director organizations that are associated with that company.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    urn: urn:vcloud:org:066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: amg4
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 12424785-85b6-4415-a1a0-1cf904c9d033
                    urn: urn:vcloud:org:12424785-85b6-4415-a1a0-1cf904c9d033
                    name: rep
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 191d7960-cd70-468d-8287-c80b2afcce62
                    urn: urn:vcloud:org:191d7960-cd70-468d-8287-c80b2afcce62
                    name: ATVCD
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/{vcdServerUid}/vcdOrganizations':
    get:
      tags:
        - Backup Servers
      summary: Get All VMware Cloud Director Organizations Configured on VMware Cloud Director Server
      description: Returns a collection resource representation of all VMware Cloud Director organizations configured on a VMware Cloud Director server with the specified UID.
      operationId: GetVcdOrganizationsByVcd
      parameters:
        - name: vcdServerUid
          in: path
          description: VMware Cloud Director server UID.
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: companyUid
          in: query
          description: "Company UID.\n>If you provide UID of a company with hosted resources, the operation returns only the VMware Cloud Director organizations that are associated with that company.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    urn: urn:vcloud:org:066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: amg4
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 12424785-85b6-4415-a1a0-1cf904c9d033
                    urn: urn:vcloud:org:12424785-85b6-4415-a1a0-1cf904c9d033
                    name: rep
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 191d7960-cd70-468d-8287-c80b2afcce62
                    urn: urn:vcloud:org:191d7960-cd70-468d-8287-c80b2afcce62
                    name: ATVCD
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/vcdOrganizations/{vcdOrganizationUid}':
    get:
      tags:
        - Backup Servers
      summary: Get VMware Cloud Director Organization
      description: Returns a resource representation of a VMware Cloud Director organization with the specified UID.
      operationId: GetVcdOrganization
      parameters:
        - $ref: '#/components/parameters/vcdOrganizationUid_path'
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VcdOrganization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 191d7960-cd70-468d-8287-c80b2afcce62
                  urn: urn:vcloud:org:191d7960-cd70-468d-8287-c80b2afcce62
                  name: ATVCD
                  vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                  backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                  hostedBackupServer: false
                  canBeMappedAsHostedResource: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/vcdServers/vcdOrganizations/vDCs:
    get:
      tags:
        - Backup Servers
      summary: Get All Organization VDCs
      description: Returns a collection resource representation of all organization VDCs.
      operationId: GetVcdOrganizationVDCs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    urn: urn:vcloud:org:066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: amg4
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 12424785-85b6-4415-a1a0-1cf904c9d033
                    urn: urn:vcloud:org:12424785-85b6-4415-a1a0-1cf904c9d033
                    name: rep
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 191d7960-cd70-468d-8287-c80b2afcce62
                    urn: urn:vcloud:org:191d7960-cd70-468d-8287-c80b2afcce62
                    name: ATVCD
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/vcdOrganizations/vDCs':
    get:
      tags:
        - Backup Servers
      summary: Get All Organization VDCs Managed by Veeam Backup & Replication Server
      description: Returns a collection resource representation of all organization VDCs managed by a Veeam Backup & Replication server with the specified UID.
      operationId: GetVcdOrganizationVDCsByBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    urn: urn:vcloud:org:066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: amg4
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 12424785-85b6-4415-a1a0-1cf904c9d033
                    urn: urn:vcloud:org:12424785-85b6-4415-a1a0-1cf904c9d033
                    name: rep
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 191d7960-cd70-468d-8287-c80b2afcce62
                    urn: urn:vcloud:org:191d7960-cd70-468d-8287-c80b2afcce62
                    name: ATVCD
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/{vcdServerUid}/vcdOrganizations/vDCs':
    get:
      tags:
        - Backup Servers
      summary: Get All Organization VDCs on VMware Cloud Director Server
      description: Returns a collection resource representation of all organization VDCs on a VMware Cloud Director Server with the specified UID.
      operationId: GetVcdOrganizationVDCsByVcd
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - $ref: '#/components/parameters/vcdServerUid_path'
        - name: companyUid
          in: query
          description: "Company UID.\n>If you provide UID of a company with hosted resources, the operation returns only the organization VDCs providing resources to that company.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    urn: urn:vcloud:org:066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: amg4
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 12424785-85b6-4415-a1a0-1cf904c9d033
                    urn: urn:vcloud:org:12424785-85b6-4415-a1a0-1cf904c9d033
                    name: rep
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 191d7960-cd70-468d-8287-c80b2afcce62
                    urn: urn:vcloud:org:191d7960-cd70-468d-8287-c80b2afcce62
                    name: ATVCD
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/vcdOrganizations/{vcdOrganizationUid}/vDCs':
    get:
      tags:
        - Backup Servers
      summary: Get All VDCs Providing Resources to VMware Cloud Director Organization
      description: Returns a collection resource representation of all VDCs that provide resources to a VMware Cloud Director organization with the specified UID.
      operationId: GetVcdOrganizationVDCsByOrganization
      parameters:
        - $ref: '#/components/parameters/vcdOrganizationUid_path'
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    urn: urn:vcloud:org:066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: amg4
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 12424785-85b6-4415-a1a0-1cf904c9d033
                    urn: urn:vcloud:org:12424785-85b6-4415-a1a0-1cf904c9d033
                    name: rep
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                  - instanceUid: 191d7960-cd70-468d-8287-c80b2afcce62
                    urn: urn:vcloud:org:191d7960-cd70-468d-8287-c80b2afcce62
                    name: ATVCD
                    vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    hostedBackupServer: false
                    canBeMappedAsHostedResource: false
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/vcdOrganizations/vDCs/{vdcUid}':
    get:
      tags:
        - Backup Servers
      summary: Get Organization VDC
      description: Returns a resource representation of an organization VDC with the specified UID.
      operationId: GetVcdOrganizationVDC
      parameters:
        - name: vdcUid
          in: path
          description: Organization VDC UID.
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VcdOrganizationDataCenter'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 191d7960-cd70-468d-8287-c80b2afcce62
                  urn: urn:vcloud:org:191d7960-cd70-468d-8287-c80b2afcce62
                  name: ATVCD
                  vcdServerUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                  backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                  hostedBackupServer: false
                  canBeMappedAsHostedResource: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/backupServers/vcdServers/vcdOrganizations/users:
    get:
      tags:
        - Backup Servers
      summary: Get Users of All VMware Cloud Director Organizations
      description: Returns a collection resource representation of users of all VMware Cloud Director organizations.
      operationId: GetVcdOrganizationUsers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationUser'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: urn:vcloud:user:22c78630-1895-4b7b-ab2b-011a49a44ae7
                    vcdOrganizationUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: st1
                    backupServerUid: 592a9947-345f-4234-b8e8-5c8a559d6d3a
                  - instanceUid: urn:vcloud:user:00a9867c-2eb7-40e6-80ba-1891db672b2b
                    vcdOrganizationUid: 204fe5ab-cb60-4d2a-874e-f6d7cc930a8d
                    name: sub
                    backupServerUid: 592a9947-345f-4234-b8e8-5c8a559d6d3a
                  - instanceUid: urn:vcloud:user:d6cdeb85-3d04-43d5-8211-e85fc535851f
                    vcdOrganizationUid: 5aebe37b-1b6f-421f-b210-834c3c4175bb
                    name: vsdsub
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/vcdOrganizations/users':
    get:
      tags:
        - Backup Servers
      summary: Get Users of All VMware Cloud Director Organizations Managed by Veeam Backup & Replication server
      description: Returns a collection resource representation of users of all VMware Cloud Director organizations managed by a Veeam Backup & Replication server with the specified UID.
      operationId: GetVcdOrganizationUsersByBackupServer
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationUser'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: urn:vcloud:user:22c78630-1895-4b7b-ab2b-011a49a44ae7
                    vcdOrganizationUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: st1
                    backupServerUid: 592a9947-345f-4234-b8e8-5c8a559d6d3a
                  - instanceUid: urn:vcloud:user:00a9867c-2eb7-40e6-80ba-1891db672b2b
                    vcdOrganizationUid: 204fe5ab-cb60-4d2a-874e-f6d7cc930a8d
                    name: sub
                    backupServerUid: 592a9947-345f-4234-b8e8-5c8a559d6d3a
                  - instanceUid: urn:vcloud:user:d6cdeb85-3d04-43d5-8211-e85fc535851f
                    vcdOrganizationUid: 5aebe37b-1b6f-421f-b210-834c3c4175bb
                    name: vsdsub
                    backupServerUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/vcdOrganizations/{vcdOrganizationUid}/users':
    get:
      tags:
        - Backup Servers
      summary: Get Users of VMware Cloud Director Organization
      description: Returns a collection resource representation of all users of a VMware Cloud Director organization with the specified UID.
      operationId: GetVcdOrganizationUsersByOrganization
      parameters:
        - $ref: '#/components/parameters/vcdOrganizationUid_path'
        - $ref: '#/components/parameters/backupServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VcdOrganizationUser'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: urn:vcloud:user:22c78630-1895-4b7b-ab2b-011a49a44ae7
                    vcdOrganizationUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: st1
                    backupServerUid: 592a9947-345f-4234-b8e8-5c8a559d6d3a
                  - instanceUid: urn:vcloud:user:00a9867c-2eb7-40e6-80ba-1891db672b2b
                    vcdOrganizationUid: 066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: sub
                    backupServerUid: 592a9947-345f-4234-b8e8-5c8a559d6d3a
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/{vcdServerUid}/vcdOrganizations/vDCs/vApps':
    get:
      tags:
        - Backup Servers
      summary: Get vApps Configured on VMware Cloud Director Server
      description: Returns a collection resource representation of all vApps configured on a VMware Cloud Director server with the specified UID.
      operationId: GetVcdOrganizationVAppsByVcd
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - $ref: '#/components/parameters/vcdServerUid_path'
        - name: companyUid
          in: query
          description: "Company UID.\n> If you provide UID of a company with hosted resources, the operation returns only the vApps available to that company.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: nameFilter
          in: query
          description: "Name or part of name of vApps that must be returned by the operation.\n> This parameter is recommended over the `filter` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            type: string
            nullable: true
        - name: vcdOrganizationUidFilter
          in: query
          description: "UID assigned to a VMware Cloud Director organization that must be returned by the operation.\n> This parameter is recommended over the `filter` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: nameSortingDirection
          in: query
          description: "Type of the resource alphabetical sorting by vApp name.\n> This parameter is recommended over the `sort` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            enum:
              - ascending
              - descending
            type: string
            default: ascending
            x-ms-enum:
              name: SortDirection
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVirtualApplication'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - urn: urn:vcloud:org:066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: st1
                    vcdOrganizationUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    vcdOrganizationName: amg4
                  - urn: urn:vcloud:org:12424785-85b6-4415-a1a0-1cf904c9d033
                    name: rep
                    vcdOrganizationUid: 191d7960-cd70-468d-8287-c80b2afcce62
                    vcdOrganizationName: ATVCD
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/{vcdServerUid}/vcdOrganizations/vDCs/virtualMachines':
    get:
      tags:
        - Backup Servers
      summary: Get VMs Configured on VMware Cloud Director Server
      description: Returns a collection resource representation of all VMs configured on a VMware Cloud Director server with the specified UID.
      operationId: GetVcdOrganizationVirtualMachinesByVcd
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - $ref: '#/components/parameters/vcdServerUid_path'
        - name: companyUid
          in: query
          description: "Company UID.\n> If you provide UID of a company with hosted resources, the operation returns only the VMs available to that company.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: nameFilter
          in: query
          description: "Name or part of name of VMs that must be returned by the operation.\n> This parameter is recommended over the `filter` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            type: string
            nullable: true
        - name: vcdOrganizationUidFilter
          in: query
          description: "UID assigned to a VMware Cloud Director organization that must be returned by the operation.\n> This parameter is recommended over the `filter` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: nameSortingDirection
          in: query
          description: "Type of the resource alphabetical sorting by VM name.\n> This parameter is recommended over the `sort` expression due to being processed on the Veeam Backup & Replication server side.\n"
          schema:
            enum:
              - ascending
              - descending
            type: string
            default: ascending
            x-ms-enum:
              name: SortDirection
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerVcdVirtualMachine'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - urn: urn:vcloud:org:066bb122-bfe1-46bc-ad6f-05a827712a14
                    name: st1
                    size: 3263012037
                    vcdOrganizationUid: 953ca678-10c3-4069-a7d0-8ca0bc5b4751
                    vcdOrganizationName: amg4
                  - urn: urn:vcloud:org:12424785-85b6-4415-a1a0-1cf904c9d033
                    name: rep
                    size: 4522304692
                    vcdOrganizationUid: 191d7960-cd70-468d-8287-c80b2afcce62
                    vcdOrganizationName: ATVCD
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/backupServers/{backupServerUid}/vcdServers/{vcdServerUid}/objects/expand':
    post:
      tags:
        - Backup Servers
      summary: Get VMs in VMware Cloud Director Containers
      description: Returns a collection resource representation of VMs in specified VMware Cloud Director containers.
      operationId: ExpandBackupServerCloudDirectorObjectContainers
      parameters:
        - $ref: '#/components/parameters/backupServerUid_path'
        - $ref: '#/components/parameters/vcdServerUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of VMware Cloud Director containers.
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/BackupServerCloudDirectorObject'
            example:
              - hostName: vcd01.tech.local
                name: ESH5_org
                type: Organization
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/BackupServerCloudDirectorObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - hostName: vcd01.tech.local
                    name: ESH5_org
                    type: Organization
                    objectId: 
                    size: 
                    vcdOrganizationName: 
                    vcdOrganizationUid: 
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /deployment/deploy:
    get:
      tags:
        - Deployment
      summary: Get All Deployment Tasks
      description: Returns a collection resource representation of all deployment tasks.
      operationId: GetDeploymentTasks
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/DeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: ec1bfef5-9a1d-4a94-ae0b-abf02a9b7ecd
                    managementAgentUid: 0747762f-48dd-49b3-a1dd-17d5d5e03de1
                    type: Discovery
                    status: Success
                    startDate: '2025-07-24T02:47:07.4946206+02:00'
                    endDate: '2025-07-24T02:47:25.3861610+02:00'
                    errorMessage: 
                  - instanceUid: 0c53d729-b688-40bd-b036-569e3458227d
                    managementAgentUid: 0747762f-48dd-49b3-a1dd-17d5d5e03de1
                    type: DeployVbr
                    status: Success
                    startDate: '2025-07-24T02:47:40.7716958+02:00'
                    endDate: '2025-07-24T03:37:44.2842164+02:00'
                    errorMessage: 
                  - instanceUid: 737be2ee-39b5-44e4-be6a-c066ef0793ae
                    managementAgentUid: 49de20dd-793c-49d9-9ded-cfaa42650fc5
                    type: DeployVbr
                    status: Success
                    startDate: '2025-07-24T02:47:40.7914625+02:00'
                    endDate: '2025-07-24T03:47:11.6758635+02:00'
                    errorMessage: 
                  - instanceUid: 77b9a5f0-7af9-4162-bb85-89350cbed367
                    managementAgentUid: 7ad1c8bb-b889-454f-b5f4-853f54124329
                    type: DeployVbr
                    status: Success
                    startDate: '2025-07-24T02:47:40.9762109+02:00'
                    endDate: '2025-07-24T03:38:35.9165400+02:00'
                    errorMessage: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/deployment/deploy/{deploymentTaskUid}':
    get:
      tags:
        - Deployment
      summary: Get Deployment Task
      description: Returns a resource representation of a deployment task with the specified UID.
      operationId: GetDeploymentTask
      parameters:
        - name: deploymentTaskUid
          in: path
          description: Deployment task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DeploymentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 10f3751e-06d4-4def-aa83-707c3b7c1724
                  managementAgentUid: db3d05ce-e41f-4fdb-a85a-c3b49fcafa9c
                  type: DeployVbr
                  status: Success
                  startDate: '2025-07-24T02:50:34.8036948+02:00'
                  endDate: '2025-07-24T03:31:21.2040524+02:00'
                  errorMessage: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/deployment/deploy/{deploymentTaskUid}/wait':
    post:
      tags:
        - Deployment
      summary: Run Waiting Task for Deployment Task
      description: Initiates an async action that waits for a deployment task with the specified UID to complete.
      operationId: WaitDeploymentTask
      parameters:
        - name: deploymentTaskUid
          in: path
          description: Deployment task UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/deployment/deploy/{deploymentTaskUid}/log/{managementAgentUid}':
    get:
      tags:
        - Deployment
      summary: Get Deployment Task Status
      description: Returns a resource representation of deployment task status.
      operationId: GetDeploymentLog
      parameters:
        - name: deploymentTaskUid
          in: path
          description: Deployment task UID.
          required: true
          schema:
            type: string
            format: uuid
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DeploymentLog'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  completePercentage: 60
                  status: success
                  logEntries:
                    - taskUid: 2c03cab0-5bb6-4f18-be71-47e3b92e0f39
                      event: 2
                      managementAgentUid: 7db71174-9db8-4c47-92c0-9a9118acefd8
                      biosUuid: 48ff3f42-8e37-71a0-ea7c-901e84aabaa9
                      hostName: vbr2.tech.local
                      taskName: Deploy
                      message: Adding task to the queue
                      time: '2023-11-19T03:11:15.4470000+01:00'
                    - taskUid: 2c03cab0-5bb6-4f18-be71-47e3b92e0f39
                      event: 6
                      managementAgentUid: 7db71174-9db8-4c47-92c0-9a9118acefd8
                      biosUuid: 48ff3f42-8e37-71a0-ea7c-901e84aabaa9
                      hostName: vbr2.tech.local
                      taskName: Deploy
                      message: Downloading management agent to the master agent
                      time: '2023-11-19T03:11:26.4301183+01:00'
                    - taskUid: 2c03cab0-5bb6-4f18-be71-47e3b92e0f39
                      event: 7
                      managementAgentUid: 7db71174-9db8-4c47-92c0-9a9118acefd8
                      biosUuid: 48ff3f42-8e37-71a0-ea7c-901e84aabaa9
                      hostName: vbr2.tech.local
                      taskName: Deploy
                      message: Saving management agent to the local folder
                      time: '2023-11-19T03:11:33.6234448+01:00'
                    - taskUid: 2c03cab0-5bb6-4f18-be71-47e3b92e0f39
                      event: 116
                      managementAgentUid: 7db71174-9db8-4c47-92c0-9a9118acefd8
                      biosUuid: 48ff3f42-8e37-71a0-ea7c-901e84aabaa9
                      hostName: vbr2.tech.local
                      taskName: Deploy
                      message: Downloading Veeam Backup & Replication installation files to the master agent
                      time: '2023-11-19T03:11:33.7328244+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /deployment/deploy/backupServers/configuration/xml:
    get:
      tags:
        - Deployment
      summary: Get Example for Veeam Backup & Replication Server Deployment Configuration
      description: "Returns a resource representation of an example for Veeam Backup & Replication server deployment configuration in the `XML` format.\n> Error response is returned in the `JSON` format.\n"
      operationId: GetBackupServerDeploymentConfigurationXml
      parameters:
        - name: backupServerDeploymentType
          in: query
          description: Deployment type.
          required: true
          schema:
            enum:
              - installation
              - upgrade
            type: string
            x-ms-enum:
              name: BackupServerDeploymentType
        - name: managementAgentUid
          in: query
          description: "UID assigned to a management agent installed on a server on which Veeam Backup & Replication must be deployed. \n> If Veeam Backup & Replication is already installed on the server, Veeam Service Provider Console will automatically provide a configuration file suitable for the installed version.\n> If Veeam Backup & Replication is not installed, Veeam Service Provider Console will provide a configuration file suitable for the latest Veeam Backup & Replication version.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: escapeCharacters
          in: query
          description: Defines whether escape characters are enabled.
          schema:
            type: boolean
            default: false
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                type: object
                description: Deployment configuration example in the `XML` format.
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/managementAgents/{managementAgentUid}/hosted/linux':
    get:
      tags:
        - Deployment
      summary: Get Management Agent Deployment Parameters for Linux Computers
      description: Returns a resource representation of parameters for management agent deployment on Linux computers.
      operationId: GetHostedAgentLinux
      parameters:
        - $ref: '#/components/parameters/managementAgentUid_path'
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/HostedAgentLinuxSaveParams'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  managementAgentUid: 2214be4e-a0bc-479d-83a9-5a975de7171e
                  connectionCredential:
                    connection:
                      hostname: vbr11cc
                      port: 0
                      trustedThumbprint: 
                      serverType: CloudConnect
                    userName: administrator
                    password: ••••••
                  description: Created by My Company in Veeam Service Provider Console at 8/8/2025 8:59 AM
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /protectedWorkloads/publicCloud/virtualMachines:
    get:
      tags:
        - Protected Public Cloud Workloads
      summary: Get All Protected Cloud VMs
      description: Returns a collection resource representation of all protected cloud VMs.
      operationId: GetProtectedCloudVirtualMachines
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudVirtualMachine'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 60abf3e0-29d5-42a9-bf2b-942cf728bdeb
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    name: temp-vm
                    applianceUid: 82db3391-e51f-4179-bc92-d9ffa3c68245
                    platformType: Amazon
                    resourceId: i-05a5e76e6c17ff48c
                    destinations:
                      - dm-repo-temp
                      - EU (Frankfurt)
                      - EU (Stockholm)
                      - dm-repo-s3 glacier
                    latestBackupDate: '2024-07-18T05:17:49.0000000+02:00'
                  - instanceUid: 5908f76b-173c-4406-be67-238b4d866123
                    backupServerUid: a5838753-b6e3-4692-8b6f-278caa3c58a1
                    organizationUid: cb633f3a-1d38-4b66-9312-093475829f15
                    name: vc-4-m3
                    applianceUid: 8612ce63-2161-49cb-8c2a-3a7af3ac53b1
                    platformType: Amazon
                    resourceId: i-051ad7eaae316ce0f
                    destinations:
                      - dm-rep-m3
                      - EU (Frankfurt)
                    latestBackupDate: '2024-07-18T03:44:57.0000000+02:00'
                  - instanceUid: c1ff6fe4-6f50-4bc3-8589-5d23919c53c7
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    name: az-aws-fk-01
                    applianceUid: 82db3391-e51f-4179-bc92-d9ffa3c68245
                    platformType: Amazon
                    resourceId: i-00e287c62ca682763
                    destinations:
                      - EU (Frankfurt)
                    latestBackupDate: 
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/publicCloud/virtualMachines/backups:
    get:
      tags:
        - Preview Operations
      summary: Get Backups of All Protected Cloud VMs
      description: "Returns a collection resource representation of all backups of protected cloud VMs.\n>This operation is not optimized for large-scale environments.\n"
      operationId: GetProtectedCloudVirtualMachinesBackups
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudVirtualMachineBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - cloudVirtualMachineUid: 5908f76b-173c-4406-be67-238b4d866123
                    policyUid: 226cea04-f365-4d79-a84d-2a96593bbbae
                    policyName: DM_p3
                    backupType: Snapshot
                    destination: EU (Frankfurt)
                    size: 8589934592
                    restorePoints: 2
                    latestRestorePointDate: '2024-07-18T03:44:57.7830000+02:00'
                  - cloudVirtualMachineUid: 60abf3e0-29d5-42a9-bf2b-942cf728bdeb
                    policyUid: 4266aa24-bf37-4eef-94bb-6f7a23e7bf93
                    policyName: dmlatest-temp-policy
                    backupType: Backup
                    destination: dm-repo-temp
                    size: 882631048
                    restorePoints: 58
                    latestRestorePointDate: '2024-07-18T05:17:49.0000000+02:00'
                  - cloudVirtualMachineUid: 60abf3e0-29d5-42a9-bf2b-942cf728bdeb
                    policyUid: 4266aa24-bf37-4eef-94bb-6f7a23e7bf93
                    policyName: dmlatest-temp-policy
                    backupType: Snapshot
                    destination: EU (Frankfurt)
                    size: 881491598
                    restorePoints: 10
                    latestRestorePointDate: '2024-07-18T05:17:49.2130000+02:00'
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/publicCloud/virtualMachines/{cloudVirtualMachineUid}/backups':
    get:
      tags:
        - Protected Public Cloud Workloads
      summary: Get All Backups of Protected Cloud VM
      description: Returns a collection resource representation of all backups of a protected cloud VM with the specified UID.
      operationId: GetProtectedCloudVirtualMachineBackupsByVm
      parameters:
        - name: cloudVirtualMachineUid
          in: path
          description: Cloud virtual machine UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudVirtualMachineBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - cloudVirtualMachineUid: 5908f76b-173c-4406-be67-238b4d866123
                    policyUid: 226cea04-f365-4d79-a84d-2a96593bbbae
                    policyName: DM_p3
                    backupType: Snapshot
                    destination: EU (Frankfurt)
                    size: 8589934592
                    restorePoints: 2
                    latestRestorePointDate: '2024-07-18T03:44:57.7830000+02:00'
                  - cloudVirtualMachineUid: 5908f76b-173c-4406-be67-238b4d866123
                    policyUid: 4266aa24-bf37-4eef-94bb-6f7a23e7bf93
                    policyName: dmlatest-temp-policy
                    backupType: Backup
                    destination: dm-repo-temp
                    size: 882631048
                    restorePoints: 3
                    latestRestorePointDate: '2024-07-18T05:17:49.0000000+02:00'
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/publicCloud/databases:
    get:
      tags:
        - Protected Public Cloud Workloads
      summary: Get All Protected Cloud Databases
      description: Returns a collection resource representation of all protected cloud databases.
      operationId: GetProtectedCloudDatabases
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudDatabase'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 99b7acde-b67d-45d3-8c6c-1ee7052f45f9
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    name: database-aws-2
                    applianceUid: 82db3391-e51f-4179-bc92-d9ffa3c68245
                    region: Europe (Frankfurt)
                    resourceId: rdscluster-eu-central-1-database-aws-2-20342104132914
                    hierarchyRootName: AWS
                    latestBackupDate: 
                    latestArchiveDate: 
                    latestSnapshotDate: '2024-07-17T10:13:50.6000000+02:00'
                    latestReplicaSnapshotDate: 
                    backupCount: 0
                    archiveCount: 0
                    snapshotCount: 5
                    replicaSnapshotCount: 0
                    instanceSize: 0
                    totalSize: 0
                    platform: Amazon
                    databaseType: AwsRds
                    engineType: AuroraDbMySql
                  - instanceUid: a0e8b7f3-a3bf-43dd-96b9-f8f26e005b38
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    name: database-aws-3
                    applianceUid: 82db3391-e51f-4179-bc92-d9ffa3c68245
                    region: Europe (Frankfurt)
                    resourceId: rdsi-eu-central-1-db-sipemu247xbg8rfyei5sg2dn3n
                    hierarchyRootName: AWS
                    latestBackupDate: 
                    latestArchiveDate: 
                    latestSnapshotDate: '2024-07-17T10:09:17.2300000+02:00'
                    latestReplicaSnapshotDate: 
                    backupCount: 0
                    archiveCount: 0
                    snapshotCount: 22
                    replicaSnapshotCount: 0
                    instanceSize: 21474836480
                    totalSize: 0
                    platform: Amazon
                    databaseType: AwsRds
                    engineType: Postgres
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/publicCloud/databases/backups:
    get:
      tags:
        - Preview Operations
      summary: Get Backups of All Protected Cloud Databases
      description: "Returns a collection resource representation of all backups of protected cloud databases.\n> This operation is not optimized for large-scale environments.\n"
      operationId: GetProtectedCloudDatabasesBackups
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudDatabaseBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - databaseUid: 1af37cd9-3d8c-4263-aa31-3203b066780b
                    policyUid: 
                    policyName: 
                    backupType: Snapshot
                    size: 0
                    destinations:
                      - EU (Frankfurt)
                      - EU (Stockholm)
                    restorePoints: 7
                    latestRestorePointDate: '2024-07-18T02:57:46.8070000+02:00'
                    databaseType: AwsRds
                    engineType: Postgres
                  - databaseUid: 99b7acde-b67d-45d3-8c6c-1ee7052f45f9
                    policyUid: 
                    policyName: 
                    backupType: Snapshot
                    size: 0
                    destinations:
                      - EU (Frankfurt)
                    restorePoints: 5
                    latestRestorePointDate: '2024-07-17T10:13:50.6000000+02:00'
                    databaseType: AwsRds
                    engineType: AuroraDbMySql
                  - databaseUid: a0e8b7f3-a3bf-43dd-96b9-f8f26e005b38
                    policyUid: 
                    policyName: 
                    backupType: Snapshot
                    size: 0
                    destinations:
                      - EU (Frankfurt)
                    restorePoints: 22
                    latestRestorePointDate: '2024-07-17T10:09:17.2300000+02:00'
                    databaseType: AwsRds
                    engineType: Postgres
                  - databaseUid: f7ec0d08-fd83-4714-ae0b-b7bbf8892fda
                    policyUid: cfd8941b-b717-430d-b4a0-a581e074b2ba
                    policyName: dm-latest-temp-rds-policy
                    backupType: Snapshot
                    size: 0
                    destinations:
                      - EU (Frankfurt)
                    restorePoints: 5
                    latestRestorePointDate: '2024-03-08T00:00:16.9570000+01:00'
                    databaseType: AwsRds
                    engineType: AuroraDbPostgres
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/publicCloud/databases/{databaseUid}/backups':
    get:
      tags:
        - Protected Public Cloud Workloads
      summary: Get All Backups of Protected Cloud Database
      description: Returns a collection resource representation of all backups of a protected cloud database with the specified UID.
      operationId: GetProtectedCloudDatabaseBackupsByDatabase
      parameters:
        - name: databaseUid
          in: path
          description: Cloud Database UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudDatabaseBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - databaseUid: f7ec0d08-fd83-4714-ae0b-b7bbf8892fda
                    policyUid: 
                    policyName: 
                    backupType: Snapshot
                    size: 0
                    destinations:
                      - EU (Frankfurt)
                    restorePoints: 25
                    latestRestorePointDate: '2024-07-16T21:23:59.3630000+02:00'
                    databaseType: AwsRds
                    engineType: AuroraDbPostgres
                  - databaseUid: f7ec0d08-fd83-4714-ae0b-b7bbf8892fda
                    policyUid: cfd8941b-b717-430d-b4a0-a581e074b2ba
                    policyName: dm-latest-temp-rds-policy
                    backupType: Snapshot
                    size: 0
                    destinations:
                      - EU (Frankfurt)
                    restorePoints: 5
                    latestRestorePointDate: '2024-03-08T00:00:16.9570000+01:00'
                    databaseType: AwsRds
                    engineType: AuroraDbPostgres
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/virtualMachines:
    get:
      tags:
        - Protected Workloads
      summary: Get All Protected VMs
      description: Returns a collection resource representation of all protected VMs.
      operationId: GetProtectedVirtualMachines
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedVirtualMachine'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: ca7f983f-3e17-33e1-0433-65857ea7c6a1
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    organizationUid: 2da90254-8fe3-4df5-94c3-b68420fbfe23
                    name: autoJob
                    hierarchyRef: vm-11093
                    parentHostRef: moonvc.tech.local
                    objectUid: af72f78a-9d03-44ad-aa0c-94a651630247
                    ipAddresses: [ ]
                    provisionedSourceSize: 0
                    usedSourceSize: 
                    totalRestorePointSize: 3260416
                    latestRestorePointSize: 1630208
                    restorePoints: 2
                    latestRestorePointDate: '2025-07-27T01:04:08.6870000+02:00'
                    jobUid: befa7f86-a1bf-4f24-bbd3-ddab68ae4edd
                    malwareState: Unverified
                    immutable: false
                  - instanceUid: b899fa31-a8b8-c1b5-cae7-88afbed92ef1
                    backupServerUid: 10776b3b-1b2c-4601-8568-3e71a9786e12
                    organizationUid: 20594bdd-93da-4a53-9deb-61c632e80d0c
                    name: BackupJob1
                    hierarchyRef: vm-11093
                    parentHostRef: moonvc.tech.local
                    objectUid: 118bc566-2fea-4942-9c5a-d163c030cb9e
                    ipAddresses: [ ]
                    provisionedSourceSize: 0
                    usedSourceSize: 
                    totalRestorePointSize: 3260416
                    latestRestorePointSize: 1630208
                    restorePoints: 5
                    latestRestorePointDate: '2025-07-27T01:33:03.4300000+02:00'
                    jobUid: 3319413c-70b3-4dee-b0b7-f692d458e3ba
                    malwareState: Unverified
                    immutable: false
                  - instanceUid: 13c15b2e-c6bf-0f98-28bf-ea347a1f8117
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    organizationUid: 2da90254-8fe3-4df5-94c3-b68420fbfe23
                    name: ivz10
                    hierarchyRef: vm-79
                    parentHostRef: moonvc.tech.local
                    objectUid: e401aa2b-59c3-4749-8df8-886f38ef9376
                    ipAddresses: [ ]
                    provisionedSourceSize: 32212254720
                    usedSourceSize: 24300748800
                    totalRestorePointSize: 16171687936
                    latestRestorePointSize: 1662976
                    restorePoints: 5
                    latestRestorePointDate: '2025-07-27T08:00:50.4570000+02:00'
                    jobUid: 8bb73b9b-a8b5-440a-adc9-8b781d0eba61
                    malwareState: Unverified
                    immutable: false
                  - instanceUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    organizationUid: 2da90254-8fe3-4df5-94c3-b68420fbfe23
                    name: v3cc
                    hierarchyRef: vm-88
                    parentHostRef: moonvc.tech.local
                    objectUid: b738b439-ec21-4504-8aba-bb9ca159926d
                    ipAddresses: [ ]
                    provisionedSourceSize: 0
                    usedSourceSize: 
                    totalRestorePointSize: 6602752
                    latestRestorePointSize: 1650688
                    restorePoints: 10
                    latestRestorePointDate: '2025-07-27T08:01:20.9230000+02:00'
                    jobUid: 6e9aeb29-4521-4087-a47a-2484e00ed444
                    malwareState: Unverified
                    immutable: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/virtualMachines/backups:
    get:
      tags:
        - Protected Workloads
      summary: Get Backups of All Protected VMs
      description: Returns a collection resource representation of all backups of protected VMs.
      operationId: GetProtectedVirtualMachineBackups
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedVirtualMachineBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: df60e8a2-f825-4bf7-98cc-e8a2c27785b9
                    virtualMachineUid: 13c15b2e-c6bf-0f98-28bf-ea347a1f8117
                    jobUid: c916f71b-a440-47fb-a77d-66033aaa0af6
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    backupType: Replication
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    totalRestorePointSize: 
                    latestRestorePointSize: 
                    restorePoints: 2
                    latestRestorePointDate: '2025-07-26T22:04:05.8830000+02:00'
                    targetType: Local
                    malwareState: Unverified
                    targetLocationTier: None
                    immutable: false
                  - instanceUid: b67b4694-f5c8-4e19-beea-9e90d5df2c3b
                    virtualMachineUid: 13c15b2e-c6bf-0f98-28bf-ea347a1f8117
                    jobUid: 5870b180-1f24-427d-bbf8-6d500194feb9
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    backupType: Replication
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    totalRestorePointSize: 
                    latestRestorePointSize: 
                    restorePoints: 1
                    latestRestorePointDate: '2025-07-26T21:51:49.3030000+02:00'
                    targetType: Local
                    malwareState: Unverified
                    targetLocationTier: None
                    immutable: false
                  - instanceUid: a60a0131-68a0-44b6-a166-3008afcd4e65
                    virtualMachineUid: ca7f983f-3e17-33e1-0433-65857ea7c6a1
                    jobUid: befa7f86-a1bf-4f24-bbd3-ddab68ae4edd
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    backupType: Backup
                    repositoryUid: d36f9889-0379-4736-ae64-6c7de1609d94
                    totalRestorePointSize: 3260416
                    latestRestorePointSize: 1630208
                    restorePoints: 2
                    latestRestorePointDate: '2025-07-27T01:04:08.6870000+02:00'
                    targetType: Cloud
                    malwareState: Unverified
                    targetLocationTier: None
                    immutable: false
                  - instanceUid: f8fdbc45-547f-4238-a1e8-57c0b7b0804d
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    jobUid: 1547da72-c605-411d-bd23-eef3b5355873
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    backupType: Backup
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    totalRestorePointSize: 6602752
                    latestRestorePointSize: 1650688
                    restorePoints: 4
                    latestRestorePointDate: '2025-07-27T03:44:22.8030000+02:00'
                    targetType: Local
                    malwareState: Unverified
                    targetLocationTier: None
                    immutable: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/virtualMachines/{virtualMachineUid}/backups':
    get:
      tags:
        - Protected Workloads
      summary: Get All Backups of Protected VM
      description: Returns a collection resource representation of all backups of a protected VM with the specified UID.
      operationId: GetProtectedVirtualMachineBackupsByVm
      parameters:
        - name: virtualMachineUid
          in: path
          description: Virtual machine UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedVirtualMachineBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: f8fdbc45-547f-4238-a1e8-57c0b7b0804d
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    jobUid: 1547da72-c605-411d-bd23-eef3b5355873
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    backupType: Backup
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    totalRestorePointSize: 6602752
                    latestRestorePointSize: 1650688
                    restorePoints: 4
                    latestRestorePointDate: '2025-07-27T03:44:22.8030000+02:00'
                    targetType: Local
                    malwareState: Unverified
                    targetLocationTier: None
                    immutable: false
                  - instanceUid: 9970a2ec-1846-4c78-81da-45eb419dd58b
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    jobUid: a9da3cb6-6b2e-4c86-9190-90113126aee8
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    backupType: Backup
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    totalRestorePointSize: 1650688
                    latestRestorePointSize: 1650688
                    restorePoints: 1
                    latestRestorePointDate: '2025-07-26T21:47:00.4430000+02:00'
                    targetType: Local
                    malwareState: Unverified
                    targetLocationTier: None
                    immutable: false
                  - instanceUid: b20f0d6b-b2ce-4ea1-931a-0f27ecfca493
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    jobUid: 6e9aeb29-4521-4087-a47a-2484e00ed444
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    backupType: Backup
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    totalRestorePointSize: 6602752
                    latestRestorePointSize: 1650688
                    restorePoints: 4
                    latestRestorePointDate: '2025-07-27T08:01:20.9230000+02:00'
                    targetType: Local
                    malwareState: Unverified
                    targetLocationTier: None
                    immutable: false
                  - instanceUid: 8adec5ba-64a1-43bb-b717-37f71d80c3a5
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    jobUid: faf7e70e-b6a8-42a7-b1f1-19d57946e4de
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    backupType: Backup
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    totalRestorePointSize: 1650688
                    latestRestorePointSize: 1650688
                    restorePoints: 1
                    latestRestorePointDate: '2025-07-27T08:00:55.6770000+02:00'
                    targetType: Local
                    malwareState: Unverified
                    targetLocationTier: None
                    immutable: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/virtualMachines/backupRestorePoints/latest:
    get:
      tags:
        - Protected Workloads
      summary: Get All Latest Restore Points of Protected VMs
      description: Returns a collection resource representation of latest restore points created for VMs.
      operationId: GetProtectedVirtualMachinesLatestRestorePoints
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedVirtualMachineBackupRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: c8b98dbe-8705-4ef4-babf-4823d627585f
                    backupUid: a60a0131-68a0-44b6-a166-3008afcd4e65
                    virtualMachineUid: ca7f983f-3e17-33e1-0433-65857ea7c6a1
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    filePath: C:\Backup\ScheduledJob1\6E75.vib
                    gfsType: [ ]
                    jobUid: befa7f86-a1bf-4f24-bbd3-ddab68ae4edd
                    repositoryUid: d36f9889-0379-4736-ae64-6c7de1609d94
                    size: 1630208
                    provisionedSourceSize: 
                    usedSourceSize: 
                    incrementRawDataSize: 9920
                    cpuCores: 0
                    memory: 0
                    backupCreationTime: '2025-07-27T01:04:08.6870000+02:00'
                    fileCreationTime: '2025-07-27T01:03:39.0000000+02:00'
                    isConsistent: true
                    malwareState: Unverified
                    immutableTill: 
                  - instanceUid: dbbf9ba7-74e6-4a8b-ac7f-184d50620856
                    backupUid: b20f0d6b-b2ce-4ea1-931a-0f27ecfca493
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    filePath: C:\Backup\ScheduledJob1\A40.vib
                    gfsType: [ ]
                    jobUid: 6e9aeb29-4521-4087-a47a-2484e00ed444
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 1650688
                    provisionedSourceSize: 
                    usedSourceSize: 
                    incrementRawDataSize: 19664
                    cpuCores: 0
                    memory: 0
                    backupCreationTime: '2025-07-27T08:01:20.9230000+02:00'
                    fileCreationTime: '2025-07-27T08:00:13.7170000+02:00'
                    isConsistent: true
                    malwareState: Unverified
                    immutableTill: 
                  - instanceUid: 8c89640a-211c-4bde-91ae-ffb3c623e58d
                    backupUid: 216bf6f7-2088-4169-a38c-b67bfcd4b45d
                    virtualMachineUid: 13c15b2e-c6bf-0f98-28bf-ea347a1f8117
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    filePath: C:\Backup\Job\ivz10F179.vib
                    gfsType: [ ]
                    jobUid: 8bb73b9b-a8b5-440a-adc9-8b781d0eba61
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 1662976
                    provisionedSourceSize: 32212254720
                    usedSourceSize: 24300748800
                    incrementRawDataSize: 26440
                    cpuCores: 0
                    memory: 0
                    backupCreationTime: '2025-07-27T08:00:50.4570000+02:00'
                    fileCreationTime: '2025-07-27T08:00:13.7800000+02:00'
                    isConsistent: true
                    malwareState: Unverified
                    immutableTill: 
                  - instanceUid: 0477891d-6ce2-4de2-897b-69b5aca7d3c6
                    backupUid: efea000f-4797-42ba-ac33-c322a3888ee1
                    virtualMachineUid: b899fa31-a8b8-c1b5-cae7-88afbed92ef1
                    backupServerUid: 10776b3b-1b2c-4601-8568-3e71a9786e12
                    filePath: C:\Backup\BackupJob\FF7F.vib
                    gfsType: [ ]
                    jobUid: 3319413c-70b3-4dee-b0b7-f692d458e3ba
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 1630208
                    provisionedSourceSize: 
                    usedSourceSize: 
                    incrementRawDataSize: 9934
                    cpuCores: 0
                    memory: 0
                    backupCreationTime: '2025-07-27T01:33:03.4300000+02:00'
                    fileCreationTime: '2025-07-27T01:32:36.2400000+02:00'
                    isConsistent: true
                    malwareState: Unverified
                    immutableTill: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/virtualMachines/{virtualMachineUid}/backupRestorePoints':
    get:
      tags:
        - Protected Workloads
      summary: Get All Backup Restore Points of Protected VM
      description: Returns a collection resource representation of backup restore points created for a protected VM with the specified UID.
      operationId: GetProtectedVirtualMachineBackupRestorePoints
      parameters:
        - name: virtualMachineUid
          in: path
          description: Virtual machine UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedVirtualMachineBackupRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 6038ba04-bcfd-4a67-85fa-3d5d8c4bedad
                    backupUid: 9970a2ec-1846-4c78-81da-45eb419dd58b
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    filePath: C:\Backup\BackupJob\3CF8.vbk
                    gfsType: [ ]
                    jobUid: a9da3cb6-6b2e-4c86-9190-90113126aee8
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 1650688
                    provisionedSourceSize: 
                    usedSourceSize: 
                    incrementRawDataSize: 19503
                    cpuCores: 0
                    memory: 0
                    backupCreationTime: '2025-07-26T21:47:00.4430000+02:00'
                    fileCreationTime: '2025-07-26T21:46:17.1200000+02:00'
                    isConsistent: true
                    malwareState: Unverified
                    immutableTill: 
                  - instanceUid: c4a5ea66-2278-4d9e-a3a0-9b1c35e5c936
                    backupUid: f8fdbc45-547f-4238-a1e8-57c0b7b0804d
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    filePath: C:\Backup\BackupJob1\3078.vbk
                    gfsType: [ ]
                    jobUid: 1547da72-c605-411d-bd23-eef3b5355873
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 1650688
                    provisionedSourceSize: 
                    usedSourceSize: 
                    incrementRawDataSize: 19506
                    cpuCores: 0
                    memory: 0
                    backupCreationTime: '2025-07-26T21:49:11.7270000+02:00'
                    fileCreationTime: '2025-07-26T21:48:33.5330000+02:00'
                    isConsistent: true
                    malwareState: Unverified
                    immutableTill: 
                  - instanceUid: c4496c42-ad31-49fc-940c-bb2d14a3120d
                    backupUid: b20f0d6b-b2ce-4ea1-931a-0f27ecfca493
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    filePath: C:\Backup\ScheduledJob1\BE0D.vbk
                    gfsType: [ ]
                    jobUid: 6e9aeb29-4521-4087-a47a-2484e00ed444
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 1650688
                    provisionedSourceSize: 
                    usedSourceSize: 
                    incrementRawDataSize: 19515
                    cpuCores: 0
                    memory: 0
                    backupCreationTime: '2025-07-27T01:34:01.8670000+02:00'
                    fileCreationTime: '2025-07-27T01:33:26.3500000+02:00'
                    isConsistent: true
                    malwareState: Unverified
                    immutableTill: 
                  - instanceUid: b1510cfc-2058-42b3-90dd-deb8b49d6515
                    backupUid: f8fdbc45-547f-4238-a1e8-57c0b7b0804d
                    virtualMachineUid: 7ceb59fd-3b58-3a14-0644-e4b176df75e6
                    backupServerUid: 86fbfa82-5c36-4493-a462-0003388f986a
                    filePath: C:\Backup\BackupJob1\BAB0.vib
                    gfsType: [ ]
                    jobUid: 1547da72-c605-411d-bd23-eef3b5355873
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 1650688
                    provisionedSourceSize: 
                    usedSourceSize: 
                    incrementRawDataSize: 19652
                    cpuCores: 0
                    memory: 0
                    backupCreationTime: '2025-07-27T02:21:46.1370000+02:00'
                    fileCreationTime: '2025-07-27T02:21:18.0830000+02:00'
                    isConsistent: true
                    malwareState: Unverified
                    immutableTill: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/virtualMachines/{virtualMachineUid}/replicaRestorePoints':
    get:
      tags:
        - Protected Workloads
      summary: Get All Replication Restore Points of Protected VM
      description: Returns a collection resource representation of replication restore points created for a protected VM with the specified UID.
      operationId: GetProtectedVirtualMachineReplicaRestorePoints
      parameters:
        - name: virtualMachineUid
          in: path
          description: Virtual machine UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedVirtualMachineReplicaRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 8db5e2cc-898d-4dc5-b61f-1cb3e47f799f
                    virtualMachineUid: edbcf633-8d8b-1c61-fc16-4dc14eab3cc6
                    backupUid: cd439ad8-09d7-42ac-b542-a5e7f5b9a1ae
                    jobUid: 34f5eed3-f682-454b-b3a4-7acb08e25103
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    creationDate: '2023-11-19T02:38:53.2970000+01:00'
                  - instanceUid: 04d58d6f-22dc-48ca-b037-49b76ce5625a
                    virtualMachineUid: edbcf633-8d8b-1c61-fc16-4dc14eab3cc6
                    backupUid: 550146e5-d345-4561-a92e-7f8fbbbc97be
                    jobUid: 6033e247-a906-42c0-91d2-ba626e75d561
                    hardwarePlanUid: f698f368-7f29-4351-a822-ba2971f7649b
                    creationDate: '2023-11-19T02:48:38.0000000+01:00'
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/computersManagedByConsole:
    get:
      tags:
        - Protected Workloads
      summary: Get All Protected Computers Managed by Veeam Service Provider Console
      description: Returns a collection resource representation of all protected computers managed by Veeam Service Provider Console.
      operationId: GetProtectedComputersManagedByConsole
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByConsole'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    organizationUid: 30780260-6bed-47eb-b1ac-d12de2ce5b9d
                    name: r2vbr
                    numberOfJobs: 1
                    operationMode: Server
                    latestRestorePointDate: '2023-11-19T12:09:24.1790000+01:00'
                  - backupAgentUid: 5bae3b42-31e4-51de-23c3-ff3b18bc8317
                    organizationUid: 30780260-6bed-47eb-b1ac-d12de2ce5b9d
                    name: r2vaw
                    numberOfJobs: 0
                    operationMode: Server
                    latestRestorePointDate: '2023-11-19T09:05:19.8090000+01:00'
                  - backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    organizationUid: ff98a69f-19dd-4a08-898e-a8a3562fe974
                    name: r2vawServ1
                    numberOfJobs: 4
                    operationMode: Server
                    latestRestorePointDate: '2023-11-19T09:54:30.0290000+01:00'
                  - backupAgentUid: 6bbf3b42-5585-2ba6-9df2-515b8e62e1ea
                    organizationUid: ada1a61e-caaf-4352-85ef-fae903037163
                    name: r2vaw2
                    numberOfJobs: 2
                    operationMode: Workstation
                    latestRestorePointDate: '2023-11-19T09:40:54.2900000+01:00'
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/computersManagedByConsole/jobs:
    get:
      tags:
        - Protected Workloads
      summary: Get Jobs Protecting All Computers Managed by Veeam Service Provider Console
      description: Returns a collection resource representation of all jobs that protect computers managed by Veeam Service Provider Console.
      operationId: GetProtectedComputersManagedByConsoleJobs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByConsoleJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    jobUid: 06455942-51e2-4e47-9c5b-febb18f69596
                    jobName: Windows workstation - Personal files_r2vbr
                    sourceSize: 
                    totalRestorePointSize: 999415808
                    latestRestorePointSize: 999415808
                    restorePoints: 1
                    latestRestorePointDate: '2023-11-19T12:06:13.0000000+01:00'
                    targetType: Cloud
                  - backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    jobUid: 1043a564-1170-4d39-8cdc-36631900a99d
                    jobName: Windows workstation - Personal files_r2vawServ1
                    sourceSize: 
                    totalRestorePointSize: 23158784
                    latestRestorePointSize: 23158784
                    restorePoints: 1
                    latestRestorePointDate: '2023-11-19T09:30:19.0000000+01:00'
                    targetType: Cloud
                  - backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    jobUid: 983d0be8-c488-4da0-b018-f6e277ddc799
                    jobName: WServerVolumeCloud_r2vawServ1
                    sourceSize: 26451713190
                    totalRestorePointSize: 15172886528
                    latestRestorePointSize: 345497600
                    restorePoints: 2
                    latestRestorePointDate: '2023-11-19T09:30:26.0000000+01:00'
                    targetType: Cloud
                  - backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    jobUid: 0359f6b8-7275-4feb-b056-285bb0155750
                    jobName: WWrkstEntireCloud_r2vawServ1
                    sourceSize: 26449878026
                    totalRestorePointSize: 14841733120
                    latestRestorePointSize: 14841733120
                    restorePoints: 1
                    latestRestorePointDate: '2023-11-19T09:30:23.0000000+01:00'
                    targetType: Cloud
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/computersManagedByConsole/{backupAgentUid}/jobs':
    get:
      tags:
        - Protected Workloads
      summary: Get All Jobs Protecting Computer Managed by Veeam Service Provider Console
      description: Returns a collection resource representation of jobs that protect a computer managed by Veeam Service Provider Console with the specified UID of Veeam backup agent installed on the computer.
      operationId: GetProtectedComputersManagedByConsoleJobsByBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByConsoleJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    jobUid: 1043a564-1170-4d39-8cdc-36631900a99d
                    jobName: Windows workstation - Personal files_r2vawServ1
                    sourceSize: 
                    totalRestorePointSize: 23158784
                    latestRestorePointSize: 23158784
                    restorePoints: 1
                    latestRestorePointDate: '2023-11-19T09:30:19.0000000+01:00'
                    targetType: Cloud
                  - backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    jobUid: 983d0be8-c488-4da0-b018-f6e277ddc799
                    jobName: WServerVolumeCloud_r2vawServ1
                    sourceSize: 26451713190
                    totalRestorePointSize: 15172886528
                    latestRestorePointSize: 345497600
                    restorePoints: 2
                    latestRestorePointDate: '2023-11-19T09:30:26.0000000+01:00'
                    targetType: Cloud
                  - backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    jobUid: 0359f6b8-7275-4feb-b056-285bb0155750
                    jobName: WWrkstEntireCloud_r2vawServ1
                    sourceSize: 26449878026
                    totalRestorePointSize: 14841733120
                    latestRestorePointSize: 14841733120
                    restorePoints: 1
                    latestRestorePointDate: '2023-11-19T09:30:23.0000000+01:00'
                    targetType: Cloud
                  - backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    jobUid: 99d5d4a2-81a1-4a19-b8a6-4642769d6b70
                    jobName: Windows server - Entire computer_r2vawServ1
                    sourceSize: 26451715079
                    totalRestorePointSize: 14720708608
                    latestRestorePointSize: 14720708608
                    restorePoints: 1
                    latestRestorePointDate: '2023-11-19T09:30:19.0000000+01:00'
                    targetType: Cloud
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/computersManagedByConsole/restorePoints:
    get:
      tags:
        - Protected Workloads
      summary: Get All Restore Points of Protected Computers Managed by Veeam Service Provider Console
      description: Returns a collection resource representation of all restore points of computers managed by Veeam Service Provider Console.
      operationId: GetProtectedComputersManagedByConsoleRestorePoints
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByConsoleRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 71a9acf5-744c-47e1-a15f-094c369d88f8
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    jobUid: bffded0b-7c79-494c-a151-bb200f3fc4f5
                    backedupItems: ''
                    destination: C:\backups\
                    size: 363819008
                    incrementRawDataSize: 
                    sourceSize: 
                    creationDate: '2021-03-07T23:39:36.0000000+01:00'
                  - instanceUid: 14ff7383-b694-4002-897b-24877b08b33d
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    jobUid: bffded0b-7c79-494c-a151-bb200f3fc4f5
                    backedupItems: ''
                    destination: C:\backups\
                    size: 28364800
                    incrementRawDataSize: 
                    sourceSize: 
                    creationDate: '2021-03-08T09:30:21.0000000+01:00'
                  - instanceUid: 5a104522-1303-4917-b192-dc55d52ff76a
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    jobUid: 06455942-51e2-4e47-9c5b-febb18f69596
                    backedupItems: Personal Files
                    destination: restv3t1_r2vbr_Repository
                    size: 999415808
                    incrementRawDataSize: 1466752656
                    sourceSize: 
                    creationDate: '2023-11-19T12:06:13.0000000+01:00'
                  - instanceUid: 784bf39c-1a86-419d-871e-1d868bc50aef
                    backupAgentUid: 5bae3b42-31e4-51de-23c3-ff3b18bc8317
                    jobUid: 532d5593-dc4a-46b4-b996-1a900994f2b9
                    backedupItems: Personal Files; Files and folders
                    destination: C:\backups\
                    size: 166805504
                    incrementRawDataSize: 
                    sourceSize: 
                    creationDate: '2020-12-03T04:34:32.0000000+01:00'
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/computersManagedByConsole/restorePoints/latest:
    get:
      tags:
        - Protected Workloads
      summary: Get Latest Restore Points of All Protected Computers Managed by Veeam Service Provider Console
      description: Returns a collection resource representation of latest restore points of computers managed by Veeam Service Provider Console.
      operationId: GetProtectedComputersManagedByConsoleLatestRestorePoints
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByConsoleRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 14ff7383-b694-4002-897b-24877b08b33d
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    jobUid: bffded0b-7c79-494c-a151-bb200f3fc4f5
                    backedupItems: ''
                    destination: C:\backups\
                    size: 28364800
                    incrementRawDataSize: 
                    sourceSize: 
                    creationDate: '2021-03-08T09:30:21.0000000+01:00'
                  - instanceUid: 5a104522-1303-4917-b192-dc55d52ff76a
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    jobUid: 06455942-51e2-4e47-9c5b-febb18f69596
                    backedupItems: Personal Files
                    destination: restv3t1_r2vbr_Repository
                    size: 999415808
                    incrementRawDataSize: 1466752656
                    sourceSize: 
                    creationDate: '2023-11-19T12:06:13.0000000+01:00'
                  - instanceUid: 2e9238d4-be8a-4eb4-9936-ab9f5b59121c
                    backupAgentUid: 5bae3b42-31e4-51de-23c3-ff3b18bc8317
                    jobUid: 532d5593-dc4a-46b4-b996-1a900994f2b9
                    backedupItems: Personal Files; Files and folders
                    destination: C:\backups\
                    size: 562659328
                    incrementRawDataSize: 
                    sourceSize: 
                    creationDate: '2021-03-08T00:30:17.0000000+01:00'
                  - instanceUid: a7ec99ee-4d67-4d57-a3b2-683b0a459b2f
                    backupAgentUid: 19873b42-88ea-bbc5-e764-74d8f6ebd698
                    jobUid: 0359f6b8-7275-4feb-b056-285bb0155750
                    backedupItems: Entire Computer
                    destination: CCTenantSecond_r2vawServ1_1_Repository_modified
                    size: 14841733120
                    incrementRawDataSize: 28506587136
                    sourceSize: 26449878026
                    creationDate: '2023-11-19T09:30:23.0000000+01:00'
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/computersManagedByConsole/{backupAgentUid}/restorePoints':
    get:
      tags:
        - Protected Workloads
      summary: Get All Restore Points of Protected Computer Managed by Veeam Service Provider Console
      description: Returns a collection resource representation of restore points created for a protected computer managed by Veeam Service Provider Console with the specified UID of Veeam backup agent installed on the computer.
      operationId: GetProtectedComputerManagedByConsoleRestorePoints
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByConsoleRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 71a9acf5-744c-47e1-a15f-094c369d88f8
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    jobUid: bffded0b-7c79-494c-a151-bb200f3fc4f5
                    backedupItems: ''
                    destination: C:\backups\
                    size: 363819008
                    incrementRawDataSize: 
                    sourceSize: 
                    creationDate: '2021-03-07T23:39:36.0000000+01:00'
                  - instanceUid: 14ff7383-b694-4002-897b-24877b08b33d
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    jobUid: bffded0b-7c79-494c-a151-bb200f3fc4f5
                    backedupItems: ''
                    destination: C:\backups\
                    size: 28364800
                    incrementRawDataSize: 
                    sourceSize: 
                    creationDate: '2021-03-08T09:30:21.0000000+01:00'
                  - instanceUid: 5a104522-1303-4917-b192-dc55d52ff76a
                    backupAgentUid: 861d3b42-f46f-b0c7-4f6f-4e8c507e7b5c
                    jobUid: 06455942-51e2-4e47-9c5b-febb18f69596
                    backedupItems: Personal Files
                    destination: r3t1_r2vbr_Repository
                    size: 999415808
                    incrementRawDataSize: 1466752656
                    sourceSize: 
                    creationDate: '2023-11-19T12:06:13.0000000+01:00'
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/computersManagedByBackupServer:
    get:
      tags:
        - Protected Workloads
      summary: Get All Protected Computers Managed By Backup Server
      description: Returns a collection resource representation of all protected computers managed by Veeam Backup & Replication.
      operationId: GetProtectedComputersManagedByBackupServer
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByBackupServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 42c03b42-96f9-ad8a-5277-ca43a693cbf0
                    sourceInstanceUid: 0c399c26-1f05-41f5-af32-65cbdff68450
                    backupServerUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                    protectionGroups:
                      - a0da4cdd-26ab-4b3d-a888-34405768df53
                    organizationUid: 30780260-6bed-47eb-b1ac-d12de2ce5b9d
                    name: r2vaw3.tech.local
                    ipAddresses:
                      - 172.24.159.126
                    guestOs: 'Microsoft Windows 10 (21H2, 64-bit)'
                    platformType: Windows
                    operationMode: Server
                    latestRestorePointDate: '2023-11-19T02:58:51.6600000+01:00'
                    malwareState: Clean
                  - instanceUid: 4211a8e8-1f9c-3da5-6972-4b1a6f4b8c6a
                    sourceInstanceUid: 7d58c7c7-8362-40b0-82a2-fd1f8c8c7067
                    backupServerUid: a6305f3c-46be-4c06-9bc4-97f2449d881f
                    protectionGroups:
                      - bfb30a81-eb05-4f3f-bd8f-bd93a93576f2
                    organizationUid: ff98a69f-19dd-4a08-898e-a8a3562fe974
                    name: r2valVBR.tech.local
                    ipAddresses:
                      - 172.35.152.24
                    guestOs: Ubuntu 18.04.1 LTS
                    platformType: Linux
                    operationMode: Server
                    latestRestorePointDate: 
                    malwareState: Unverified
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/computersManagedByBackupServer/restorePoints:
    get:
      tags:
        - Protected Workloads
      summary: Get All Restore Points of Protected Computers Managed by Backup Server
      description: Returns a collection resource representation of all restore points created for computers managed by Veeam Backup & Replication.
      operationId: GetProtectedComputersManagedByBackupServerRestorePoints
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByBackupServerRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 1474c5ea-e2ce-4b87-b2bf-949bef48dabf
                    backupAgentUid: 42c03b42-96f9-ad8a-5277-ca43a693cbf0
                    backupUid: 6194c51b-98a1-4924-bf23-974223d3179c
                    jobUid: 80c63a09-6c46-47e4-a9cb-06079790ac7c
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 94666752
                    provisionedSourceSize: 52704110592
                    usedSourceSize: 
                    incrementRawDataSize: 31694599168
                    sourceSize: 52704110592
                    cpuCores: 4
                    memory: 5368709120
                    targetType: Local
                    backupCreationTime: '2023-11-19T03:01:07.3370000+01:00'
                    fileCreationTime: '2023-11-19T02:58:51.6600000+01:00'
                    malwareState: Clean
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/computersManagedByBackupServer/backups:
    get:
      tags:
        - Protected Workloads
      summary: Get Backups of All Protected Computers Managed by Backup Server
      description: Returns a collection resource representation of all backups of computers managed by Veeam Backup & Replication.
      operationId: GetProtectedComputersManagedByBackupServerBackups
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByBackupServerBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 6194c51b-98a1-4924-bf23-974223d3179c
                    backupAgentUid: 42c03b42-96f9-ad8a-5277-ca43a693cbf0
                    jobUid: 80c63a09-6c46-47e4-a9cb-06079790ac7c
                    jobName: vawJobByVBR
                    jobKind: Backup
                    provisionedSourceSize: 52704110592
                    usedSourceSize: 31694599168
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    totalRestorePointSize: 94666752
                    latestRestorePointSize: 94666752
                    restorePoints: 1
                    latestRestorePointDate: '2023-11-19T02:58:51.6600000+01:00'
                    targetType: Local
                    malwareState: Unverified
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/computersManagedByBackupServer/{backupAgentUid}/backups':
    get:
      tags:
        - Protected Workloads
      summary: Get All Backups of Protected Computer Managed by Backup Server
      description: Returns a collection resource representation of all backups of a computer managed by Veeam Backup & Replication with the specified UID of Veeam backup agent installed on the computer.
      operationId: GetProtectedComputersManagedByBackupServerBackupsByBackupAgent
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByBackupServerBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 6194c51b-98a1-4924-bf23-974223d3179c
                    backupAgentUid: 42c03b42-96f9-ad8a-5277-ca43a693cbf0
                    jobUid: 80c63a09-6c46-47e4-a9cb-06079790ac7c
                    jobName: vawJobByVBR
                    jobKind: Backup
                    provisionedSourceSize: 52704110592
                    usedSourceSize: 31694599168
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    totalRestorePointSize: 94666752
                    latestRestorePointSize: 94666752
                    restorePoints: 1
                    latestRestorePointDate: '2023-11-19T02:58:51.6600000+01:00'
                    targetType: Local
                    malwareState: Clean
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/computersManagedByBackupServer/restorePoints/latest:
    get:
      tags:
        - Protected Workloads
      summary: Get Latest Restore Points of All Protected Computers Managed by Backup Server
      description: Returns a collection resource representation of the latest restore points of computers managed by Veeam Backup & Replication.
      operationId: GetProtectedComputersManagedByBackupServerLatestRestorePoints
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByBackupServerRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 1474c5ea-e2ce-4b87-b2bf-949bef48dabf
                    backupAgentUid: 42c03b42-96f9-ad8a-5277-ca43a693cbf0
                    backupUid: 6194c51b-98a1-4924-bf23-974223d3179c
                    jobUid: 80c63a09-6c46-47e4-a9cb-06079790ac7c
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 94666752
                    provisionedSourceSize: 52704110592
                    usedSourceSize: 
                    incrementRawDataSize: 31694599168
                    sourceSize: 52704110592
                    cpuCores: 4
                    memory: 5368709120
                    targetType: Local
                    backupCreationTime: '2023-11-19T03:01:07.3370000+01:00'
                    fileCreationTime: '2023-11-19T02:58:51.6600000+01:00'
                    malwareState: Clean
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/computersManagedByBackupServer/{backupAgentUid}/restorePoints':
    get:
      tags:
        - Protected Workloads
      summary: Get Latest Restore Points of Protected Computer Managed by Backup Server
      description: Returns a collection resource representation of all restore points created for a protected computer managed by Veeam Backup & Replication with the specified UID of Veeam backup agent installed on the computer.
      operationId: GetProtectedComputerManagedByBackupServerRestorePoints
      parameters:
        - $ref: '#/components/parameters/backupAgentUid_path'
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedComputerManagedByBackupServerRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 1474c5ea-e2ce-4b87-b2bf-949bef48dabf
                    backupAgentUid: 42c03b42-96f9-ad8a-5277-ca43a693cbf0
                    backupUid: 6194c51b-98a1-4924-bf23-974223d3179c
                    jobUid: 80c63a09-6c46-47e4-a9cb-06079790ac7c
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    size: 94666752
                    provisionedSourceSize: 52704110592
                    usedSourceSize: 
                    incrementRawDataSize: 31694599168
                    sourceSize: 52704110592
                    cpuCores: 4
                    memory: 5368709120
                    targetType: Local
                    backupCreationTime: '2023-11-19T03:01:07.3370000+01:00'
                    fileCreationTime: '2023-11-19T02:58:51.6600000+01:00'
                    malwareState: Clean
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/fileShares:
    get:
      tags:
        - Protected Workloads
      summary: Get All Protected File Shares
      description: Returns a collection resource representation of all protected file shares.
      operationId: GetProtectedOnPremisesFileShares
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedOnPremisesFileShare'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - fileShareUid: 2c1dce65-5588-453f-a126-3b1260a38e48
                    backupServerUid: 22fe5c93-3c27-4bd3-8d1b-c5356c59b820
                    organizationUid: 551c5e51-0b99-4778-ac49-ac144748dbb4
                    name: r2VBR.tech.local\C$\setup
                    latestRestorePointDate: '2023-10-20T03:13:02.9830000+02:00'
                    totalArchiveSize: 0
                    totalShortTermBackupSize: 143555436
                    archiveRestorePoints: 0
                    restorePoints: 2
                  - fileShareUid: 445ce43e-9f5f-4ee0-918b-f838e5d95fd3
                    backupServerUid: 062a3c26-e7d0-480c-928f-36a353938b85
                    organizationUid: 899d01ed-5972-4ce4-ac6c-717ff0780309
                    name: r2vbr2.tech.local\C$\setup
                    latestRestorePointDate: '2023-10-20T03:21:04.0070000+02:00'
                    totalArchiveSize: 0
                    totalShortTermBackupSize: 143550318
                    archiveRestorePoints: 0
                    restorePoints: 2
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/fileShares/restorePoints:
    get:
      tags:
        - Protected Workloads
      summary: Get All Restore Points of Protected File Shares
      description: Returns a collection resource representation of all restore points created for computers managed by Veeam Backup & Replication.
      operationId: GetProtectedFileSharesRestorePoints
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedOnPremisesFileShareRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: bd2c0ddc-960f-40ca-bc2e-2a1f40414f46
                    fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    backupServerUid: 8695ccfa-ddf6-4dd6-92b5-b0cfd1489aa3
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    restorePointDate: '2023-10-28T13:47:33.5570000+02:00'
                    size: 28227885531
                    isArchive: true
                  - instanceUid: 5332f8fe-a8ec-4037-8180-217fca57a375
                    fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    backupServerUid: 8695ccfa-ddf6-4dd6-92b5-b0cfd1489aa3
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    restorePointDate: '2023-10-28T22:00:19.5800000+02:00'
                    size: 28261924381
                    isArchive: true
                  - instanceUid: e074fe21-5ed3-4441-bfb6-71af7a95deb8
                    fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    backupServerUid: 8695ccfa-ddf6-4dd6-92b5-b0cfd1489aa3
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    restorePointDate: '2023-10-29T21:00:42.6430000+01:00'
                    size: 27474683075
                    isArchive: true
                  - instanceUid: 47305989-46e2-4893-969b-76d887e51ed9
                    fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    backupServerUid: 8695ccfa-ddf6-4dd6-92b5-b0cfd1489aa3
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    restorePointDate: '2023-10-30T21:00:37.7170000+01:00'
                    size: 27518268114
                    isArchive: true
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/fileShares/backups:
    get:
      tags:
        - Protected Workloads
      summary: Get Backups of All Protected File Shares
      description: Returns a collection resource representation of all backups of computers managed by Veeam Backup & Replication.
      operationId: GetProtectedFileSharesBackups
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedOnPremisesFileShareBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    backupServerUid: 8695ccfa-ddf6-4dd6-92b5-b0cfd1489aa3
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    repositoryUid: 0864cdb8-ef70-4c72-844a-88b09051cf91
                    archiveRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveSize: 118470913090
                    shortTermBackupSize: 36686793254
                    archiveRestorePoints: 545
                    restorePoints: 30
                    latestRestorePointDate: '2023-11-14T22:00:32.2900000+01:00'
                    sourceSize: 24770472493
                    sources:
                      - path: C:\Users
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks: [ ]
                      - path: C:\Windows
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks: [ ]
                  - fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    jobUid: 424379e0-96ed-4eee-9fe8-c5fe77e50e5c
                    backupServerUid: 0dc812ea-a4de-4401-b6ff-9f34ac6f0143
                    backupUid: d40e544b-3df8-451b-9ce3-b4ee7d419411
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    archiveSize: 0
                    shortTermBackupSize: 31124197743
                    archiveRestorePoints: 0
                    restorePoints: 30
                    latestRestorePointDate: '2023-11-14T22:00:32.2900000+01:00'
                    sourceSize: 
                    sources:
                      - path: C:\Windows
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks: [ ]
                      - path: C:\Users
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/fileShares/{fileShareUid}/backups':
    get:
      tags:
        - Protected Workloads
      summary: Get All Backups of Protected File Share
      description: Returns a collection resource representation of all backups of a file share with the specified UID.
      operationId: GetProtectedFileSharesBackupsByFileShare
      parameters:
        - name: fileShareUid
          in: path
          description: File share UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedOnPremisesFileShareBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    backupServerUid: 8695ccfa-ddf6-4dd6-92b5-b0cfd1489aa3
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    repositoryUid: 0864cdb8-ef70-4c72-844a-88b09051cf91
                    archiveRepositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveSize: 118470913090
                    shortTermBackupSize: 36686793254
                    archiveRestorePoints: 545
                    restorePoints: 30
                    latestRestorePointDate: '2023-11-14T22:00:32.2900000+01:00'
                    sourceSize: 24770472493
                    sources:
                      - path: C:\Users
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks: [ ]
                      - path: C:\Windows
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks: [ ]
                  - fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    jobUid: 424379e0-96ed-4eee-9fe8-c5fe77e50e5c
                    backupServerUid: 0dc812ea-a4de-4401-b6ff-9f34ac6f0143
                    backupUid: d40e544b-3df8-451b-9ce3-b4ee7d419411
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    archiveSize: 0
                    shortTermBackupSize: 31124197743
                    archiveRestorePoints: 0
                    restorePoints: 30
                    latestRestorePointDate: '2023-11-14T22:00:32.2900000+01:00'
                    sourceSize: 
                    sources:
                      - path: C:\Windows
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks: [ ]
                      - path: C:\Users
                        inclusionMasks:
                          - '*.*'
                        exclusionMasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/fileShares/{fileShareUid}/restorePoints':
    get:
      tags:
        - Protected Workloads
      summary: Get Latest Restore Points of Protected File Share
      description: Returns a collection resource representation of all restore points created for a protected computer managed by Veeam Backup & Replication with the specified UID of File share UID installed on the computer.
      operationId: GetProtectedFileShareRestorePoints
      parameters:
        - name: fileShareUid
          in: path
          description: File share UID UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedOnPremisesFileShareRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: bd2c0ddc-960f-40ca-bc2e-2a1f40414f46
                    fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    backupServerUid: 0dc812ea-a4de-4401-b6ff-9f34ac6f0143
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    restorePointDate: '2023-10-28T13:47:33.5570000+02:00'
                    size: 28227885531
                    isArchive: true
                  - instanceUid: 5332f8fe-a8ec-4037-8180-217fca57a375
                    fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    backupServerUid: 0dc812ea-a4de-4401-b6ff-9f34ac6f0143
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    restorePointDate: '2023-10-28T22:00:19.5800000+02:00'
                    size: 28261924381
                    isArchive: true
                  - instanceUid: e074fe21-5ed3-4441-bfb6-71af7a95deb8
                    fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    backupServerUid: 0dc812ea-a4de-4401-b6ff-9f34ac6f0143
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    restorePointDate: '2023-10-29T21:00:42.6430000+01:00'
                    size: 27474683075
                    isArchive: true
                  - instanceUid: 47305989-46e2-4893-969b-76d887e51ed9
                    fileShareUid: 6745a759-2205-4cd2-b172-8ec8f7e60ef8
                    backupServerUid: 0dc812ea-a4de-4401-b6ff-9f34ac6f0143
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    jobUid: e6e1d81b-b084-4e9c-aec9-682356a9b2d0
                    restorePointDate: '2023-10-30T21:00:37.7170000+01:00'
                    size: 27518268114
                    isArchive: true
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/objectStorages:
    get:
      tags:
        - Protected Workloads
      summary: Get All Protected Object Storages
      description: Returns a collection resource representation of all protected object storages.
      operationId: GetProtectedObjectStorages
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedObjectStorage'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    backupServerUid: e5539857-59db-43e7-a863-12df05ba6e41
                    organizationUid: ac0f785f-b80e-4b7a-a60f-df7e2fb76c58
                    objectStorageName: osr1
                    bucketName: osr
                    latestRestorePointDate: '2023-11-15T07:00:59.9800000+01:00'
                    totalArchiveSize: 0
                    totalShortTermBackupSize: 8540662523
                    archiveRestorePoints: 0
                    restorePoints: 28
                  - objectStorageUid: 47305989-46e2-4893-969b-76d887e51ed9
                    bucketUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    backupServerUid: e5539857-59db-43e7-a863-12df05ba6e41
                    organizationUid: ac0f785f-b80e-4b7a-a60f-df7e2fb76c58
                    objectStorageName: osr2
                    bucketName: osr
                    latestRestorePointDate: '2023-11-15T07:00:59.9800000+01:00'
                    totalArchiveSize: 0
                    totalShortTermBackupSize: 6782634528
                    archiveRestorePoints: 0
                    restorePoints: 23
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/objectStorages/restorePoints:
    get:
      tags:
        - Protected Workloads
      summary: Get All Restore Points of Protected Object Storages
      description: Returns a collection resource representation of all restore points created for computers managed by Veeam Backup & Replication.
      operationId: GetProtectedObjectStoragesRestorePoints
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedObjectStorageRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 4ae6119c-8ffc-4749-a717-e4ad87a9da46
                    objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    restorePointDate: '2023-10-18T18:07:51.1370000+02:00'
                    size: 8389748383
                    isArchive: false
                  - instanceUid: 4e9ff46e-bff7-4e4d-bc00-ce67825cc5aa
                    objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    restorePointDate: '2023-10-19T07:00:45.3100000+02:00'
                    size: 8389748383
                    isArchive: false
                  - instanceUid: 33b04b76-edea-4c73-bc8d-571e57d3c71f
                    objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    restorePointDate: '2023-10-20T07:00:53.7630000+02:00'
                    size: 8389748383
                    isArchive: false
                  - instanceUid: b5502dc3-1eab-4c37-81b5-24bb8d349b15
                    objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    restorePointDate: '2023-10-21T07:00:50.0400000+02:00'
                    size: 8389748383
                    isArchive: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/objectStorages/backups:
    get:
      tags:
        - Protected Workloads
      summary: Get Backups of All Protected Object Storages
      description: Returns a collection resource representation of all backups of computers managed by Veeam Backup & Replication.
      operationId: GetProtectedObjectStoragesBackups
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedObjectStorageBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    archiveSize: 0
                    shortTermBackupSize: 8540662523
                    archiveRestorePoints: 0
                    restorePoints: 28
                    latestRestorePointDate: '2023-11-15T07:00:59.9800000+01:00'
                    sourceSize: 8389748383
                    sources:
                      - path: osr1
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                  - objectStorageUid: 47305989-46e2-4893-969b-76d887e51ed9
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    backupUid: bd2c0ddc-960f-40ca-bc2e-2a1f40414f46
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    archiveSize: 0
                    shortTermBackupSize: 6782634528
                    archiveRestorePoints: 0
                    restorePoints: 23
                    latestRestorePointDate: '2023-11-15T07:00:59.9800000+01:00'
                    sourceSize: 6512638492
                    sources:
                      - path: osr2
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/objectStorages/{objectStorageUid}/backups':
    get:
      tags:
        - Protected Workloads
      summary: Get All Backups of Protected Object Storage
      description: Returns a collection resource representation of all backups of a computer managed by Veeam Backup & Replication with the specified UID of File share UID installed on the computer.
      operationId: GetProtectedObjectStoragesBackupsByObjectStorage
      parameters:
        - name: objectStorageUid
          in: path
          description: File share UID UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedObjectStorageBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    archiveSize: 0
                    shortTermBackupSize: 8540662523
                    archiveRestorePoints: 0
                    restorePoints: 28
                    latestRestorePointDate: '2023-11-15T07:00:59.9800000+01:00'
                    sourceSize: 8389748383
                    sources:
                      - path: osr1
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                  - objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    backupUid: c60f93f7-cd3d-43c1-b6e4-7a5ea47dd46d
                    repositoryUid: 88788f9e-d8f5-4eb4-bc4f-9b3f5403bcec
                    archiveRepositoryUid: 
                    archiveSize: 0
                    shortTermBackupSize: 8551374531
                    archiveRestorePoints: 0
                    restorePoints: 23
                    latestRestorePointDate: '2023-11-15T07:00:59.9800000+01:00'
                    sourceSize: 8399542172
                    sources:
                      - path: osr1
                        inclusionMasks: [ ]
                        exclusionMasks: [ ]
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/objectStorages/{objectStorageUid}/restorePoints':
    get:
      tags:
        - Protected Workloads
      summary: Get Latest Restore Points of Protected Object Storage
      description: Returns a collection resource representation of all restore points created for a protected computer managed by Veeam Backup & Replication with the specified UID of File share UID installed on the computer.
      operationId: GetProtectedObjectStorageRestorePoints
      parameters:
        - name: objectStorageUid
          in: path
          description: File share UID UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedObjectStorageRestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 4ae6119c-8ffc-4749-a717-e4ad87a9da46
                    objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    restorePointDate: '2023-10-18T18:07:51.1370000+02:00'
                    size: 8389748383
                    isArchive: false
                  - instanceUid: 4e9ff46e-bff7-4e4d-bc00-ce67825cc5aa
                    objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    restorePointDate: '2023-10-19T07:00:45.3100000+02:00'
                    size: 8389748383
                    isArchive: false
                  - instanceUid: 33b04b76-edea-4c73-bc8d-571e57d3c71f
                    objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    restorePointDate: '2023-10-20T07:00:53.7630000+02:00'
                    size: 8389748383
                    isArchive: false
                  - instanceUid: b5502dc3-1eab-4c37-81b5-24bb8d349b15
                    objectStorageUid: 7dfb716b-eff0-4c2f-be72-7b2537fbd83f
                    bucketUid: 66cc2222-186a-4253-b418-f61bad91c577
                    backupUid: bd59c2fa-c674-4fdc-abe0-c94203065ad0
                    jobUid: 511efbb9-b41e-4d90-ba8d-9e72bbd21076
                    restorePointDate: '2023-10-21T07:00:50.0400000+02:00'
                    size: 8389748383
                    isArchive: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/publicCloud/fileShares:
    get:
      tags:
        - Protected Public Cloud Workloads
      summary: Get All Protected Cloud File Shares
      description: Returns a collection resource representation of all protected cloud file shares.
      operationId: GetProtectedCloudFileShares
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudFileShare'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - fileShareUid: 175977d3-ebdb-423f-a610-9ce89c2a4157
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    name: AZ-AWS-EFS-2
                    applianceUid: 82db3391-e51f-4179-bc92-d9ffa3c68245
                    resourceId: fs-030dd3590ef06c9b4
                    platform: Amazon
                    fileShareType: AwsEfs
                    snapshotsCount: 1
                    policyCount: 1
                    replicaSnapshotsCount: 0
                    latestSnapshotDate: '2024-07-17T21:59:17.6970000+02:00'
                    latestReplicaSnapshotDate: 
                  - fileShareUid: b3aa3a0d-8346-44d5-bc9c-6238f6c021db
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    name: file-share-2
                    applianceUid: 82db3391-e51f-4179-bc92-d9ffa3c68245
                    resourceId: fs-03d4db86160f5b9be
                    platform: Amazon
                    fileShareType: AwsEfs
                    snapshotsCount: 8
                    policyCount: 1
                    replicaSnapshotsCount: 0
                    latestSnapshotDate: '2024-07-18T04:00:16.5700000+02:00'
                    latestReplicaSnapshotDate: 
                  - fileShareUid: 17cf6d1d-bada-4c6a-85bd-e907ed51b309
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    name: file-share-1
                    applianceUid: 82db3391-e51f-4179-bc92-d9ffa3c68245
                    resourceId: fs-03fae84dd51b082e0
                    platform: Amazon
                    fileShareType: AwsEfs
                    snapshotsCount: 7
                    policyCount: 1
                    replicaSnapshotsCount: 0
                    latestSnapshotDate: '2024-07-18T04:00:17.2330000+02:00'
                    latestReplicaSnapshotDate: 
                  - fileShareUid: 841f0250-e995-4ce5-8524-066f462049a6
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    name: WIN11-EFS
                    applianceUid: 82db3391-e51f-4179-bc92-d9ffa3c68245
                    resourceId: fs-05fccfb404b109d9b
                    platform: Amazon
                    fileShareType: AwsEfs
                    snapshotsCount: 13
                    policyCount: 1
                    replicaSnapshotsCount: 0
                    latestSnapshotDate: '2024-04-02T09:20:32.9630000+02:00'
                    latestReplicaSnapshotDate: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/publicCloud/fileShares/backups:
    get:
      tags:
        - Preview Operations
      summary: Get All Protected Cloud File Share Backups
      description: "Returns a collection resource representation of all backups created for protected cloud file shares.\n>This operation is not optimized for large-scale environments.\n"
      operationId: GetProtectedCloudFileShareBackups
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudFileShareBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - fileShareUid: 175977d3-ebdb-423f-a610-9ce89c2a4157
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    policyUid: 
                    policyName: 
                    region: Europe (Frankfurt)
                    replicaRegion: ''
                    fileShareType: AwsEfs
                    name: 
                    snapshotsCount: 1
                    replicaSnapshotsCount: 0
                    latestSnapshotDate: '2024-07-17T21:59:17.6970000+02:00'
                    latestReplicaSnapshotDate: 
                    totalSize: 6914469888
                  - fileShareUid: b3aa3a0d-8346-44d5-bc9c-6238f6c021db
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    policyUid: 
                    policyName: 
                    region: Europe (Frankfurt)
                    replicaRegion: ''
                    fileShareType: AwsEfs
                    name: 
                    snapshotsCount: 8
                    replicaSnapshotsCount: 0
                    latestSnapshotDate: '2024-07-18T04:00:16.5700000+02:00'
                    latestReplicaSnapshotDate: 
                    totalSize: 49152
                  - fileShareUid: 17cf6d1d-bada-4c6a-85bd-e907ed51b309
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    policyUid: 
                    policyName: 
                    region: Europe (Frankfurt)
                    replicaRegion: ''
                    fileShareType: AwsEfs
                    name: 
                    snapshotsCount: 7
                    replicaSnapshotsCount: 0
                    latestSnapshotDate: '2024-07-18T04:00:17.2330000+02:00'
                    latestReplicaSnapshotDate: 
                    totalSize: 43008
                  - fileShareUid: 841f0250-e895-4ce5-8524-066f462049a6
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    policyUid: 
                    policyName: 
                    region: Europe (Frankfurt)
                    replicaRegion: ''
                    fileShareType: AwsEfs
                    name: 
                    snapshotsCount: 13
                    replicaSnapshotsCount: 0
                    latestSnapshotDate: '2024-04-02T09:20:32.9630000+02:00'
                    latestReplicaSnapshotDate: 
                    totalSize: 79872
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/publicCloud/fileShares/{fileShareUid}/backups':
    get:
      tags:
        - Protected Public Cloud Workloads
      summary: Get All Backups of Protected Cloud File Shares
      description: Returns a collection resource representation of all backups created for a protected cloud file share with the specified UID.
      operationId: GetProtectedCloudFileShareBackupsByShare
      parameters:
        - name: fileShareUid
          in: path
          description: File share UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudFileShareBackup'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - fileShareUid: 07a74808-e50d-4b45-8efa-ea979a94c07e
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    policyUid: 
                    policyName: 
                    region: Europe (Frankfurt)
                    replicaRegion: ''
                    fileShareType: AwsEfs
                    name: 
                    snapshotsCount: 2
                    replicaSnapshotsCount: 0
                    latestSnapshotDate: '2024-07-17T05:00:16.6600000+02:00'
                    latestReplicaSnapshotDate: 
                    totalSize: 13828915200
                  - fileShareUid: 07a74808-e50d-4b45-8efa-ea979a94c07e
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    policyUid: 85949e9d-d160-44f1-8efd-af68e671346a
                    policyName: dm-latest-temp-efs-policy
                    region: Europe (Frankfurt)
                    replicaRegion: EU (Stockholm) (eu-north-1)
                    fileShareType: AwsEfs
                    name: dm-latest-temp-efs-policy
                    snapshotsCount: 4
                    replicaSnapshotsCount: 8
                    latestSnapshotDate: '2024-07-17T21:00:18.2270000+02:00'
                    latestReplicaSnapshotDate: '2024-07-17T21:00:18.2270000+02:00'
                    totalSize: 27657830400
                  - fileShareUid: 07a74808-e50d-4b45-8efa-ea979a94c07e
                    backupServerUid: 8b9cc81f-bc80-4c6b-abbc-31dbc19de822
                    organizationUid: 10488f95-1de4-43b3-936b-0bb3fd9182eb
                    policyUid: 85949e9d-d160-44f1-8efd-af68e671346a
                    policyName: dm-latest-temp-efs-policy
                    region: Europe (Frankfurt)
                    replicaRegion: EU (Stockholm) (eu-north-1)
                    fileShareType: AwsEfs
                    name: dm-latest-temp-efs-policy
                    snapshotsCount: 4
                    replicaSnapshotsCount: 8
                    latestSnapshotDate: '2024-07-17T21:00:18.2270000+02:00'
                    latestReplicaSnapshotDate: '2024-07-17T21:00:18.2270000+02:00'
                    totalSize: 55315660800
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/publicCloud/networks:
    get:
      tags:
        - Protected Public Cloud Workloads
      summary: Get All Protected Cloud Networks
      description: Returns a collection resource representation of all protected cloud networks.
      operationId: GetProtectedCloudNetworks
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ProtectedCloudNetwork'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceId: 51e083a1-928c-4153-aea7-fbd2bd7fdd60__77438d42-6545-43e7-827b-fbb1d54101c1
                    accountUid: 0bb92ea5-727c-4089-b1b6-6e6dcd6a19fd
                    accountName: 
                    subscriptionUid: 77438d42-6545-43e7-827b-fbb1d54101c1
                    subscriptionName: Enterprise - US
                    regionTag: 
                    regionName: 
                    policyUid: fda8f6f0-0db8-455b-b987-d883704b8d57
                    policyName: dvb-555-az-Virtual network backup policy
                    applianceUid: d6a301e7-aca2-4ed6-85b6-f77b8e21c636
                    backupServerUid: 0ed3892f-f4b9-4879-b0b0-a13c9f072724
                    backupServerName: AZ-VSPC-07
                    restorePointsCount: 30
                    platformType: Azure
                    lastBackup: '2024-08-02T12:00:05.1964400+02:00'
                    locationUid: de2f144f-9e26-4932-992e-09e990db1914
                    organizationUid: e8c457c7-1414-4128-bfba-f3bae5ed3037
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /alarms/templates:
    get:
      tags:
        - Alarms
      summary: Get All Alarm Templates
      description: Returns a collection resource representation of all Veeam Service Provider Console alarm templates.
      operationId: GetAlarms
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Alarm'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7fc323c0-6a55-44bd-b5b5-8af7566c349f
                    name: Job state
                    category: BackupVmJob
                    organizationUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    internalId: 1
                    knowledge:
                      summary: Job is in a disabled state or without any configured schedule for more than an allowed time period.
                      cause: 'Veeam Backup & Replication server allows disabling scheduled jobs during maintenance windows. If a job stays in a disabled state or does not have any schedule at all for more than an allowed time period, it should be enabled back or the schedule has to be configured.'
                      resolution: Enable all disabled jobs using the backup portal UI or the Veeam Backup & Replication console.
                    isPredifined: true
                    isEnabled: true
                  - instanceUid: 721eae8d-708b-4999-b115-2c41af111ed0
                    name: Max allowed job duration
                    category: BackupVmJob
                    organizationUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    internalId: 2
                    knowledge:
                      summary: Job has exceeded its allowed execution time.
                      cause: Veeam job has exceeded the configured threshold of maximum allowed job duration.
                      resolution: 'Verify that VMware CBT was used for all VMs in the configured backup/replication job. Check the number of read and transferred data blocks for each VM or changed files during the latest file job session, make sure your Veeam proxy servers have sufficient number of concurrently running tasks allowed. Alternatively, adjust the maximum allowed job duration threshold for this alarm. Once triggered, this alarm needs to be resolved manually.'
                    isPredifined: true
                    isEnabled: false
                  - instanceUid: 26a320d7-0c31-4df2-9cf0-e3f3555b4650
                    name: Backup proxy connection state
                    category: BackupProxy
                    organizationUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    internalId: 3
                    knowledge:
                      summary: Veeam Backup & Replication server lost connection to the proxy server.
                      cause: 'Veeam Backup & Replication may lose connection to the backup proxy due to one of the following reasons: failure of the network cable, disconnect of the cable, failure of the physical network card, backup proxy services failure, firewall issues, backup proxy power state.'
                      resolution: Verify that backup proxy is accessible by Veeam Backup & Replication server. Check firewall settings on the proxy server (if applicable) and make sure Veeam backup proxy services are up and running.
                    isPredifined: true
                    isEnabled: true
                  - instanceUid: 84d7d0bf-a4c8-40b5-9706-77ea821d5f28
                    name: Backup repository connection state
                    category: BackupRepository
                    organizationUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                    internalId: 4
                    knowledge:
                      summary: Veeam Backup & Replication server lost connection to the backup repository.
                      cause: 'Veeam Backup & Replication may lose connection to the backup repository due to one of the following reasons: failure of the network cable, disconnect of the cable, failure of the physical network card, backup repository services failure, firewall issues, backup repository power state.'
                      resolution: Verify that backup repository is accessible by both backup proxy and Veeam Backup & Replication servers. Check firewall settings on the proxy server (if applicable) and make sure Veeam backup repository services are up and running.
                    isPredifined: true
                    isEnabled: true
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/alarms/templates/{alarmUid}':
    get:
      tags:
        - Alarms
      summary: Get Alarm Template
      description: Returns a resource representation of an alarm template with the specified UID.
      operationId: GetAlarm
      parameters:
        - name: alarmUid
          in: path
          description: Alarm template UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Alarm'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 0a43d661-ec99-4765-8bb8-ad27bcba0d7f
                  name: Backup agent job state
                  category: BackupAgentJob
                  organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                  internalId: 100
                  knowledge:
                    summary: Managed computer failed to be backed up successfully.
                    cause: The latest backup job configured was not successful for the managed computer.
                    resolution: Locate the computer that has a failed job session and re-run the job.
                  isPredifined: true
                  isEnabled: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Alarms
      summary: Delete Alarm Template
      description: Deletes an alarm template with the specified UID.
      operationId: DeleteAlarm
      parameters:
        - name: alarmUid
          in: path
          description: Alarm template UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/alarms/templates/{alarmUid}/clone':
    post:
      tags:
        - Alarms
      summary: Clone Alarm Template
      description: Creates a clone of an alarm template with the specified UID.
      operationId: CloneAlarm
      parameters:
        - name: alarmUid
          in: path
          description: Alarm template UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: cloneName
          in: query
          description: 'Name of an alarm template clone. If not specified, the name is *\<source alarm template name> copy*.'
          schema:
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Alarm'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 3347a782-d1f5-4aff-846d-0df0866d4fdd
                  name: SP_Cloned Alarm Template
                  category: BackupVmJob
                  organizationUid: 12f787d6-2a97-4ca4-89bf-cad2426d5503
                  internalId: 1
                  knowledge:
                    summary: Job is in a disabled state or without any configured schedule for more than an allowed time period.
                    cause: 'Veeam Backup & Replication server allows disabling scheduled jobs during maintenance windows. If a job stays in a disabled state or does not have any schedule at all for more than an allowed time period, it should be enabled back or the schedule has to be configured.'
                    resolution: Enable all disabled jobs using the backup portal UI or the Veeam Backup & Replication console.
                  isPredifined: false
                  isEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  '/alarms/templates/{alarmUid}/events':
    get:
      tags:
        - Alarms
      summary: Get Alarm Status Changes
      description: Returns all status changes of a triggered alarm with the specified template UID.
      operationId: GetActiveAlarmsByAlarm
      parameters:
        - name: alarmUid
          in: path
          description: Alarm template UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ActiveAlarm'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: e1806992-f33f-41cf-8cc1-e7da135b0241
                    alarmTemplateUid: 6ae7f72f-d5f3-4af8-b4eb-86581771c2fe
                    repeatCount: 1
                    object:
                      instanceUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                      type: Reseller
                      organizationUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                      locationUid: 
                      managementAgentUid: 
                      computerName: 
                      objectUid: e6057ff9-99f7-47c8-9d9b-7220a29ab33a
                      objectName: R3_Res
                    lastActivation:
                      instanceUid: cc0ba4f4-1286-4c59-898a-727b2c1675c6
                      time: '2023-11-19T06:40:22.3398882+01:00'
                      status: Warning
                      message: "Quota for the \"Hardware plan 1\" hardware plan has been exceeded. You cannot assign new companies to this plan.\r\n"
                      remark: "\r\n"
                    area: vspc
                  - instanceUid: be23d97e-2172-4d9d-82c5-d22f0dfc7eb0
                    alarmTemplateUid: 6ae7f72f-d5f3-4af8-b4eb-86581771c2fe
                    repeatCount: 1
                    object:
                      instanceUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                      type: Reseller
                      organizationUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                      locationUid: 
                      managementAgentUid: 
                      computerName: 
                      objectUid: 4e66bccf-9c1e-4138-84ff-572c59a796cf
                      objectName: R3_SecondRes
                    lastActivation:
                      instanceUid: bea48608-831d-440e-be17-c027b7392c4e
                      time: '2023-11-19T06:40:22.3554582+01:00'
                      status: Warning
                      message: "Quota for the \"Auto Hardware plan 1\" hardware plan has been exceeded. You cannot assign new companies to this plan.\r\n"
                      remark: "\r\n"
                    area: vspc
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /alarms/active:
    get:
      tags:
        - Alarms
      summary: Get All Triggered Alarms
      description: Returns collection resource representation of all Veeam Service Provider Console triggered alarms.
      operationId: GetActiveAlarms
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ActiveAlarm'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 06cd8ec1-f2f4-4156-9614-075fffb21ca1
                    alarmTemplateUid: c5b728d2-9c9f-45ed-a127-5baf2af96ec0
                    repeatCount: 1
                    object:
                      instanceUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                      type: Internal
                      organizationUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                      locationUid: 
                      managementAgentUid: 
                      computerName: VSPC1
                      objectUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                      objectName: VSPC1
                    lastActivation:
                      instanceUid: 7c32b0ea-907d-493b-b85e-f5c853b792ac
                      time: '2023-11-19T04:35:05.4970000+01:00'
                      status: Info
                      message: "License auto-update functionality is not enabled.\r\n"
                      remark: "\r\n"
                    area: vspc
                  - instanceUid: 694d5ce8-f72a-4f96-a691-18d11495b3b8
                    alarmTemplateUid: 917f3b1c-9e81-4cfd-841e-fc07a0097512
                    repeatCount: 1
                    object:
                      instanceUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                      type: Internal
                      organizationUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                      locationUid: 
                      managementAgentUid: 
                      computerName: VSPC1
                      objectUid: 12f787d6-2a97-4ca4-89bf-cad1326d5503
                      objectName: VSPC1
                    lastActivation:
                      instanceUid: 4501196f-ee2b-45a6-8e75-a08c2f529106
                      time: '2023-11-19T04:55:06.1030000+01:00'
                      status: Warning
                      message: "The same license ID 11112222-1111-2222-3333-111122223333 has been detected for backup servers: VSPC1 (My Company), r2SecondCC (My Company), R2THIRDCC (My Company), R2THIRDVBR (CCTenantThird)\r\n"
                      remark: "\r\n"
                    area: vspc
                  - instanceUid: f99e9714-d98d-4def-b753-1bc7c714fc95
                    alarmTemplateUid: f7388efd-8646-4ec1-9c8b-b049c2410444
                    repeatCount: 1
                    object:
                      instanceUid: 2c99e143-586f-6729-aed4-fb2147ab3e39
                      type: BackupAgent
                      organizationUid: ada1a61e-caaf-4352-85ef-fae903037163
                      locationUid: 4293a662-3fa0-4586-b53e-26657c7a6f31
                      managementAgentUid: 734e931c-7ada-43bd-975d-968556c56b27
                      computerName: r2vaw2
                      objectUid: 6bbf3b42-5585-2ba6-9df2-515b8e62e1ea
                      objectName: Windows workstation - Personal files_r2vaw2
                    lastActivation:
                      instanceUid: e1fc6f83-d399-473d-a423-0c6fdf3f2427
                      time: '2023-11-19T09:45:44.4565372+01:00'
                      status: Resolved
                      message: "Job session for \"Windows workstation - Personal files_r2vaw2\" finished with success.\r\n"
                      remark: "\r\n"
                    area: vspc
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/alarms/active/{activeAlarmUid}':
    get:
      tags:
        - Alarms
      summary: Get Triggered Alarm
      description: Returns a resource representation of a triggered alarm with the specified UID.
      operationId: GetActiveAlarm
      parameters:
        - name: activeAlarmUid
          in: path
          description: Triggered alarm UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ActiveAlarm'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: e4699170-d8c0-40f4-b195-bab2d96f9518
                  alarmTemplateUid: f7388efd-8646-4ec1-9c8b-b049c2410455
                  repeatCount: 1
                  object:
                    instanceUid: 25f8198c-3f6d-6485-aabd-2ef0295cc1d6
                    type: BackupAgent
                    organizationUid: ec1f3101-3703-4b6b-8d19-5b68b1fdf795
                    locationUid: 528ae69c-9534-4e30-97d5-2a398cb97b25
                    managementAgentUid: d6d4e785-7267-407b-9253-d229d7bfb27d
                    computerName: r2vawRule
                    objectUid: d3533b42-475c-a193-4c1f-4c08fbff63cb
                    objectName: Windows workstation - Personal files_r2vawRule
                  lastActivation:
                    instanceUid: dfad463c-0343-4604-a817-9cb1377ffcb7
                    time: '2023-11-19T06:35:22.1977669+01:00'
                    status: Error
                    message: "Job session for \"Windows workstation - Personal files_r2vawRule\" finished with error. \nError: Operation was canceled by user WORKGROUP\\SYSTEM\r\n"
                    remark: "\r\n"
                  area: vspc
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Alarms
      summary: Delete Triggered Alarm
      description: Deletes a triggered alarm with the specified UID.
      operationId: DeleteActiveAlarm
      parameters:
        - name: activeAlarmUid
          in: path
          description: Triggered alarm UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/alarms/active/{activeAlarmUid}/history':
    get:
      tags:
        - Alarms
      summary: Get Triggered Alarm History
      description: Returns a collection resource representation of all status changes of a triggered alarm with the specified UID in chronological order.
      operationId: GetActiveAlarmHistory
      parameters:
        - name: activeAlarmUid
          in: path
          description: Triggered alarm UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/AlarmActivation'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7c32b0ea-907d-493b-b85e-f5c853b792ac
                    time: '2023-11-19T04:35:05.4970000+01:00'
                    status: Info
                    message: "License auto-update functionality is not enabled.\r\n"
                    remark: "\r\n"
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/alarms/active/{activeAlarmUid}/resolve':
    post:
      tags:
        - Alarms
      summary: Resolve Triggered Alarm
      description: Resolves a triggered alarm with the specified UID.
      operationId: ResolveActiveAlarm
      parameters:
        - name: activeAlarmUid
          in: path
          description: Triggered alarm UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: comment
          in: query
          description: Comment about resolving the alarm.
          required: true
          schema:
            maxLength: 512
            type: string
        - name: resolveOnClients
          in: query
          description: Defines whether the alarm must be resolved on a client portal.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/alarms/active/{activeAlarmUid}/acknowledge':
    post:
      tags:
        - Alarms
      summary: Acknowledge Triggered Alarm
      description: Assigns the Acknowledged status to a triggered alarm with the specified UID.
      operationId: AcknowledgeActiveAlarm
      parameters:
        - name: activeAlarmUid
          in: path
          description: Triggered alarm UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: comment
          in: query
          description: Comment about acknowledging the alarm.
          required: true
          schema:
            maxLength: 512
            type: string
        - name: resolveOnClients
          in: query
          description: Defines whether the alarm must be acknowledged on a client portal.
          required: true
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /misc/currencies:
    get:
      tags:
        - Misc
      summary: Get All Currencies
      description: Returns a collection resource representation of all currencies.
      operationId: GetCurrencies
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Currency'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: 1
                    name: Zimbabwe Dollar
                    code: ZWD
                  - id: 2
                    name: Rand
                    code: ZAR
                  - id: 3
                    name: CFA Franc BCEAO
                    code: XOF
                  - id: 4
                    name: Dong
                    code: VND
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /misc/countries:
    get:
      tags:
        - Misc
      summary: Get All Countries
      description: Returns a collection resource representation of all countries.
      operationId: GetCountries
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Country'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: 3
                    name: Afghanistan
                    code: AF
                  - id: 4
                    name: Albania
                    code: AL
                  - id: 5
                    name: Algeria
                    code: DZ
                  - id: 6
                    name: American Samoa
                    code: DS
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /misc/usaStates:
    get:
      tags:
        - Misc
      summary: Get All USA States
      description: Returns a collection resource representation of all USA states.
      operationId: GetUsaStates
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UsaState'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: 1
                    name: Alabama
                    code: AL
                  - id: 2
                    name: Alaska
                    code: AK
                  - id: 3
                    name: Arizona
                    code: AZ
                  - id: 4
                    name: Arkansas
                    code: AR
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /eventLogs/activityLogs:
    get:
      tags:
        - Event Logs
      summary: Get All Activity Log Records
      description: Returns a collection resource representation of all activity log records.
      operationId: GetActivityLogs
      parameters:
        - name: from
          in: query
          description: Start date and time of the activities.
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          description: End date and time of the activities.
          schema:
            type: string
            format: date-time
        - name: organizationUid
          in: query
          description: UID of an organization for which the activities were performed.
          schema:
            type: string
            format: uuid
        - name: userUid
          in: query
          description: UID of a user that initiated the activities.
          schema:
            type: string
            format: uuid
        - name: activityLogKind
          in: query
          description: Type of the activities.
          schema:
            $ref: '#/components/schemas/ActivityLogKind'
        - name: dateSortingDirection
          in: query
          description: Type of resource sorting by activity initiation date and time.
          schema:
            enum:
              - ascending
              - descending
            type: string
            default: descending
            x-ms-enum:
              name: SortDirection
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ActivityLog'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - message: administrator account logged in from fd00:ac21:0:21a5:0:fc96:bb7a:ba2f using Company account authentication type
                    activityLogType: LoginSuccessful
                    activityKind: External
                    date: '2024-08-02T18:12:18.7170000+02:00'
                    userUid: ff747529-d547-4f77-9ba8-7db878b25302
                    organizationUid: 3711d17a-880d-4eb6-a158-ce80d183168f
                  - message: administrator account logged in from fd00:ac21:0:21a5:0:fc96:bb7a:ba2f using Company account authentication type
                    activityLogType: LoginSuccessful
                    activityKind: External
                    date: '2024-08-02T16:30:06.9670000+02:00'
                    userUid: ff747529-d547-4f77-9ba8-7db878b25302
                    organizationUid: 3711d17a-880d-4eb6-a158-ce80d183168f
                  - message: administrator account logged in from fd00:ac21:0:21a5:0:fc96:bb7a:ba2f using Company account authentication type
                    activityLogType: LoginSuccessful
                    activityKind: External
                    date: '2024-08-02T16:30:03.7670000+02:00'
                    userUid: ff747529-d547-4f77-9ba8-7db878b25302
                    organizationUid: 3711d17a-880d-4eb6-a158-ce80d183168f
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /eventLogs/managementAgentTasks:
    get:
      tags:
        - Event Logs
      summary: Get All Management Agent Task Log Records
      description: Returns a collection resource representation of all management agent task log records.
      operationId: GetManagementAgentTasks
      parameters:
        - name: from
          in: query
          description: 'Management agent task start date and time. '
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          description: Management agent task end date and time.
          schema:
            type: string
            format: date-time
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ManagementAgentTask'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 4e4cbef3-8951-458e-82bb-4746ef9a89eb
                    taskType: ManagementAgentConnectionAttempt
                    status: Success
                    description: Connects management agent to the backup portal
                    managementAgentUid: 2f77fe39-e147-43e1-a213-0f2fd8801336
                    startTime: '2024-07-31T15:40:16.1870000+02:00'
                    endTime: '2024-07-31T15:40:16.1870000+02:00'
                  - instanceUid: e0a51a3a-6fff-4e54-aead-1ff4156b5228
                    taskType: ManagementAgentConnectionAttempt
                    status: Success
                    description: Connects management agent to the backup portal
                    managementAgentUid: 2f77fe39-e147-43e1-a213-0f2fd8801336
                    startTime: '2024-07-31T15:41:21.5430000+02:00'
                    endTime: '2024-07-31T15:41:21.5430000+02:00'
                  - instanceUid: f26268a0-f39f-4870-8954-5910bc83da5a
                    taskType: DataCollectionJob
                    status: Success
                    description: Collects data from discovered Veeam products
                    managementAgentUid: 2f77fe39-e147-43e1-a213-0f2fd8801336
                    startTime: '2024-07-31T15:41:21.7300000+02:00'
                    endTime: '2024-07-31T15:41:29.1230000+02:00'
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /infrastructure/jobSessionHeatmap/:
    get:
      tags:
        - Preview Operations
      summary: Get Session States Dashboard
      description: Returns a resource representation of the Session States dashboard.
      operationId: GetJobSessionHeatmap
      parameters:
        - name: from
          in: query
          description: Start date and time of the period for which job session data is collected.
          required: true
          schema:
            type: string
            format: date-time
        - name: to
          in: query
          description: End date and time of the period for which job session data is collected.
          required: true
          schema:
            type: string
            format: date-time
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/JobSessionHeatmap'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  successJobsCount: 0
                  warningJobsCount: 0
                  failJobsCount: 2
                  dataPerDays:
                    - date: '2025-08-08T02:00:00.0000000+02:00'
                      sessions:
                        - jobName: vbrjob1
                          serverName: s12hosted
                          managementAgentUid: 224900fa-febb-4a73-9a6a-bea4e0a55420
                          locationName: Default location
                          locationUid: d6c9d2d3-3aaa-4ffd-b3a5-9a10ad594e06
                          organizationName: My Company
                          organizationUid: 712a1d88-ed86-4ae7-a28f-cb2d77fee6a0
                          startTime: '2025-08-08T13:15:20.0512810+02:00'
                          endTime: '2025-08-08T13:15:36.9879950+02:00'
                          duration: 16
                          sessionUid: 43128413-cf7c-4be6-b584-4d337b1fa147
                          failureMessage: "Unable to process included VM: cannot find VM ms-vo-vapp-vm-1.\r\nms-vo-vapp-1:\r\nTask failed. Error: Cannot find ms-vo-vapp-1 in hierarchy.\r\n"
                          timeShiftMinutes: 120
                          result: Failed
                          jobType: Backup
                          workloadType: Vm
                          platformType: VCD
                        - jobName: job24
                          serverName: l12hosted
                          managementAgentUid: 224900fa-febb-4a73-9a6a-bea4e0a55420
                          locationName: Default location
                          locationUid: d6c9d2d3-3aaa-4ffd-b3a5-9a10ad594e06
                          organizationName: My Company
                          organizationUid: 712a1d88-ed86-4ae7-a28f-cb2d77fee6a0
                          startTime: '2025-08-08T13:15:20.0825390+02:00'
                          endTime: '2025-08-08T13:15:37.3004710+02:00'
                          duration: 17
                          sessionUid: 47d85d93-5397-4a24-9438-824c4bd7e31e
                          failureMessage: "Unable to process included VM: cannot find VM ms-vo-vapp-vm-1.\r\nms-vo-vapp-1:\r\nTask failed. Error: Cannot find ms-vo-vapp-1 in hierarchy.\r\n"
                          timeShiftMinutes: 120
                          result: Failed
                          jobType: Backup
                          workloadType: Vm
                          platformType: VCD
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/enterpriseManagers:
    get:
      tags:
        - Enterprise Manager
      summary: Get All Veeam Backup Enterprise Manager servers
      description: Returns a collection resource representation of all Veeam Backup Enterprise Manager servers.
      operationId: GetEnterpriseManagers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EnterpriseManager'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: d72c39ea-b1d3-4663-9a71-74a6351af66a
                    name: r2em
                    managementAgentUid: d72c39ea-b1d3-4663-9a71-74a6351af66a
                    installationUid: e1cccb94-df46-4719-8d51-2a909391201b
                    version: 12.0.0.1379
                    status: Healthy
                  - instanceUid: 8d5bd064-f739-4ce9-8d98-22e83cc6cb02
                    name: r3em
                    managementAgentUid: d6f13c3b-205b-43f4-9f69-68e71f186160
                    installationUid: 051a6b39-98e7-4a93-a844-b81758e0d758
                    version: 12.0.0.1379
                    status: Healthy
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/enterpriseManagers/{enterpriseManagerUid}':
    get:
      tags:
        - Enterprise Manager
      summary: Get Veeam Backup Enterprise Manager Server
      description: Returns a resource representation of a Veeam Backup Enterprise Manager server with the specified UID.
      operationId: GetEnterpriseManager
      parameters:
        - name: enterpriseManagerUid
          in: path
          description: Veeam Backup Enterprise Manager server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/EnterpriseManager'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d72c39ea-b1d3-4663-9a71-74a6351af66a
                  name: r2em
                  managementAgentUid: d72c39ea-b1d3-4663-9a71-74a6351af66a
                  installationUid: e1cccb94-df46-4719-8d51-2a909391201b
                  version: 12.0.0.1379
                  status: Healthy
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/enterpriseManagers/{enterpriseManagerUid}/backupServers':
    get:
      tags:
        - Enterprise Manager
      summary: Get Backup Servers Managed by Veeam Backup Enterprise Manager Server
      description: Returns a collection resource representation of all Veeam Backup & Replication servers that are managed by a Veeam Backup Enterprise Manager server with specified UID.
      operationId: GetBackupServersByEnterpriseManager
      parameters:
        - name: enterpriseManagerUid
          in: path
          description: Veeam Backup Enterprise Manager server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/EnterpriseManagerBackupServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                    address: r2vbr.tech.local
                    port: 9392
                    backupServer:
                      instanceUid: 47664f7a-8f3f-4275-91fc-89a119b5497f
                      name: r2vbr
                      organizationUid: 30780260-6bed-47eb-b1ac-d12de2ce5b9d
                      locationUid: e7703482-2440-428e-9ff7-10817f55e4a8
                      managementAgentUid: 44db72c8-bf6a-4b0c-8ad0-54a303660484
                      version: 12.0.0.1379
                      displayVersion: 12.0.0.1379
                      installationUid: af8c891e-54fc-4ea0-9b38-a184912b4875
                      backupServerRoleType: Client
                      status: Healthy
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/voneServers:
    get:
      tags:
        - Veeam ONE Server
      summary: Get All Connected Veeam ONE Servers
      description: Returns a collection resource representation of all Veeam ONE servers connected to Veeam Service Provider Console.
      operationId: GetVOneServers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/VOneServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 6cdb790b-afd8-499a-bf16-158f8bb7785b
                    locationUid: 8780f441-dbb9-4a72-83d4-548cc9c4a371
                    organizationUid: eb3d319a-65fa-4427-aa12-5cd0ddf5027e
                    managementAgentUid: 64a3669d-cd77-452e-8ebb-6366af55a5af
                    installationUid: 6cdb790b-afd8-499a-bf16-158f8bb7785b
                    name: VO
                    version: 12.1.0.3009
                    status: Healthy
                    managementAgentStatus: Healthy
                    alarmsSynchronizationStatus: Disabled
                  - instanceUid: c7b8029a-f3f4-4c4c-bf10-0eea8e573dcf
                    locationUid: cdc60d8b-d613-472e-ba0f-3c01f65a60d2
                    organizationUid: 29027ce0-6a0d-45ed-87a3-aa25105559c7
                    managementAgentUid: 3deb7c5a-6b6a-477e-b8b7-ffb995a36a13
                    installationUid: c7b8029a-f3f4-4c4c-bf10-0eea8e573dcf
                    name: VO2
                    version: 12.1.0.3009
                    status: Healthy
                    managementAgentStatus: Healthy
                    alarmsSynchronizationStatus: Disabled
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/voneServers/{vOneServerUid}':
    get:
      tags:
        - Veeam ONE Server
      summary: Get Connected Veeam ONE Server
      description: Returns a resource representation of a connected Veeam ONE server with the specified UID.
      operationId: GetVOneServer
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VOneServer'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 6cdb790b-afd8-499a-bf16-158f8bb7785b
                  locationUid: 8780f441-dbb9-4a72-83d4-548cc9c4a371
                  organizationUid: eb3d319a-65fa-4427-aa12-5cd0ddf5027e
                  managementAgentUid: 64a3669d-cd77-452e-8ebb-6366af55a5af
                  installationUid: 6cdb790b-afd8-499a-bf16-158f8bb7785b
                  name: VO
                  version: 12.1.0.3009
                  status: Healthy
                  managementAgentStatus: Healthy
                  alarmsSynchronizationStatus: Disabled
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/voneServers/{vOneServerUid}/settings':
    get:
      tags:
        - Veeam ONE Server
      summary: Get Alarm Options for Veeam ONE Server
      description: Returns a resource representation of alarm options configured for a Veeam ONE server with the specified UID.
      operationId: GetVOneServerSettings
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VOneServerSettings'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  alarmsSynchronizationEnabled: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    put:
      tags:
        - Veeam ONE Server
      summary: Update Alarm Options for Veeam ONE Server
      description: Updates alarm options configured for a Veeam ONE server with the specified UID.
      operationId: UpdateVOneServerSettings
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VOneServerSettings'
            example:
              alarmsSynchronizationEnabled: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/voneServers/{vOneServerUid}/collect':
    post:
      tags:
        - Veeam ONE Server
      summary: Enforce Data Collection from Connected Veeam ONE Server
      description: "Enforces data collection from a connected Veeam ONE server with the specified UID.\n>Returns a positive response when the collection task is added to the internal queue and not when the task is executed.\n"
      operationId: ForceCollectVOneServer
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/voneServers/{vOneServerUid}/renewInstallationUid':
    post:
      tags:
        - Veeam ONE Server
      summary: Generate New Veeam ONE Installation UID
      description: "Generates a new Veeam ONE installation UID for a Veeam ONE server with the specified UID.\n> If you generate a new installation UID during a license reporting period, you will not be able to approve a license usage report for that period. \n"
      operationId: RenewVOneServerInstallationUid
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    description: Veeam ONE installation UID.
                    format: uuid
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: 11ab183f-9d80-469a-aa40-2281617a12d2
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/voneServers/{vOneServerUid}/upgrade/iso/predownload':
    post:
      tags:
        - Preview Operations
      summary: Download Veeam ONE Upgrade Setup File
      description: Downloads the Veeam ONE upgrade setup file for further installation to a server with the specified UID.
      operationId: PredownloadVOneServerIso
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: File download configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VOneIsoPredownloadInput'
            example:
              path: C:\ProgramData\Veeam\Veeam Availability Console
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/DeploymentTaskResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  deploymentTaskUid: b68fbe4d-9886-430a-8389-fc01da7b081b
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/voneServers/{vOneServerUid}/upgrade':
    post:
      tags:
        - Deployment
      summary: Update Veeam ONE on Server
      description: "Installs the latest Veeam ONE update on a server with the specified UID.\n> To track the installation progress, you can use the `WaitDeploymentTask` operation.       \n"
      operationId: UpgradeVOneServer
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Deployment configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VOneDeploymentConfiguration'
            example:
              distribution:
                filePath: \\tech.local\tech\VSPC\VBR\13\Butler\VeeamONE_13.0.0.5457_20250723.iso
                userName: vspc\admin
                password: Password1
              usePredownloadedIso: 
              answerXml: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<unattendedInstallationConfiguration bundle=\"Vo\" mode=\"upgrade\" version=\"1.0\">\r\n  <properties>\r\n\r\n    <!--License agreements-->\r\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\r\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\r\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\r\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\r\n\r\n    <!--License file-->\r\n    <property name=\"VO_LICENSE_FILE\" value=\"\" />\r\n    <property name=\"VO_LICENSE_AUTOUPDATE\" value=\"1\" />\r\n\r\n    <!--Service account-->\r\n    <property name=\"VO_SERVICE_USER\" value=\"vspc\\administrator\" />\r\n    <property name=\"VO_SERVICE_PASSWORD\" value=\"Password1\" hidden=\"1\" />\r\n\r\n    <!--Database configuration-->\r\n    <property name=\"VO_SQLSERVER_USERNAME\" value=\"\" />\r\n    <property name=\"VO_SQLSERVER_PASSWORD\" value=\"\" hidden=\"1\"/>\r\n\r\n    <!--Ports configuration-->\r\n    <property name=\"VO_MONITORING_SERVICE_PORT\" value=\"2714\" />\r\n    <property name=\"VO_REPORTING_SERVICE_PORT\" value=\"2742\" />\r\n    <property name=\"VO_INTERNAL_WEB_API_PORT\" value=\"2741\"  />\r\n    <!--Certificate configuration-->\r\n    <property name=\"VO_CERTIFICATE_THUMBPRINT\" value=\"\" />\r\n\r\n    <!--Server connection-->\r\n    <property name=\"VO_CONNECTION_SERVER_NAME\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_WEB_API_PORT\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_USER\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_PASSWORD\" value=\"\" hidden=\"1\" />\r\n\r\n"
              allowAutoReboot: true
              stopAllActivities: 
              useManagementAgentCredentials: 
              adminCredentials:
                username: vspc\administrator
                password: Password1
        required: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: b68fbe4d-9886-430a-8389-fc01da7b081b
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /deployment/deploy/voneServers/configuration/xml:
    get:
      tags:
        - Deployment
      summary: Get Example for Veeam ONE Server Deployment Configuration
      description: "Returns a resource representation of an example for Veeam ONE server deployment configuration in the `XML` format.\n> Error response is returned in the `JSON` format.\n"
      operationId: GetVOneServerDeploymentConfigurationXml
      parameters:
        - name: voneServerDeploymentType
          in: query
          description: Deployment type.
          required: true
          schema:
            enum:
              - installation
              - upgrade
            type: string
            x-ms-enum:
              name: VOneServerDeploymentType
        - name: managementAgentUid
          in: query
          description: "UID assigned to a management agent installed on a server on which Veeam ONE must be deployed. \n> If Veeam ONE is already installed on the server, Veeam Service Provider Console will automatically provide a configuration file suitable for the installed version.\n> If Veeam ONE is not installed, Veeam Service Provider Console will provide a configuration file suitable for the latest Veeam ONE version.\n"
          schema:
            type: string
            format: uuid
            nullable: true
        - name: escapeCharacters
          in: query
          description: Defines whether escape characters are enabled.
          schema:
            type: boolean
            default: false
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/xml:
              schema:
                type: object
                description: Deployment configuration example in the `XML` format.
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  '/infrastructure/voneServers/{vOneServerUid}/patch/upload/multipart/create':
    post:
      tags:
        - Preview Operations
      summary: Start Veeam ONE Patch Upload to Server
      description: Initiates upload of a Veeam ONE patch to a server with the specified UID.
      operationId: CreateVOneServerMultipartPatch
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateVOneServerMultipartPatchInput'
            example:
              files:
                - name: Veeam.One.Core.dll
                  fileSize: 180605200
                  targetDirectory: \PatchFolder
              action: ReplaceFilesAndRestart
              stopAllActivities: true
              rebootAutomatically: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/VOneServerMultipartPatchInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  uploadUid: 69d70dc2-25d4-4e82-a0fc-d89c1d847ec7
                  files:
                    - name: Veeam.One.Core.dll
                      fileStreamUid: 6d18e5fe-20e5-4248-a87f-29a109a44b80
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/voneServers/{vOneServerUid}/patch/upload/multipart/uploadPart':
    post:
      tags:
        - Preview Operations
      summary: Upload Patch File Chunk to Veeam ONE Server
      description: Uploads a patch file chunk to Veeam ONE server with the specified UID.
      operationId: UploadVOneServerMultipartPatch
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: uploadUid
          in: query
          description: Upload UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: fileStreamUid
          in: query
          description: Single file UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: partNumber
          in: query
          description: File chunk ordinal number.
          required: true
          schema:
            minimum: 1
            type: integer
            format: int32
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        description: "File chunk.\n> Maximum size is 5 MB. Sending a bigger file chunk can return an unexpected error response.\n"
        content:
          application/octet-stream:
            schema:
              maxLength: 5242880
              minLength: 1
              type: string
              format: binary
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/voneServers/{vOneServerUid}/patch/upload/multipart/complete':
    post:
      tags:
        - Preview Operations
      summary: Complete Patch Upload to Veeam ONE Server
      description: Finalizes upload of a Veeam ONE patch to a server with the specified UID.
      operationId: CompleteVOneServerMultipartPatch
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: uploadUid
          in: query
          description: Upload UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: Deployment task UID.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                    format: uuid
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: 5e6bee18-a91e-4b1d-a77e-f9ae815b6730
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/voneServers/{vOneServerUid}/patch/upload/multipart/abort':
    post:
      tags:
        - Preview Operations
      summary: Abort Patch Upload to Veeam ONE Server
      description: Aborts upload of a Veeam ONE patch to a server with the specified UID.
      operationId: AbortVOneServerMultipartPatch
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: uploadUid
          in: query
          description: Upload UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  '/infrastructure/voneServers/{vOneServerUid}/scheduledTasks/upgrade':
    post:
      tags:
        - Deployment
      summary: Schedule Veeam ONE Update
      description: Creates a scheduled task that installs the latest Veeam ONE update on a server with the specified UID.
      operationId: ScheduleUpgradeVOneServer
      parameters:
        - name: vOneServerUid
          in: path
          description: Veeam ONE server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Deployment configuration.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VOneScheduledDeploymentConfiguration'
            example:
              configuration:
                distribution:
                  filePath: \\tech.local\tech\VSPC\VBR\13\Butler\VeeamONE_13.0.0.5457_20250723.iso
                  userName: vspc\admin
                  password: Password1
                usePredownloadedIso: 
                answerXml: "<?xml version=\"1.0\" encoding=\"utf-8\"?>\r\n<unattendedInstallationConfiguration bundle=\"Vo\" mode=\"upgrade\" version=\"1.0\">\r\n  <properties>\r\n\r\n    <!--License agreements-->\r\n    <property name=\"ACCEPT_EULA\" value=\"1\" />\r\n    <property name=\"ACCEPT_LICENSING_POLICY\" value=\"1\" />\r\n    <property name=\"ACCEPT_THIRDPARTY_LICENSES\" value=\"1\" />\r\n    <property name=\"ACCEPT_REQUIRED_SOFTWARE\" value=\"1\" />\r\n\r\n    <!--License file-->\r\n    <property name=\"VO_LICENSE_FILE\" value=\"\" />\r\n    <property name=\"VO_LICENSE_AUTOUPDATE\" value=\"1\" />\r\n\r\n    <!--Service account-->\r\n    <property name=\"VO_SERVICE_USER\" value=\"vspc\\administrator\" />\r\n    <property name=\"VO_SERVICE_PASSWORD\" value=\"Password1\" hidden=\"1\" />\r\n\r\n    <!--Database configuration-->\r\n    <property name=\"VO_SQLSERVER_USERNAME\" value=\"\" />\r\n    <property name=\"VO_SQLSERVER_PASSWORD\" value=\"\" hidden=\"1\"/>\r\n\r\n    <!--Ports configuration-->\r\n    <property name=\"VO_MONITORING_SERVICE_PORT\" value=\"2714\" />\r\n    <property name=\"VO_REPORTING_SERVICE_PORT\" value=\"2742\" />\r\n    <property name=\"VO_INTERNAL_WEB_API_PORT\" value=\"2741\"  />\r\n    <!--Certificate configuration-->\r\n    <property name=\"VO_CERTIFICATE_THUMBPRINT\" value=\"\" />\r\n\r\n    <!--Server connection-->\r\n    <property name=\"VO_CONNECTION_SERVER_NAME\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_WEB_API_PORT\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_USER\" value=\"\" />\r\n    <property name=\"VO_CONNECTION_PASSWORD\" value=\"\" hidden=\"1\" />\r\n\r\n"
                allowAutoReboot: true
                stopAllActivities: 
                useManagementAgentCredentials: 
                adminCredentials:
                  username: vspc\administrator
                  password: Password1
              schedule:
                dateTime: '2025-08-03T11:52:23.6370000+00:00'
        required: true
      responses:
        '200':
          description: Resource representation of a scheduled task.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/ScheduledDeployTaskResponse'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  scheduledTaskUid: c9a5bc4d-4577-4408-a309-9960b6107c4b
                  taskUid: 83ce0e2a-de5d-43ce-86f4-dc906b154c64
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-fire-and-forget: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
  /infrastructure/unactivatedVb365Servers:
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Unactivated Veeam Backup for Microsoft 365 Servers.
      description: Returns a collection resource representation of all unactivated Veeam Backup for Microsoft 365 servers.
      operationId: GetUnactivatedVb365Servers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/UnactivatedVb365Server'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - uniqueUid: 246644ac-7ca0-6d25-8b9b-1089dfe6e8dc
                    locationUid: 8b318186-79f1-4f39-8bb0-3acd5a263b57
                    organizationUid: e3117de2-22b7-4a9a-ae08-30fbd6754519
                    managementAgentUid: 8c0b212c-a2f8-4428-9208-5e146c676c05
                    name: VB2
                    version: 7.0.0.2852
                    status: Inaccessible
                  - uniqueUid: a1da1858-258d-601f-8659-58c30ff19e53
                    locationUid: 49758ce1-0c9a-4e2a-97cc-8d0fded0bd92
                    organizationUid: f31de0ee-ae54-4081-b4fc-e0ce8182c979
                    managementAgentUid: d3acaaaa-e8b5-4234-8ccc-b345a5babf2b
                    name: VB1
                    version: 7.0.0.2852
                    status: Inaccessible
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/unactivatedVb365Servers/{uniqueUid}':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get Unactivated Veeam Backup for Microsoft 365 Server
      description: Returns an resource representation of an Unactivated Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: GetUnactivatedVb365Server
      parameters:
        - name: uniqueUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/UnactivatedVb365Server'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  uniqueUid: 246644ac-7ca0-6d25-8b9b-1089dfe6e8dc
                  locationUid: 8b318186-79f1-4f39-8bb0-3acd5a263b57
                  organizationUid: e3117de2-22b7-4a9a-ae08-30fbd6754519
                  managementAgentUid: 8c0b212c-a2f8-4428-9208-5e146c676c05
                  name: VB2
                  version: 7.0.0.2852
                  status: Inaccessible
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/unactivatedVb365Servers/{uniqueUid}/activate':
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Activate Unactivated Veeam Backup for Microsoft 365 Server
      description: Activates an unactivated Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: ActivateVb365Server
      parameters:
        - name: uniqueUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/vb365Servers:
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Connected Veeam Backup fot Microsoft 365 Servers.
      description: Returns a collection resource representation of all connected Veeam Backup for Microsoft 365 servers.
      operationId: GetVb365Servers
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365Server'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 3a0f9d20-3937-43bb-9a27-342a9dde8bdf
                    locationUid: c6147e3a-9e19-4e05-bb03-0db5e083ab43
                    organizationUid: 0c5fb43b-49b7-4aa7-8efc-7bc5dbdcc81c
                    managementAgentUid: 3a0a4a53-b0eb-4cea-9e5a-5b743736db8e
                    installationUid: 3a0f9d20-3937-43bb-9a27-342a9dde8bdf
                    name: VB4
                    version: 8.0.1.9
                    majorVersion: 8
                    serverApiVersion: V8
                    status: Healthy
                    managementAgentStatus: Healthy
                    ownership: Hosted
                  - instanceUid: 2c5dd019-0a1f-49bf-9f54-de580a51a13f
                    locationUid: c6147e3a-9e19-4e05-bb03-0db5e083ab43
                    organizationUid: 0c5fb43b-49b7-4aa7-8efc-7bc5dbdcc81c
                    managementAgentUid: 938bdd55-b540-4bbf-830c-ed747c520773
                    installationUid: 2c5dd019-0a1f-49bf-9f54-de580a51a13f
                    name: VB3
                    version: 7.1.0.2022
                    majorVersion: 7
                    serverApiVersion: V7
                    status: Healthy
                    managementAgentStatus: Healthy
                    ownership: Hosted
                  - instanceUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                    locationUid: c6147e3a-9e19-4e05-bb03-0db5e083ab43
                    organizationUid: 0c5fb43b-49b7-4aa7-8efc-7bc5dbdcc81c
                    managementAgentUid: 7d66a63f-aa55-4013-8402-7a29a5387527
                    installationUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                    name: VBcc
                    version: 7.1.0.2022
                    majorVersion: 7
                    serverApiVersion: V7
                    status: Healthy
                    managementAgentStatus: Healthy
                    ownership: Hosted
                  - instanceUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                    locationUid: c6147e3a-9e19-4e05-bb03-0db5e083ab43
                    organizationUid: 0c5fb43b-49b7-4aa7-8efc-7bc5dbdcc81c
                    managementAgentUid: 9dceaa29-28e5-4534-ac9b-58d66bae55e8
                    installationUid: de45f8a1-c809-41f1-b6a3-e3d5687c0dbb
                    name: VBvspc
                    version: 8.0.1.9
                    majorVersion: 8
                    serverApiVersion: V8
                    status: Healthy
                    managementAgentStatus: Healthy
                    ownership: Hosted
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/vb365Servers/organizations:
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Microsoft Organizations
      description: "Returns a collection resource representation of all Microsoft organizations.\n> Does not include hybrid and on-premises organizations.\n"
      operationId: GetVb365Organizations
      parameters:
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Vb365OrganizationBaseExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: siteFilter
          in: query
          description: Specifies the list of Veeam Cloud Connect site UIDs that limits the resources to the ones associated with those sites.
          style: form
          schema:
            type: array
            items:
              type: string
              format: uuid
            nullable: true
          x-veeam-pagination-global-site-filer: true
        - name: organizationFilter
          in: query
          description: Specifies the list of organization UIDs that limits the resources to the ones associated with those organizations.
          schema:
            type: string
            format: uuid
            nullable: true
          x-veeam-pagination-global-organization-filter: true
        - name: locationFilter
          in: query
          description: Specifies the list of location UIDs that limits the resources to the ones associated with those locations.
          schema:
            type: string
            format: uuid
            nullable: true
          x-veeam-pagination-global-location-filter: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365OrganizationBase'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 78425f4f-8fa4-4d40-a628-9d4860f42655
                    name: alpha.onmicrosoft.com
                    type: Microsoft365
                    region: Default
                    cloudAuthenticatedMethod: Modern
                    protectedServices:
                      - SharePointOnlineAndOneDriveForBusiness
                      - ExchangeOnline
                      - MicrosoftTeams
                    vb365ServerUid: 75340270-4644-4855-986d-80e8c5d9775c
                    vb365ServerName: VB4
                    locationUid: 
                    locationName: 
                    isBackedUp: false
                    firstBackupTime: 
                    lastBackupTime: 
                    registeredBy: My Company
                    registrationDate: '2025-07-23T04:50:16.0006748+02:00'
                    isRemoving: false
                    isJobSchedulingEnabled: true
                    mappedOrganizationUid: 
                    mappedOrganizationName: 
                    _embedded:
                      organizationDetails: 
                      vb365Server: 
                  - instanceUid: 477ba485-3dbb-4882-ba38-dd8c8d20c8d7
                    name: beta.onmicrosoft.com
                    type: Microsoft365
                    region: Default
                    cloudAuthenticatedMethod: Modern
                    protectedServices:
                      - SharePointOnlineAndOneDriveForBusiness
                      - ExchangeOnline
                      - MicrosoftTeams
                    vb365ServerUid: 8f2e795e-3d5b-479b-88af-9ba2d114044a
                    vb365ServerName: VB3
                    locationUid: 
                    locationName: 
                    isBackedUp: false
                    firstBackupTime: 
                    lastBackupTime: 
                    registeredBy: My Company
                    registrationDate: '2025-07-23T04:49:55.9837537+02:00'
                    isRemoving: false
                    isJobSchedulingEnabled: true
                    mappedOrganizationUid: 
                    mappedOrganizationName: 
                    _embedded:
                      organizationDetails: 
                      vb365Server: 
                  - instanceUid: 7a3059f0-4803-4295-82f8-0f5f493a9e7d
                    name: gamma.onmicrosoft.com
                    type: Microsoft365
                    region: Default
                    cloudAuthenticatedMethod: Modern
                    protectedServices:
                      - SharePointOnlineAndOneDriveForBusiness
                      - ExchangeOnline
                      - MicrosoftTeams
                    vb365ServerUid: e9f1992e-516d-4801-923a-83463413f720
                    vb365ServerName: VBcc
                    locationUid: 
                    locationName: 
                    isBackedUp: false
                    firstBackupTime: 
                    lastBackupTime: 
                    registeredBy: My Company
                    registrationDate: '2025-07-23T04:49:25.9217140+02:00'
                    isRemoving: false
                    isJobSchedulingEnabled: true
                    mappedOrganizationUid: 
                    mappedOrganizationName: 
                    _embedded:
                      organizationDetails: 
                      vb365Server: 
                  - instanceUid: 738fb70d-7425-4796-be62-ea74304c05f6
                    name: delta.onmicrosoft.com
                    type: Microsoft365
                    region: Default
                    cloudAuthenticatedMethod: Modern
                    protectedServices:
                      - SharePointOnlineAndOneDriveForBusiness
                      - ExchangeOnline
                      - MicrosoftTeams
                    vb365ServerUid: fc92c44f-bdab-4bd7-9cc5-1c87865b46c2
                    vb365ServerName: VBvspc
                    locationUid: 
                    locationName: 
                    isBackedUp: false
                    firstBackupTime: 
                    lastBackupTime: 
                    registeredBy: My Company
                    registrationDate: '2025-07-23T04:49:05.9005518+02:00'
                    isRemoving: false
                    isJobSchedulingEnabled: true
                    mappedOrganizationUid: 
                    mappedOrganizationName: 
                    _embedded:
                      organizationDetails: 
                      vb365Server: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/vb365Servers/organizations/companyMappings:
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Microsoft Organization Mappings to Companies
      description: Returns a collection resource representation of all Microsoft organization mappings to companies.
      operationId: GetVb365OrganizationsToCompanyMappings
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365OrganizationToCompanyMapping'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 9523cb37-1327-43a7-aeff-76b318f49c6d
                    vb365OrganizationUid: 8b103cd7-c5c0-4a5f-bb14-e8f9cc395f9e
                    vb365OrganizationName: beta.onmicrosoft.com
                    vb365ServerUid: 099a3f2b-0c40-4e22-995b-22c2931bd72f
                    vb365ServerName: LRSVBOV6-2
                    companyUid: 87810254-6d4b-478c-96f3-73fcbe3fe0d8
                    companyName: t2
                  - instanceUid: 445e2c50-a315-42ef-ba34-6f53c558f9dd
                    vb365OrganizationUid: 9864b18b-ba6c-4679-b924-35cac4818739
                    vb365OrganizationName: rdcloudbackup3.onmicrosoft.com
                    vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                    vb365ServerName: LRSVBO
                    companyUid: aedc27de-485d-44ef-86bd-d9153eb6f728
                    companyName: new
                  - instanceUid: cb407740-13d0-45c0-bdfd-0a74cbac5288
                    vb365OrganizationUid: 44a2a2b1-c3b7-4268-9f1e-c7c7437e964f
                    vb365OrganizationName: gamma.onmicrosoft.com
                    vb365ServerUid: 43bd6147-4201-43b3-b8cd-5e6e45af6023
                    vb365ServerName: LRSVBOTR
                    companyUid: 6e32e9d5-c1ad-4929-b9dd-a1bea4cbdcbd
                    companyName: feorg1
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Map Microsoft Organization to Company
      description: Maps a Microsoft organization to a company.
      operationId: CreateVb365OrganizationToCompanyMapping
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Vb365OrganizationToCompanyMapping'
            example:
              vb365OrganizationUid: 04dd6f18-2c26-4f50-ae4f-cb9f463486a7
              companyUid: 6e32e9d5-c1ad-4929-b9dd-a1bea4cbdcce
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365OrganizationToCompanyMapping'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 3ade07f6-5ec0-454b-bd63-155f7a0a1552
                  vb365OrganizationUid: 04dd6f18-2c26-4f50-ae4f-cb9f463486a7
                  vb365OrganizationName: cnn1.onmicrosoft.com
                  vb365ServerUid: d178d909-ff24-42b1-97be-16255178251f
                  vb365ServerName: LRSVBOV6-1
                  companyUid: 6e32e9d5-c1ad-4929-b9dd-a1bea4cbdcce
                  companyName: feorg1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/vb365Servers/organizations/companyMappings/{mappingUid}':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get Microsoft Organization to Company Mapping
      description: Returns a resource representation of a Microsoft organization to company mapping with the specified UID.
      operationId: GetVb365OrganizationToCompanyMapping
      parameters:
        - name: mappingUid
          in: path
          description: Mapping UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365OrganizationToCompanyMapping'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 445e2c50-a315-42ef-ba34-6f53c558f9dd
                  vb365OrganizationUid: 9864b18b-ba6c-4679-b924-35cac4818739
                  vb365OrganizationName: rdcloudbackup3.onmicrosoft.com
                  vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                  vb365ServerName: LRSVBO
                  companyUid: aedc27de-485d-44ef-86bd-d9153eb6f728
                  companyName: Alpha
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    delete:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Delete Microsoft Organization to Company Mapping
      description: Deletes a Microsoft organization to company mapping with the specified UID.
      operationId: DeleteVb365OrganizationToCompanyMapping
      parameters:
        - name: mappingUid
          in: path
          description: Mapping UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/infrastructure/vb365Servers/{vb365ServerUid}':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get Veeam Backup for Microsoft 365 Server
      description: Returns a resource representation of a connected Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: GetVb365Server
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365Server'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                  locationUid: c6147e3a-9e19-4e05-bb03-0db5e083ab43
                  organizationUid: 0c5fb43b-49b7-4aa7-8efc-7bc5dbdcc81c
                  managementAgentUid: 7d66a63f-aa55-4013-8402-7a29a5387527
                  installationUid: cac1f37d-a177-4cd6-a08b-852cb40dcad7
                  name: VBcc
                  version: 7.1.0.2022
                  majorVersion: 7
                  serverApiVersion: V7
                  status: Healthy
                  managementAgentStatus: Healthy
                  ownership: Hosted
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Delete Veeam Backup for Microsoft 365 Server
      description: "Disconnects Veeam Backup for Microsoft 365 server with the specified UID. \n> The operation is available only for hosted Veeam Backup for Microsoft 365 servers. If you want to disconnect a client server, delete a management agent installed on that server.\n"
      operationId: DeleteVb365Server
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/collect':
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Enforce Data Collection from Veeam Backup for Microsoft 365 Server
      description: "Enforces data collection from a Veeam Backup for Microsoft 365 server with the specified UID.\n> Returns a positive response when the collection task is added to the internal queue and not when the task is executed.'\n"
      operationId: ForceCollectVb365Server
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Microsoft Organizations Managed by Veeam Backup for Microsoft 365 Server
      description: Returns a collection resource representation of all Microsoft organizations managed by Veeam Backup for Microsoft 365 server with the spectified UID.
      operationId: GetVb365OrganizationsByVb365Server
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Vb365OrganizationBaseExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365OrganizationBase'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 78425f4f-8fa4-4d40-a628-9d4860f42655
                    name: alpha.onmicrosoft.com
                    type: Microsoft365
                    region: Default
                    cloudAuthenticatedMethod: Modern
                    protectedServices:
                      - SharePointOnlineAndOneDriveForBusiness
                      - ExchangeOnline
                      - MicrosoftTeams
                    vb365ServerUid: 75340270-4644-4855-986d-80e8c5d9775c
                    vb365ServerName: VB4
                    locationUid: 
                    locationName: 
                    isBackedUp: false
                    firstBackupTime: 
                    lastBackupTime: 
                    registeredBy: My Company
                    registrationDate: '2025-07-23T04:50:16.0006748+02:00'
                    isRemoving: false
                    isJobSchedulingEnabled: true
                    mappedOrganizationUid: 
                    mappedOrganizationName: 
                    _embedded:
                      organizationDetails: 
                      vb365Server: 
                  - instanceUid: 477ba485-3dbb-4882-ba38-dd8c8d20c8d7
                    name: beta.onmicrosoft.com
                    type: Microsoft365
                    region: Default
                    cloudAuthenticatedMethod: Modern
                    protectedServices:
                      - SharePointOnlineAndOneDriveForBusiness
                      - ExchangeOnline
                      - MicrosoftTeams
                    vb365ServerUid: 75340270-4644-4855-986d-80e8c5d9775c
                    vb365ServerName: VB4
                    locationUid: 
                    locationName: 
                    isBackedUp: false
                    firstBackupTime: 
                    lastBackupTime: 
                    registeredBy: My Company
                    registrationDate: '2025-07-23T04:49:55.9837537+02:00'
                    isRemoving: false
                    isJobSchedulingEnabled: true
                    mappedOrganizationUid: 
                    mappedOrganizationName: 
                    _embedded:
                      organizationDetails: 
                      vb365Server: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/deviceCode':
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Create Device Code
      description: "Generates a device code to log in to a Microsoft organization.\n> You can get a device code from Microsoft Azure to sign in to the [Microsoft authentication portal](https://login.microsoftonline.com/common/oauth2/deviceauth).\n"
      operationId: CreateAzureDeviceCode
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: region
          in: query
          description: "Region where a Microsoft organization is located.\n> Available only for Microsoft 365 and hybrid organizations.\n"
          schema:
            enum:
              - Unknown
              - Default
              - Germany
              - China
              - USDefence
              - USGovernment
            type: string
            default: Default
            x-extensible-enum: true
            x-ms-enum:
              name: Vb365OrganizationRegion
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365DeviceCode'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  userCode: DAGUWTQ2T
                  verificationUrl: https://microsoft.com/devicelogin
                  expiresIn: 899
                  message: 'To sign in, use a web browser to open the page https://microsoft.com/devicelogin and enter the code DAGUVUQ2T to authenticate.'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/deviceCode/{code}/status':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get Device Code Status
      description: Returns a resource representation of a device code status.
      operationId: GetAzureDeviceCodeStatus
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: code
          in: path
          description: Device code.
          required: true
          schema:
            maxLength: 30
            minLength: 1
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365DeviceCodeStatus'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  authenticated: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get Microsoft Organization
      description: Returns a resource representation of a Microsoft organization with the specified UID.
      operationId: GetVb365Organization
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Vb365OrganizationBaseExpand'
          x-veeam-expand: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365OrganizationBase'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 477ba485-3dbb-4882-ba38-dd8c8d20c8d7
                  name: alpha.onmicrosoft.com
                  type: Microsoft365
                  region: Default
                  cloudAuthenticatedMethod: Modern
                  protectedServices:
                    - SharePointOnlineAndOneDriveForBusiness
                    - ExchangeOnline
                    - MicrosoftTeams
                  vb365ServerUid: 8f2e795e-3d5b-479b-88af-9ba2d114044a
                  vb365ServerName: VB3
                  locationUid: 
                  locationName: 
                  isBackedUp: false
                  firstBackupTime: 
                  lastBackupTime: 
                  registeredBy: My Company
                  registrationDate: '2025-07-23T04:49:55.9837537+02:00'
                  isRemoving: false
                  isJobSchedulingEnabled: true
                  mappedOrganizationUid: 
                  mappedOrganizationName: 
                  _embedded:
                    organizationDetails: 
                    vb365Server: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Delete Microsoft Organization
      description: Deletes a Microsoft organization with the specified UID.
      operationId: DeleteVb365Organization
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/Microsoft365':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Microsoft 365 Organizations Managed by Veeam Backup for Microsoft 365 Server
      description: Returns a collection resource representation of all Microsoft 365 organizations managed by a Veeam Backup for Microsoft 365 server with the spectified UID.
      operationId: GetVb365Microsoft365Organizations
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Vb365Microsoft365OrganizationExpand'
          x-veeam-expand: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365Microsoft365Organization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 00f96e81-b91b-4381-9eea-da4fd4397269
                    name: alpha.onmicrosoft.com
                    isTeamsOnline: true
                    isTeamsChatsOnline: false
                    exchangeAndSharePointOnlineConnectionSettings:
                      modernAppOnlyAuthenticationSettings:
                        configureApplication: 
                        userCode: 
                        newApplicationName: 
                        applicationId: 6fa2891d-939b-478e-b094-baebfed5eb72
                        applicationCertificate: 
                        applicationCertificatePassword: 
                        applicationCertificateThumbprint: 8F0B575280FBDE4B41C8AED0C5628AEE02BD310E
                        sharePointSettings:
                          sharePointSaveAllWebParts: false
                          officeOrganizationName: alpha.onmicrosoft.com
                        exchangeSettings:
                          officeOrganizationName: ''
                          account: account@alpha.onmicrosoft.com
                      modernAuthenticationWithLegacyProtocolsSettings: 
                      basicAuthenticationSettings: 
                    region: Default
                    _embedded:
                      organizationBase: 
                  - instanceUid: 7b19b771-168d-44a6-96a3-c6403b3402e2
                    name: beta.onmicrosoft.com
                    isTeamsOnline: true
                    isTeamsChatsOnline: false
                    exchangeAndSharePointOnlineConnectionSettings:
                      modernAppOnlyAuthenticationSettings:
                        configureApplication: 
                        userCode: 
                        newApplicationName: 
                        applicationId: a69c7e6c-9dd3-4c3d-bcc2-a31353dd81ed
                        applicationCertificate: 
                        applicationCertificatePassword: 
                        applicationCertificateThumbprint: 9A0B524280FCAD35A1C83ED9B6228ACE3EBD313C
                        sharePointSettings:
                          sharePointSaveAllWebParts: false
                          officeOrganizationName: beta.onmicrosoft.com
                        exchangeSettings:
                          officeOrganizationName: ''
                          account: account@beta.onmicrosoft.com
                      modernAuthenticationWithLegacyProtocolsSettings: 
                      basicAuthenticationSettings: 
                    region: Default
                    _embedded:
                      organizationBase: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Create Microsoft 365 Organization
      description: Creates a new Microsoft 365 organization on a Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: CreateVb365Microsoft365Organization
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: companyUid
          in: query
          description: "UID assigned to a company to which a Microsoft 365 organization must be mapped.\n> For reseller users who create a Microsoft 365 organization, the parameter is required.\n"
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Vb365Microsoft365Organization'
            example:
              isTeamsOnline: true
              isTeamsChatsOnline: false
              exchangeAndSharePointOnlineConnectionSettings:
                modernAppOnlyAuthenticationSettings:
                  configureApplication: false
                  userCode: 
                  newApplicationName: 
                  applicationId: ae61e533-82c7-4cb6-a030-78ae589cf49d
                  applicationCertificate: MIIEoQIBAAKCAQBJ4W/TVQeIynO0BL/f/lc65mUzZmput1JCZsMLcjQB9eAteBVl5NRN4O5jUrWqXwk1IX17qtDiu3L8O07e0HlL+nHkRYeUDaztVbyhtvKc+YwNwZTQP8IvnWBpgrd2uJw167I7iQ5nuN2O7QL/8idBiKhgsOKz9frPMSp/QIXA3MQoi+Yp8TiyDvGps+iMn1KpLgkHehlXUFmuZvi27T6wSZGh97rHekpIj9bSirZFcG+7qupx8HFE4wNdhvxcvbmNkfMaJTmmi3YzGKYESwNyvwAIuohq1MoeQmNf1Q50NO04GOOPY+66uykOQkDkTa8/Vu90O6cux6/Ntyt04hndAgMBAAECggEABtA/m+HPnBHvsb5uY531NX1h/+eGEUfe0jjf7AJQQY4HaqoUbx03ZydDVO2fy2KQWtIH3IvYT9CxvglKMMpRJWynbEHtSv4n4ItzpgZVQZzSCcK8kqgOpI2DArgHa2+DGIXwHgV5yp8F79Rz3l7at/R+csxdW/NnegwyuyGcNDkOjp8//HcrHQXPjljF5mwh4UZCFUvscKVjQbsOpiMvGeGN3z0/ZfKHi2egEA4+t1NLJykDiovNamtxE2xDkU8TXwn9STI8owzmxGtAA4HXDMuUQ0UXqxN0ED3WLJeqEKa0vuQ34+so5sa6EiwhF3q5rs0HFMklvUOxfnhgcpxgkQKBgQCMsiDpIh8BDKTxF20b8Az7NDtvm78vxfhF2rnCYIh9Q+3VKxbvoiNNTTJmlGT4Hi5App3l2GKIvRVZ9mE/vbtcWDk71/GgyiyuLixJYrY9gy2kYTz84R8v4ZMhjLB+Ba7VXkGU2u/Mj5LXzsQWCYRelC9DWlgcoReRXMHUbP4XwKBgQCGbYgE1gvW5ZYyi3xTrUIw8Bz7iUtbkO2Dg8egWLAYzRJizis6fd30xIG3wNheMVa/qqU3RrvS62N0QHZBjXJTH27li8JVQ9mfVbGZxcRLEwimBSEf5SNFlucwq02kvdJnL6vx5fE0XUziDPcgIUF9LO+VcCFKXE7kVNn1P/KHQwKBgDsxJc9vX4Pdgfc8V9cNIyj8TJUj/UdoDo+bnhSwsIbSLlwfyHRjrbY3zsqZ4JdIQWlQ+B/dJxWm5CzZ83f3/WTh3zNxlZTOID/Q/qL4Qf4DFe/4RyyyaAnUvMmcYpTcb6qrQSnJ4P0U18fyjdLQblYtpmrhK5mx7eMQq/QOwZAoGAU3ftTjtt7Ihv44CSuQ5KnEJrbJAKV5e8sr1/lYOcDDpBYVJsqwv+Zn4hoWw/rPTrzWTy40irVULNZSCljPx78TsCS8uk5faUSQgXl8ihoo/1/cgPklNfvFT/xkuHkXRAEcwa8r95Lq+EDpRIWg3sMQJW3S5brWV1ovdAwrRrLisCgYAk+F2L604Ss7zgEbBGJEQoD+OFVP29WSrKThtVLaabYP1N8qVr+W/P5ojRZ94aqZ0wBLfklfdejOp399llcoFoMShc1k+ScpYZb7k3cHhLGdZsm+gCNuVQZlpYWvhnSjOfEHafQRckxtPtvVTVda/uHtWNwoDv39eSXMS4WLprug==
                  applicationCertificatePassword: Password1
                  sharePointSettings:
                    sharePointSaveAllWebParts: false
                    officeOrganizationName: mycompany.onmicrosoft.com
                  exchangeSettings:
                    account: admin@mycompany.onmicrosoft.com
                modernAuthenticationWithLegacyProtocolsSettings: 
                basicAuthenticationSettings: 
              region: Default
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365Microsoft365Organization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  name: mycompany.onmicrosoft.com
                  isTeamsOnline: true
                  isTeamsChatsOnline: false
                  exchangeAndSharePointOnlineConnectionSettings:
                    modernAppOnlyAuthenticationSettings:
                      configureApplication: 
                      userCode: 
                      newApplicationName: 
                      applicationId: ae61e533-82c7-4cb6-a030-78ae589cf49d
                      applicationCertificate: 
                      applicationCertificatePassword: 
                      applicationCertificateThumbprint: A70565B307CD912867F2AF978A48381F4249BCEE
                      sharePointSettings:
                        sharePointSaveAllWebParts: false
                        officeOrganizationName: mycompany.onmicrosoft.com
                      exchangeSettings:
                        officeOrganizationName: ''
                        account: admin@mycompany.onmicrosoft.com
                    modernAuthenticationWithLegacyProtocolsSettings: 
                    basicAuthenticationSettings: 
                  region: Default
                  _embedded:
                    organizationBase: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/Microsoft365/{vb365OrganizationUid}':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get Microsoft 365 Organization
      description: Returns a resource representation of a Microsoft 365 organization with the specified UID.
      operationId: GetVb365Microsoft365Organization
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft 365 organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: expand
          in: query
          description: Includes a resource representation of the root entities in the embedded property of a response.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Vb365Microsoft365OrganizationExpand'
          x-veeam-expand: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365Microsoft365Organization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 00f96e81-b91b-4381-9eea-da4fd4397269
                  name: alpha.onmicrosoft.com
                  isTeamsOnline: true
                  isTeamsChatsOnline: false
                  exchangeAndSharePointOnlineConnectionSettings:
                    modernAppOnlyAuthenticationSettings:
                      configureApplication: 
                      userCode: 
                      newApplicationName: 
                      applicationId: 6fa2891d-939b-478e-b094-baebfed5eb72
                      applicationCertificate: 
                      applicationCertificatePassword: 
                      applicationCertificateThumbprint: 8F0B575280FBDE4B41C8AED0C5628AEE02BD310E
                      sharePointSettings:
                        sharePointSaveAllWebParts: false
                        officeOrganizationName: alpha.onmicrosoft.com
                      exchangeSettings:
                        officeOrganizationName: ''
                        account: account@alpha.onmicrosoft.com
                    modernAuthenticationWithLegacyProtocolsSettings: 
                    basicAuthenticationSettings: 
                  region: Default
                  _embedded:
                    organizationBase: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/Vb365Microsoft365Organization'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Modify Microsoft 365 Organization
      description: Modifies a Microsoft 365 organization with the specified UID.
      operationId: PatchVb365Microsoft365Organization
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft 365 organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: 'false'
                path: /isTeamsOnline
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365Microsoft365Organization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: d60543b8-9a53-473a-8e4c-cfdc374286cf
                  name: mycompany.onmicrosoft.com
                  isTeamsOnline: true
                  isTeamsChatsOnline: false
                  exchangeAndSharePointOnlineConnectionSettings:
                    modernAppOnlyAuthenticationSettings:
                      configureApplication: 
                      userCode: 
                      newApplicationName: 
                      applicationId: ae61e533-82c7-4cb6-a030-78ae589cf49d
                      applicationCertificate: 
                      applicationCertificatePassword: 
                      applicationCertificateThumbprint: A70565B307CD912867F2AF978A48381F4249BCEE
                      sharePointSettings:
                        sharePointSaveAllWebParts: false
                        officeOrganizationName: mycompany.onmicrosoft.com
                      exchangeSettings:
                        officeOrganizationName: ''
                        account: admin@mycompany.onmicrosoft.com
                    modernAuthenticationWithLegacyProtocolsSettings: 
                    basicAuthenticationSettings: 
                  region: Default
                  _embedded:
                    organizationBase: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/Vb365Microsoft365Organization'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/Microsoft365/{vb365OrganizationUid}/certificate/exist':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Check Microsoft 365 Organization Application Certificate
      description: "Checks whether a security certificate is available for a Microsoft 365 organization application with the specified UID.\n> If a Microsoft 365 organization was not created in Veeam Service Provider Console, its application certificate is not available.\n"
      operationId: CheckVb365Microsoft365OrganizationCertificateExistenceInTheStorage
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft 365 organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: applicationUid
          in: query
          description: Microsoft 365 organization application UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: "Returns the `true` value if the certificate is available and the `false` value if the certificate could not be found.\n"
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: boolean
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/groups':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Microsoft Organization Groups
      description: "Returns a collection resource representation of all groups in a Microsoft organization with the specified UID.\n> The `total` property of the `meta` response section always has the `0` value.\n"
      operationId: GetVb365OrganizationGroups
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: groupDisplayNameFilter
          in: query
          description: "Applies filtering by the `displayName' property.\n> Requires full match. You can use the `*` symbol before and after the search string.\n"
          schema:
            maxLength: 256
            type: string
            nullable: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365JobItemGroup'
                    readOnly: true
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:ae91cf40-75ef-4bab-8448-b820c5bba55f:00000000-0000-0000-0000-000000000000
                    onPremisesSid: 
                    groupType: Office365
                    locationType: Cloud
                    name: msteams_63439c@alpha.onmicrosoft.com
                    displayName: Team_47
                    managedBy: admin@alpha.onmicrosoft.com
                    site: https://alpha.sharepoint.com/sites/msteams_63439c
                  - id: alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:c2b180f2-57d4-4a8a-a7fb-ddceaacd0dd4:00000000-0000-0000-0000-000000000000
                    onPremisesSid: 
                    groupType: Office365
                    locationType: Cloud
                    name: org3@alpha.onmicrosoft.com
                    displayName: org3
                    managedBy: s.smith@alpha.onmicrosoft.com
                    site: https://alpha.sharepoint.com/sites/org3
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/sites':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Microsoft Organization Sites
      description: "Returns a collection resource representation of all sites of a Microsoft organization with the specified UID.\n> The `total` property of the `meta` response section always has the `0` value.\n"
      operationId: GetVb365OrganizationSites
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: multiFilter
          in: query
          description: "Applies filtering by the `title' or `url` property.\n> Requires full match. You can use the `*` symbol before and after the search string.          \n"
          schema:
            maxLength: 256
            type: string
            nullable: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365JobItemSite'
                    readOnly: true
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: 62063220-8cf8-420e-b23f-bb0d3967809eea3c612f-1037-4015-be8b-2d9c96e557d1
                    name: alpha-org
                    title: alpha-org
                    url: https://alpha.sharepoint.com/sites/org3
                    parentUrl: 
                    isCloud: true
                    isPersonal: false
                    isAvailable: true
                    siteCollectionError: 
                  - id: 0cff8a27-3962-4289-b10e-a2e5bea6faa44c93ac7c-5678-41b0-b18a-0854e691e687
                    name: modern2
                    title: modern2
                    url: https://alpha.sharepoint.com/sites/modern2
                    parentUrl: 
                    isCloud: true
                    isPersonal: false
                    isAvailable: true
                    siteCollectionError: 
                  - id: 29d8a656-8cd2-4729-be73-4d461c13085a7c71eac2-3bbc-423b-943b-2a9d6033d774
                    name: project
                    title: project
                    url: https://alpha.sharepoint.com/sites/project
                    parentUrl: 
                    isCloud: true
                    isPersonal: false
                    isAvailable: true
                    siteCollectionError: 
                  - id: 9d862fa9-2a86-41fe-aae9-9f9d67a4e7cafbbf6bd5-06b0-4d90-8f4e-3345a8ab7e56
                    name: Sigma Team Site
                    title: Sigma Team Site
                    url: https://alpha.sharepoint.com/sites/sigma
                    parentUrl: 
                    isCloud: true
                    isPersonal: false
                    isAvailable: true
                    siteCollectionError: 
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/teams':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Microsoft Organization Teams
      description: "Returns a collection resource representation of all teams of a Microsoft organization with the specified UID.\n> The `total` property of the `meta` response section always has the `0` value.\n"
      operationId: GetVb365OrganizationTeams
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: teamDisplayNameFilter
          in: query
          description: "Applies filtering by the `displayName' property.\n> Requires full match. You can use the `*` symbol before and after the search string.\n"
          schema:
            maxLength: 256
            type: string
            nullable: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365JobItemTeam'
                    readOnly: true
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: f68d1654-1d62-483c-b606-ed0a86f9c4b9
                    displayName: Team_AI 14
                    description: Team_AI 14
                    mail: msteams_538159@alpha.onmicrosoft.com
                  - id: 99c113e0-060f-4956-b250-81179a751d5c
                    displayName: Team_AI 4
                    description: Team_AI 4
                    mail: msteams_ff5b9a@alpha.onmicrosoft.com
                  - id: fa504052-76f5-4c91-8e43-b9bc0933630c
                    displayName: Team_AI 17
                    description: Team_AI 17
                    mail: msteams_409082@alpha.onmicrosoft.com
                  - id: 69d6c87d-c9d3-437f-8f01-ae33d7f87b36
                    displayName: GROUP#0
                    description: A site template used to create a Group.
                    mail: group0-ps@alpha.onmicrosoft.com
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/users':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Microsoft Organization Users
      description: "Returns a collection resource representation of all users of a Microsoft organization with the specified UID.\n> The `total` property of the `meta` response section always has the `0` value.\n"
      operationId: GetVb365OrganizationUsers
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: userDisplayNameFilter
          in: query
          description: "Applies filtering by the `displayName' property.\n> Requires full match. You can use the `*` symbol before and after the search string.\n"
          schema:
            maxLength: 256
            type: string
            nullable: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365JobItemUser'
                    readOnly: true
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:9ced0fca-7320-451f-bffc-c0eda2e1c46c:00000000-0000-0000-0000-000000000000
                    onPremisesSid: 
                    officeName: 23/2102
                    userType: User
                    locationType: Cloud
                    name: johanna.l@alpha.onmicrosoft.com
                    displayName: Johanna Lorenz
                  - id: alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:ab1449b4-1a78-49e3-97d1-23dbd0682e30:00000000-0000-0000-0000-000000000000
                    onPremisesSid: 
                    officeName: 
                    userType: User
                    locationType: Cloud
                    name: adele.v@alpha.onmicrosoft.com
                    displayName: Adele Vance
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /infrastructure/vb365Servers/organizations/jobs:
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Veeam Backup for Microsoft 365 Jobs
      description: Returns a collection resource representation of all Veeam Backup for Microsoft 365 jobs.
      operationId: GetVb365Jobs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: siteFilter
          in: query
          description: Specifies the list of Veeam Cloud Connect site UIDs that limits the resources to the ones associated with those sites.
          style: form
          schema:
            type: array
            items:
              type: string
              format: uuid
            nullable: true
          x-veeam-pagination-global-site-filer: true
        - name: organizationFilter
          in: query
          description: Specifies the list of organization UIDs that limits the resources to the ones associated with those organizations.
          schema:
            type: string
            format: uuid
            nullable: true
          x-veeam-pagination-global-organization-filter: true
        - name: locationFilter
          in: query
          description: Specifies the list of location UIDs that limits the resources to the ones associated with those locations.
          schema:
            type: string
            format: uuid
            nullable: true
          x-veeam-pagination-global-location-filter: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365Job'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7695b17d-8fa6-405f-ad1b-32e9bc527b37
                    name: BackupJob2
                    jobType: BackupJob
                    repositoryUid: d19737f6-b75b-4444-a119-59ff8b551c15
                    repositoryName: Default Backup Repository
                    vb365OrganizationUid: 78425f4f-8fa4-4d40-a628-9d4860f42655
                    vspcOrganizationUid: 26c242e5-bf80-4ccf-a38d-eea677b97bd3
                    vspcOrganizationName: My Company
                    scheduleEditingAvailable: true
                    vb365ServerUid: 75340270-4644-4855-986d-80e8c5d9775c
                    vb365ServerName: VB4
                    managementAgentUid: ed88dc97-c289-4925-8a44-69c279dbb485
                    lastRun: 
                    nextRun: 
                    isEnabled: false
                    isCopyJobAvailable: false
                    lastStatus: Stopped
                    lastStatusDetails: ''
                    siteName: 
                    locationName: Default location
                    lastErrorLogRecords: [ ]
                  - instanceUid: 48378652-25f9-49b8-a8fa-a90ad8fa3233
                    name: Backup4CopyJob
                    jobType: BackupJob
                    repositoryUid: 69f09b60-93f0-43fb-b4c6-9538f6f098e8
                    repositoryName: bRepo
                    vb365OrganizationUid: 78425f4f-8fa4-4d40-a628-9d4860f42655
                    vspcOrganizationUid: 26c242e5-bf80-4ccf-a38d-eea677b97bd3
                    vspcOrganizationName: My Company
                    scheduleEditingAvailable: true
                    vb365ServerUid: 75340270-4644-4855-986d-80e8c5d9775c
                    vb365ServerName: VB4
                    managementAgentUid: ed88dc97-c289-4925-8a44-69c279dbb485
                    lastRun: 
                    nextRun: 
                    isEnabled: false
                    isCopyJobAvailable: true
                    lastStatus: Stopped
                    lastStatusDetails: ''
                    siteName: 
                    locationName: Default location
                    lastErrorLogRecords: [ ]
                  - instanceUid: dd263e27-15d0-4d2e-a92b-7b48559bd325
                    name: BackupJob3
                    jobType: BackupJob
                    repositoryUid: 7d1fd4c1-ff95-4e9c-8641-910a259f2797
                    repositoryName: Default Backup Repository
                    vb365OrganizationUid: 477ba485-3dbb-4882-ba38-dd8c8d20c8d7
                    vspcOrganizationUid: 26c242e5-bf80-4ccf-a38d-eea677b97bd3
                    vspcOrganizationName: My Company
                    scheduleEditingAvailable: true
                    vb365ServerUid: 8f2e795e-3d5b-479b-88af-9ba2d114044a
                    vb365ServerName: VB3
                    managementAgentUid: b2392721-e921-421e-abc4-f75a25d18bf9
                    lastRun: 
                    nextRun: 
                    isEnabled: false
                    isCopyJobAvailable: false
                    lastStatus: Stopped
                    lastStatusDetails: ''
                    siteName: 
                    locationName: Default location
                    lastErrorLogRecords: [ ]
                  - instanceUid: c4f76eb8-1d27-4e48-ae68-bbf8bc9e7b00
                    name: Backup4CopyJob2
                    jobType: BackupJob
                    repositoryUid: 4d1a1a61-c790-43b6-8d8f-c7edf4e80de3
                    repositoryName: bRepo
                    vb365OrganizationUid: 477ba485-3dbb-4882-ba38-dd8c8d20c8d7
                    vspcOrganizationUid: 26c242e5-bf80-4ccf-a38d-eea677b97bd3
                    vspcOrganizationName: My Company
                    scheduleEditingAvailable: true
                    vb365ServerUid: 8f2e795e-3d5b-479b-88af-9ba2d114044a
                    vb365ServerName: VB3
                    managementAgentUid: b2392721-e921-421e-abc4-f75a25d18bf9
                    lastRun: 
                    nextRun: 
                    isEnabled: false
                    isCopyJobAvailable: false
                    lastStatus: Stopped
                    lastStatusDetails: ''
                    siteName: 
                    locationName: Default location
                    lastErrorLogRecords: [ ]
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}':
    delete:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Delete Veeam Backup for Microsoft 365 Job
      description: Deletes a Veeam Backup for Microsoft 365 job with the specified UID.
      operationId: DeleteVb365Job
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365JobUid
          in: path
          description: Veeam Backup for Microsoft 365 job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}/start':
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Start Veeam Backup for Microsoft 365 Job
      description: Starts a Veeam Backup for Microsoft 365 job with the specified UID.
      operationId: StartVb365Job
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365JobUid
          in: path
          description: Veeam Backup for Microsoft 365 job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}/stop':
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Stop Veeam Backup for Microsoft 365 Job
      description: Stops a Veeam Backup for Microsoft 365 job with the specified UID.
      operationId: StopVb365Job
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365JobUid
          in: path
          description: Veeam Backup for Microsoft 365 job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}/disable':
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Disable Veeam Backup for Microsoft 365 Job
      description: Disables a Veeam Backup for Microsoft 365 job with the specified UID.
      operationId: DisableVb365Job
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365JobUid
          in: path
          description: Veeam Backup for Microsoft 365 job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/{vb365JobUid}/enable':
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Enable Veeam Backup for Microsoft 365 Job
      description: Enables a Veeam Backup for Microsoft 365 job with the specified UID.
      operationId: EnableVb365Job
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365JobUid
          in: path
          description: Veeam Backup for Microsoft 365 job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/vb365Servers/organizations/jobs/backup:
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Veeam Backup for Microsoft 365 Backup Copy Jobs
      description: Returns a collection resource representation of all Veeam Backup for Microsoft 365 backup jobs.
      operationId: GetVb365BackupJobs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365BackupJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 7695b17d-8fa6-405f-ad1b-32e9bc527b37
                    name: BackupJob2
                    description: Description of job
                    repositoryUid: d19737f6-b75b-4444-a119-59ff8b551c15
                    repositoryName: Default Backup Repository
                    vb365OrganizationUid: 78425f4f-8fa4-4d40-a628-9d4860f42655
                    vspcOrganizationUid: 26c242e5-bf80-4ccf-a38d-eea677b97bd3
                    vspcOrganizationName: My Company
                    vb365ServerUid: 75340270-4644-4855-986d-80e8c5d9775c
                    vb365ServerName: VB4
                    lastRun: 
                    nextRun: 
                    isEnabled: false
                    isCopyJobAvailable: false
                    backupType: SelectedItems
                    lastStatus: Stopped
                    lastStatusDetails: ''
                    lastErrorLogRecords: [ ]
                    selectedItems:
                      - id: c37da450-6c4b-48c4-87e2-cc557ef5d89778425f4f-8fa4-4d40-a628-9d4860f42655
                        itemType: PartialOrganization
                        folders: [ ]
                        backupMailbox: true
                        backupOneDrive: true
                        backupArchiveMailbox: true
                        backupPersonalSite: false
                        backupSites: true
                        backupTeams: true
                        backupTeamsChats: false
                        backupMembers: false
                        backupMemberMailbox: false
                        backupMemberArchiveMailbox: false
                        backupMemberOneDrive: false
                        backupMemberSite: false
                        backupGroupSite: false
                        site: 
                        team: 
                        user: 
                        group: 
                      - id: 9a01bcb3-d2de-4271-96bb-95611ddc70b3
                        itemType: PersonalSites
                        folders: [ ]
                        backupMailbox: false
                        backupOneDrive: false
                        backupArchiveMailbox: false
                        backupPersonalSite: false
                        backupSites: false
                        backupTeams: false
                        backupTeamsChats: false
                        backupMembers: false
                        backupMemberMailbox: false
                        backupMemberArchiveMailbox: false
                        backupMemberOneDrive: false
                        backupMemberSite: false
                        backupGroupSite: false
                        site: 
                        team: 
                        user: 
                        group: 
                      - id: 2b38d851-8098-4614-b369-ebce33f9b2c7alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:7d7d5e48-15cd-4f1f-99ee-546c80d1630b:00000000-0000-0000-0000-000000000000
                        itemType: User
                        folders: [ ]
                        backupMailbox: true
                        backupOneDrive: true
                        backupArchiveMailbox: true
                        backupPersonalSite: true
                        backupSites: false
                        backupTeams: false
                        backupTeamsChats: false
                        backupMembers: false
                        backupMemberMailbox: false
                        backupMemberArchiveMailbox: false
                        backupMemberOneDrive: false
                        backupMemberSite: false
                        backupGroupSite: false
                        site: 
                        team: 
                        user:
                          id: alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:7d7d5e48-15cd-4f1f-99ee-546c80d1630b:00000000-0000-0000-0000-000000000000
                          onPremisesSid: 
                          officeName: 
                          userType: User
                          locationType: Cloud
                          name: j.smith@alpha.onmicrosoft.com
                          displayName: John Smith
                        group: 
                      - id: 7b930c101c0e874a81d516e6124d208ccb41d446b2d8ffb2cedad170b8217fb829da1c0c2cc2e98b94058d423fac750eade38411352d7e6c441227e24b0764ea
                        itemType: Site
                        folders: [ ]
                        backupMailbox: false
                        backupOneDrive: false
                        backupArchiveMailbox: false
                        backupPersonalSite: false
                        backupSites: false
                        backupTeams: false
                        backupTeamsChats: false
                        backupMembers: false
                        backupMemberMailbox: false
                        backupMemberArchiveMailbox: false
                        backupMemberOneDrive: false
                        backupMemberSite: false
                        backupGroupSite: false
                        site:
                          id: 3840dd3b-584e-4c21-bf76-6814183415bcfe23af84-7f8b-4702-9ac4-684fe8c3d5af
                          name: Alpha Site
                          title: Alpha Site
                          url: https://alpha.sharepoint.com/sites/alphasite
                          parentUrl: 
                          isCloud: true
                          isPersonal: false
                          isAvailable: false
                          siteCollectionError: 
                        team: 
                        user: 
                        group: 
                    excludedItems: [ ]
                    schedulePolicy:
                      schedulePolicyType: ManualOnly
                      periodicallyEvery: 
                      dailyType: 
                      scheduleEnabled: false
                      backupWindowEnabled: false
                      backupWindowSettings:
                        backupWindow:
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                        minuteOffset: 
                      periodicallyWindowSettings:
                        backupWindow:
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                        minuteOffset: 
                      periodicallyWindowEnabled: false
                      periodicallyOffsetMinutes: 
                      dailyTime: 
                      retryEnabled: true
                      retryNumber: 2
                      retryWaitInterval: 100
                  - instanceUid: 4521f91e-9c41-49f3-af05-ad77733a3aaf
                    name: BackupJob2
                    description: ''
                    repositoryUid: d19737f6-b75b-4444-a119-59ff8b551c15
                    repositoryName: Default Backup Repository
                    vb365OrganizationUid: 78425f4f-8fa4-4d40-a628-9d4860f42655
                    vspcOrganizationUid: 26c242e5-bf80-4ccf-a38d-eea677b97bd3
                    vspcOrganizationName: My Company
                    vb365ServerUid: 75340270-4644-4855-986d-80e8c5d9775c
                    vb365ServerName: VB4
                    lastRun: 
                    nextRun: 
                    isEnabled: false
                    isCopyJobAvailable: false
                    backupType: SelectedItems
                    lastStatus: Stopped
                    lastStatusDetails: ''
                    lastErrorLogRecords: [ ]
                    selectedItems:
                      - id: c37da560-6c4b-48c4-87e2-cc557ef5d89778425f4f-8fa4-4d40-a628-9d4860f42655
                        itemType: PartialOrganization
                        folders: [ ]
                        backupMailbox: true
                        backupOneDrive: true
                        backupArchiveMailbox: true
                        backupPersonalSite: false
                        backupSites: true
                        backupTeams: true
                        backupTeamsChats: false
                        backupMembers: false
                        backupMemberMailbox: false
                        backupMemberArchiveMailbox: false
                        backupMemberOneDrive: false
                        backupMemberSite: false
                        backupGroupSite: false
                        site: 
                        team: 
                        user: 
                        group: 
                      - id: 9a12bcb3-d2de-4271-96bb-95611ddc70b3
                        itemType: PersonalSites
                        folders: [ ]
                        backupMailbox: false
                        backupOneDrive: false
                        backupArchiveMailbox: false
                        backupPersonalSite: false
                        backupSites: false
                        backupTeams: false
                        backupTeamsChats: false
                        backupMembers: false
                        backupMemberMailbox: false
                        backupMemberArchiveMailbox: false
                        backupMemberOneDrive: false
                        backupMemberSite: false
                        backupGroupSite: false
                        site: 
                        team: 
                        user: 
                        group: 
                      - id: 2b38d840-8009-4614-b369-ebce33f9b2c7alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:8e7d5e48-15cd-4f1f-99ee-546c80d1630b:00000000-0000-0000-0000-000000000000
                        itemType: User
                        folders: [ ]
                        backupMailbox: true
                        backupOneDrive: true
                        backupArchiveMailbox: true
                        backupPersonalSite: true
                        backupSites: false
                        backupTeams: false
                        backupTeamsChats: false
                        backupMembers: false
                        backupMemberMailbox: false
                        backupMemberArchiveMailbox: false
                        backupMemberOneDrive: false
                        backupMemberSite: false
                        backupGroupSite: false
                        site: 
                        team: 
                        user:
                          id: alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:8e7d5e48-15cd-4f1f-99ee-546c80d1630b:00000000-0000-0000-0000-000000000000
                          onPremisesSid: 
                          officeName: 
                          userType: User
                          locationType: Cloud
                          name: admin8
                          displayName: admin8
                        group: 
                    excludedItems: [ ]
                    schedulePolicy:
                      schedulePolicyType: ManualOnly
                      periodicallyEvery: 
                      dailyType: 
                      scheduleEnabled: false
                      backupWindowEnabled: false
                      backupWindowSettings:
                        backupWindow:
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                        minuteOffset: 
                      periodicallyWindowSettings:
                        backupWindow:
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                        minuteOffset: 
                      periodicallyWindowEnabled: false
                      periodicallyOffsetMinutes: 
                      dailyTime: 
                      retryEnabled: false
                      retryNumber: 
                      retryWaitInterval: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/{vb365OrganizationUid}/jobs/backup':
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Create Veeam Backup for Microsoft 365 Backup Job
      description: "Creates a new Veeam Backup for Microsoft 365 backup job.\n> [For Veeam Backup for Microsoft 365 servers hosted by Veeam Service Provider Console] Company users must pass the `null` value for the `schedulePolicy` property. Otherwise the operation will result in error.  \n"
      operationId: CreateVb365BackupJob
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365OrganizationUid
          in: path
          description: Microsoft organization UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: startJobAfterCreation
          in: query
          description: Defines whether a backup job must automatically start after it is created.
          schema:
            type: boolean
            default: false
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Vb365BackupJob'
            example:
              name: BackupJob2
              description: Veeam Backup for Microsoft 365 backup job
              repositoryUid: 92421aa8-db1e-42ef-b210-b5d7750baffa
              isEnabled: false
              backupType: SelectedItems
              selectedItems:
                - itemType: User
                  folders: [ ]
                  backupMailbox: true
                  backupOneDrive: true
                  backupArchiveMailbox: true
                  backupPersonalSite: true
                  backupSites: false
                  backupTeams: false
                  backupTeamsChats: false
                  backupMembers: false
                  backupMemberMailbox: false
                  backupMemberArchiveMailbox: false
                  backupMemberOneDrive: false
                  backupMemberSite: false
                  backupGroupSite: false
                  site: 
                  team: 
                  user:
                    id: lrs.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:858bae82-7ff7-4ab5-be78-3c2da97c9c3d:00000000-0000-0000-0000-000000000000
                    onPremisesSid: 
                    userType: User
                    name: ktang@mycompany.onmicrosoft.com
                    displayName: Kate Tang
                  group: 
                - itemType: Team
                  folders: [ ]
                  backupMailbox: false
                  backupOneDrive: false
                  backupArchiveMailbox: false
                  backupPersonalSite: false
                  backupSites: false
                  backupTeams: false
                  backupTeamsChats: false
                  backupMembers: false
                  backupMemberMailbox: false
                  backupMemberArchiveMailbox: false
                  backupMemberOneDrive: false
                  backupMemberSite: false
                  backupGroupSite: false
                  site: 
                  team:
                    id: 97033983-9122-1907-94e2-46445967791a
                    displayName: Lrsvbm
                    description: Lrsvbm
                    mail: Lrsvbm@mycompany.onmicrosoft.com
                  user: 
                  group: 
                - itemType: Site
                  folders: [ ]
                  backupMailbox: false
                  backupOneDrive: false
                  backupArchiveMailbox: false
                  backupPersonalSite: false
                  backupSites: false
                  backupTeams: false
                  backupTeamsChats: false
                  backupMembers: false
                  backupMemberMailbox: false
                  backupMemberArchiveMailbox: false
                  backupMemberOneDrive: false
                  backupMemberSite: false
                  backupGroupSite: false
                  site:
                    id: c518d8b0-db04-6bb8-8c39-21b18ebe71345c38aa48-1b78-4411-a0a7-15a83d0e8d50
                    title: Team Site
                    url: https://mycompany.sharepoint.com/sites/contentTypeHub
                  team: 
                  user: 
                  group: 
              excludedItems: [ ]
              schedulePolicy:
                schedulePolicyType: ManualOnly
                periodicallyEvery: 
                dailyType: 
                scheduleEnabled: false
                backupWindowEnabled: false
                backupWindowSettings:
                  backupWindow:
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                  minuteOffset: 
                periodicallyWindowSettings:
                  backupWindow:
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                  minuteOffset: 
                periodicallyWindowEnabled: false
                periodicallyOffsetMinutes: 
                dailyTime: 
                retryEnabled: false
                retryNumber: 
                retryWaitInterval: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365BackupJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 806cdf82-3a1a-4da1-b3b4-3a774dd5a99c
                  name: BackupJob2
                  description: Veeam Backup for Microsoft 365 backup job
                  repositoryUid: 92421aa8-db1e-42ef-b210-b5d7750baffa
                  repositoryName: bRepoToOsr
                  vb365OrganizationUid: b9ac2998-56be-4fa3-9b61-723ba8c72ed9
                  vspcOrganizationUid: 91c131fc-0a8b-48eb-807e-4625addb7cca
                  vspcOrganizationName: My Company
                  vb365ServerUid: d7102e00-4517-4c04-9950-fd1d123b9f34
                  vb365ServerName: VB4
                  lastRun: 
                  nextRun: 
                  isEnabled: false
                  isCopyJobAvailable: true
                  backupType: SelectedItems
                  lastStatus: Stopped
                  lastStatusDetails: ''
                  lastErrorLogRecords: [ ]
                  selectedItems:
                    - itemType: User
                      folders: [ ]
                      backupMailbox: true
                      backupOneDrive: true
                      backupArchiveMailbox: true
                      backupPersonalSite: true
                      backupSites: false
                      backupTeams: false
                      backupTeamsChats: false
                      backupMembers: false
                      backupMemberMailbox: false
                      backupMemberArchiveMailbox: false
                      backupMemberOneDrive: false
                      backupMemberSite: false
                      backupGroupSite: false
                      site: 
                      team: 
                      user:
                        id: lrs.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:858bae82-7ff7-4ab5-be78-3c2da97c9c3d:00000000-0000-0000-0000-000000000000
                        onPremisesSid: 
                        userType: User
                        name: ktang@mycompany.onmicrosoft.com
                        displayName: Kate Tang
                      group: 
                    - itemType: Team
                      folders: [ ]
                      backupMailbox: false
                      backupOneDrive: false
                      backupArchiveMailbox: false
                      backupPersonalSite: false
                      backupSites: false
                      backupTeams: false
                      backupTeamsChats: false
                      backupMembers: false
                      backupMemberMailbox: false
                      backupMemberArchiveMailbox: false
                      backupMemberOneDrive: false
                      backupMemberSite: false
                      backupGroupSite: false
                      site: 
                      team:
                        id: 97033983-9122-1907-94e2-46445967791a
                        displayName: Lrsvbm
                        description: Lrsvbm
                        mail: Lrsvbm@mycompany.onmicrosoft.com
                      user: 
                      group: 
                    - itemType: Site
                      folders: [ ]
                      backupMailbox: false
                      backupOneDrive: false
                      backupArchiveMailbox: false
                      backupPersonalSite: false
                      backupSites: false
                      backupTeams: false
                      backupTeamsChats: false
                      backupMembers: false
                      backupMemberMailbox: false
                      backupMemberArchiveMailbox: false
                      backupMemberOneDrive: false
                      backupMemberSite: false
                      backupGroupSite: false
                      site:
                        id: c518d8b0-db04-6bb8-8c39-21b18ebe71345c38aa48-1b78-4411-a0a7-15a83d0e8d50
                        title: Team Site
                        url: https://mycompany.sharepoint.com/sites/contentTypeHub
                      team: 
                      user: 
                      group: 
                  excludedItems: [ ]
                  schedulePolicy:
                    schedulePolicyType: ManualOnly
                    periodicallyEvery: 
                    dailyType: 
                    scheduleEnabled: false
                    backupWindowEnabled: false
                    backupWindowSettings:
                      backupWindow:
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                      minuteOffset: 
                    periodicallyWindowSettings:
                      backupWindow:
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                      minuteOffset: 
                    periodicallyWindowEnabled: false
                    periodicallyOffsetMinutes: 
                    dailyTime: 
                    retryEnabled: false
                    retryNumber: 
                    retryWaitInterval: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/backup/{vb365BackupJobUid}':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get Veeam Backup for Microsoft 365 Backup Job
      description: Returns a resource representation of a Veeam Backup for Microsoft 365 backup job with the specified UID.
      operationId: GetVb365BackupJob
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365BackupJobUid
          in: path
          description: Veeam Backup for Microsoft 365 backup job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365BackupJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 4521f91e-9c41-49f3-af05-ad77733a3aaf
                  name: BackupJob2
                  description: ''
                  repositoryUid: d19737f6-b75b-4444-a119-59ff8b551c15
                  repositoryName: Default Backup Repository
                  vb365OrganizationUid: 78425f4f-8fa4-4d40-a628-9d4860f42655
                  vspcOrganizationUid: 26c242e5-bf80-4ccf-a38d-eea677b97bd3
                  vspcOrganizationName: My Company
                  vb365ServerUid: 75340270-4644-4855-986d-80e8c5d9775c
                  vb365ServerName: VB4
                  lastRun: 
                  nextRun: 
                  isEnabled: false
                  isCopyJobAvailable: false
                  backupType: SelectedItems
                  lastStatus: Stopped
                  lastStatusDetails: ''
                  lastErrorLogRecords: [ ]
                  selectedItems:
                    - id: c37da560-6c4b-48c4-87e2-cc557ef5d89778425f4f-8fa4-4d40-a628-9d4860f42655
                      itemType: PartialOrganization
                      folders: [ ]
                      backupMailbox: true
                      backupOneDrive: true
                      backupArchiveMailbox: true
                      backupPersonalSite: false
                      backupSites: true
                      backupTeams: true
                      backupTeamsChats: false
                      backupMembers: false
                      backupMemberMailbox: false
                      backupMemberArchiveMailbox: false
                      backupMemberOneDrive: false
                      backupMemberSite: false
                      backupGroupSite: false
                      site: 
                      team: 
                      user: 
                      group: 
                    - id: 9a12bcb3-d2de-4271-96bb-95611ddc70b3
                      itemType: PersonalSites
                      folders: [ ]
                      backupMailbox: false
                      backupOneDrive: false
                      backupArchiveMailbox: false
                      backupPersonalSite: false
                      backupSites: false
                      backupTeams: false
                      backupTeamsChats: false
                      backupMembers: false
                      backupMemberMailbox: false
                      backupMemberArchiveMailbox: false
                      backupMemberOneDrive: false
                      backupMemberSite: false
                      backupGroupSite: false
                      site: 
                      team: 
                      user: 
                      group: 
                    - id: 2b38d840-8009-4614-b369-ebce33f9b2c7alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:8e7d5e48-15cd-4f1f-99ee-546c80d1630b:00000000-0000-0000-0000-000000000000
                      itemType: User
                      folders: [ ]
                      backupMailbox: true
                      backupOneDrive: true
                      backupArchiveMailbox: true
                      backupPersonalSite: true
                      backupSites: false
                      backupTeams: false
                      backupTeamsChats: false
                      backupMembers: false
                      backupMemberMailbox: false
                      backupMemberArchiveMailbox: false
                      backupMemberOneDrive: false
                      backupMemberSite: false
                      backupGroupSite: false
                      site: 
                      team: 
                      user:
                        id: alpha.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:8e7d5e48-15cd-4f1f-99ee-546c80d1630b:00000000-0000-0000-0000-000000000000
                        onPremisesSid: 
                        officeName: 
                        userType: User
                        locationType: Cloud
                        name: admin8
                        displayName: admin8
                      group: 
                  excludedItems: [ ]
                  schedulePolicy:
                    schedulePolicyType: ManualOnly
                    periodicallyEvery: 
                    dailyType: 
                    scheduleEnabled: false
                    backupWindowEnabled: false
                    backupWindowSettings:
                      backupWindow:
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                      minuteOffset: 
                    periodicallyWindowSettings:
                      backupWindow:
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                      minuteOffset: 
                    periodicallyWindowEnabled: false
                    periodicallyOffsetMinutes: 
                    dailyTime: 
                    retryEnabled: false
                    retryNumber: 
                    retryWaitInterval: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/Vb365BackupJob'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Modify Veeam Backup for Microsoft 365 Backup Job
      description: "Modifies a Veeam Backup for Microsoft 365 backup job with the specified UID.\n> [For Veeam Backup for Microsoft 365 servers hosted by Veeam Service Provider Console] Company users must not modify the `schedulePolicy` property. Otherwise the operation will result in error.\n"
      operationId: PatchVb365BackupJob
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365BackupJobUid
          in: path
          description: Veeam Backup for Microsoft 365 backup job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - op: replace
                path: /schedulePolicy/retryEnabled
                value: false
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365BackupJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 806cdf82-3a1a-4da1-b3b4-3a774dd5a99c
                  name: BackupJob2
                  description: Veeam Backup for Microsoft 365 backup job
                  repositoryUid: 92421aa8-db1e-42ef-b210-b5d7750baffa
                  repositoryName: bRepoToOsr
                  vb365OrganizationUid: b9ac2998-56be-4fa3-9b61-723ba8c72ed9
                  vspcOrganizationUid: 91c131fc-0a8b-48eb-807e-4625addb7cca
                  vspcOrganizationName: My Company
                  vb365ServerUid: d7102e00-4517-4c04-9950-fd1d123b9f34
                  vb365ServerName: VB4
                  lastRun: 
                  nextRun: 
                  isEnabled: false
                  isCopyJobAvailable: true
                  backupType: SelectedItems
                  lastStatus: Stopped
                  lastStatusDetails: ''
                  lastErrorLogRecords: [ ]
                  selectedItems:
                    - itemType: User
                      folders: [ ]
                      backupMailbox: true
                      backupOneDrive: true
                      backupArchiveMailbox: true
                      backupPersonalSite: true
                      backupSites: false
                      backupTeams: false
                      backupTeamsChats: false
                      backupMembers: false
                      backupMemberMailbox: false
                      backupMemberArchiveMailbox: false
                      backupMemberOneDrive: false
                      backupMemberSite: false
                      backupGroupSite: false
                      site: 
                      team: 
                      user:
                        id: lrs.onmicrosoft.com:00000000-0000-0000-0000-000000000000:00000000-0000-0000-0000-000000000000:858bae82-7ff7-4ab5-be78-3c2da97c9c3d:00000000-0000-0000-0000-000000000000
                        onPremisesSid: 
                        userType: User
                        name: ktang@mycompany.onmicrosoft.com
                        displayName: Kate Tang
                      group: 
                    - itemType: Team
                      folders: [ ]
                      backupMailbox: false
                      backupOneDrive: false
                      backupArchiveMailbox: false
                      backupPersonalSite: false
                      backupSites: false
                      backupTeams: false
                      backupTeamsChats: false
                      backupMembers: false
                      backupMemberMailbox: false
                      backupMemberArchiveMailbox: false
                      backupMemberOneDrive: false
                      backupMemberSite: false
                      backupGroupSite: false
                      site: 
                      team:
                        id: 97033983-9122-1907-94e2-46445967791a
                        displayName: Lrsvbm
                        description: Lrsvbm
                        mail: Lrsvbm@mycompany.onmicrosoft.com
                      user: 
                      group: 
                    - itemType: Site
                      folders: [ ]
                      backupMailbox: false
                      backupOneDrive: false
                      backupArchiveMailbox: false
                      backupPersonalSite: false
                      backupSites: false
                      backupTeams: false
                      backupTeamsChats: false
                      backupMembers: false
                      backupMemberMailbox: false
                      backupMemberArchiveMailbox: false
                      backupMemberOneDrive: false
                      backupMemberSite: false
                      backupGroupSite: false
                      site:
                        id: c518d8b0-db04-6bb8-8c39-21b18ebe71345c38aa48-1b78-4411-a0a7-15a83d0e8d50
                        title: Team Site
                        url: https://mycompany.sharepoint.com/sites/contentTypeHub
                      team: 
                      user: 
                      group: 
                  excludedItems: [ ]
                  schedulePolicy:
                    schedulePolicyType: ManualOnly
                    periodicallyEvery: 
                    dailyType: 
                    scheduleEnabled: false
                    backupWindowEnabled: false
                    backupWindowSettings:
                      backupWindow:
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                      minuteOffset: 
                    periodicallyWindowSettings:
                      backupWindow:
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                      minuteOffset: 
                    periodicallyWindowEnabled: false
                    periodicallyOffsetMinutes: 
                    dailyTime: 
                    retryEnabled: false
                    retryNumber: 
                    retryWaitInterval: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/Vb365BackupJob'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  /infrastructure/vb365Servers/organizations/jobs/copy:
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Veeam Backup for Microsoft 365 Backup Copy Jobs
      description: Returns a collection resource representation of all Veeam Backup for Microsoft 365 backup copy jobs.
      operationId: GetVb365CopyJobs
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365CopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 898b13a3-4435-413d-8416-1445ffaca282
                    name: users - copy job
                    sourceBackupJobUid: d6f10ff6-647d-4e3f-be47-7171060fc3e6
                    repositoryUid: be270ad4-fa0a-4e70-b7f8-0b44ea6eebb1
                    repositoryName: arlimit
                    vb365OrganizationUid: 9864b18b-ba6c-4679-b924-35cac4818739
                    vspcOrganizationUid: e9729230-883d-4766-9676-6f917506f040
                    vspcOrganizationName: My Company
                    vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                    vb365ServerName: LRSVBO
                    lastRun: '2023-11-18T08:00:21.2059860+01:00'
                    nextRun: 
                    isEnabled: true
                    lastStatus: Success
                    lastStatusDetails: 'Transferred: 166.3 KB (1 item) at 25.3 KB/s (0 items/s)'
                    schedulePolicy:
                      schedulePolicyType: Immediate
                      periodicallyEvery: 
                      dailyType: 
                      backupWindowEnabled: false
                      backupWindowSettings:
                        backupWindow:
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                        minuteOffset: 
                      dailyTime: 
                  - instanceUid: a4af8914-e08f-4a94-b967-f0c06e79568c
                    name: group - copy job
                    sourceBackupJobUid: c03ca22e-70f1-4731-b91a-9926993fa9b5
                    repositoryUid: c1492aac-5a67-47bd-9c5b-5d238b056350
                    repositoryName: ob1
                    vb365OrganizationUid: 9864b18b-ba6c-4679-b924-35cac4818739
                    vspcOrganizationUid: e9729230-883d-4766-9676-6f917506f040
                    vspcOrganizationName: My Company
                    vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                    vb365ServerName: LRSVBO
                    lastRun: '2023-11-18T08:10:46.2716291+01:00'
                    nextRun: 
                    isEnabled: true
                    lastStatus: Success
                    lastStatusDetails: 'Transferred: 0 B (0 items) at 0 B/s (0 items/s)'
                    schedulePolicy:
                      schedulePolicyType: Immediate
                      periodicallyEvery: 
                      dailyType: 
                      backupWindowEnabled: false
                      backupWindowSettings:
                        backupWindow:
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                        minuteOffset: 
                      dailyTime: 
                  - instanceUid: c565661f-3f97-4c9c-9ea8-0839eaec3bb9
                    name: to repo - copy job
                    sourceBackupJobUid: cbc32fb5-3fbf-4df6-8c40-02ad78275a8f
                    repositoryUid: 686085db-0a20-46b9-8cb6-3cbdf1a2a86e
                    repositoryName: arlimit
                    vb365OrganizationUid: 44a2a2b1-c3b7-4268-9f1e-c7c7437e964f
                    vspcOrganizationUid: 04aac689-6676-47e4-8411-1c71129f514e
                    vspcOrganizationName: new
                    vb365ServerUid: 43bd6147-4201-43b3-b8cd-5e6e45af6023
                    vb365ServerName: LRSVBOTR
                    lastRun: '2023-11-18T08:00:07.6354094+01:00'
                    nextRun: '2023-11-19T08:00:00.0000000+01:00'
                    isEnabled: true
                    lastStatus: Success
                    lastStatusDetails: 'Transferred: 2.1 MB (0 items) at 292.8 KB/s (0 items/s)'
                    schedulePolicy:
                      schedulePolicyType: DailyAtTime
                      periodicallyEvery: 
                      dailyType: Everyday
                      backupWindowEnabled: false
                      backupWindowSettings:
                        backupWindow:
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                          - true
                        minuteOffset: 
                      dailyTime: '2025-09-09T07:00:00.0000000+02:00'
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/copy':
    post:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Create Veeam Backup for Microsoft 365 Backup Copy Job
      description: "Creates a new Veeam Backup for Microsoft 365 backup copy job.\n> You can save the job schedule only if that functionality is enabled for you in the Veeam Backup for Microsoft 365 resource configuration. Otherwise the operation will result in error.\n"
      operationId: CreateVb365CopyJob
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: startJobAfterCreation
          in: query
          description: Defines whether a job must automatically start after it is created.
          schema:
            type: boolean
            default: false
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Vb365CopyJob'
            example:
              sourceBackupJobUid: 666435cf-38fe-462d-9767-f610d5654d35
              repositoryUid: 686085db-0a20-46b9-8cb6-3cbdf1a2a86f
              schedulePolicy:
                schedulePolicyType: Periodically
                periodicallyEvery: Hours4
                dailyType: Everyday
                backupWindowEnabled: false
                backupWindowSettings:
                  backupWindow:
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                    - true
                  minuteOffset: 0
                dailyTime: '2025-09-09T07:00:00.0000000+02:00'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365CopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 733ccd0c-f40e-4348-96de-ed9a120c2669
                  name: VBM365 Job Copy
                  sourceBackupJobUid: 666435cf-38fe-462d-9767-f610d5654d35
                  repositoryUid: 686085db-0a20-46b9-8cb6-3cbdf1a2a86f
                  repositoryName: oblimit
                  vb365OrganizationUid: 44a2a2b1-c3b7-4268-9f1e-c7c7437e964a
                  vspcOrganizationUid: 04aac689-6676-47e4-8411-1c71129f514f
                  vspcOrganizationName: new
                  vb365ServerUid: 43bd6147-4201-43b3-b8cd-5e6e45af6024
                  vb365ServerName: LRSVBOTR
                  lastRun: 
                  nextRun: 
                  isEnabled: true
                  lastStatus: Stopped
                  lastStatusDetails: ''
                  schedulePolicy:
                    schedulePolicyType: Periodically
                    periodicallyEvery: Hours4
                    dailyType: 
                    backupWindowEnabled: false
                    backupWindowSettings:
                      backupWindow:
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                      minuteOffset: 
                    dailyTime: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/copy/{vb365CopyJobUid}':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get Veeam Backup for Microsoft 365 Backup Copy Job
      description: Returns a resource representation of a Veeam Backup for Microsoft 365 backup copy job with the specified UID.
      operationId: GetVb365CopyJob
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365CopyJobUid
          in: path
          description: Veeam Backup for Microsoft 365 backup copy job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365CopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: c565661f-3f97-4c9c-9ea8-0839eaec3bb9
                  name: to repo - copy job
                  sourceBackupJobUid: cbc32fb5-3fbf-4df6-8c40-02ad78275a8f
                  repositoryUid: 686085db-0a20-46b9-8cb6-3cbdf1a2a86e
                  repositoryName: arlimit
                  vb365OrganizationUid: 44a2a2b1-c3b7-4268-9f1e-c7c7437e964f
                  vspcOrganizationUid: 04aac689-6676-47e4-8411-1c71129f514e
                  vspcOrganizationName: new
                  vb365ServerUid: 43bd6147-4201-43b3-b8cd-5e6e45af6023
                  vb365ServerName: LRSVBOTR
                  lastRun: '2023-11-18T08:00:07.6354094+01:00'
                  nextRun: '2023-11-19T08:00:00.0000000+01:00'
                  isEnabled: true
                  lastStatus: Success
                  lastStatusDetails: 'Transferred: 2.1 MB (0 items) at 292.8 KB/s (0 items/s)'
                  schedulePolicy:
                    schedulePolicyType: DailyAtTime
                    periodicallyEvery: 
                    dailyType: Everyday
                    backupWindowEnabled: false
                    backupWindowSettings:
                      backupWindow:
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                      minuteOffset: 
                    dailyTime: '2025-09-09T07:00:00.0000000+02:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/Vb365CopyJob'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    patch:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Modify Veeam Backup for Microsoft 365 Backup Copy Job
      description: "Modifies a Veeam Backup for Microsoft 365 backup copy job with the specified UID.\n> You can save the job schedule only if that functionality is enabled for you in the Veeam Backup for Microsoft 365 resource configuration. Otherwise the operation will result in error.\n"
      operationId: PatchVb365CopyJob
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365CopyJobUid
          in: path
          description: Veeam Backup for Microsoft 365 backup copy job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - op: replace
                path: /schedulePolicy/dailyTime
                value: '2025-09-09T07:00:00.0000000+02:00'
              - op: replace
                path: /schedulePolicy/dailyType
                value: Friday
              - op: replace
                path: /schedulePolicy/schedulePolicyType
                value: DailyAtTime
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Vb365CopyJob'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 733ccd0c-f40e-4348-96de-ed9a120c2667
                  name: Copy job 2
                  sourceBackupJobUid: 666435cf-38fe-462d-9767-f610d5654d34
                  repositoryUid: 92421aa8-db1e-42ef-b210-b5d7750baffa
                  repositoryName: oblimit
                  vb365OrganizationUid: 44a2a2b1-c3b7-4268-9f1e-c7c7437e964f
                  vspcOrganizationUid: 04aac689-6676-47e4-8411-1c71129f514e
                  vspcOrganizationName: new
                  vb365ServerUid: 43bd6147-4201-43b3-b8cd-5e6e45af6023
                  vb365ServerName: LRSVBOTR
                  lastRun: 
                  nextRun: 
                  isEnabled: true
                  lastStatus: Stopped
                  lastStatusDetails: ''
                  schedulePolicy:
                    schedulePolicyType: DailyAtTime
                    periodicallyEvery: 
                    dailyType: Friday
                    backupWindowEnabled: false
                    backupWindowSettings:
                      backupWindow:
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                        - true
                      minuteOffset: 
                    dailyTime: '2025-09-09T07:00:00.0000000+02:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/Vb365CopyJob'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/backupRepositories':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Backup Repositories Connected to Veeam Backup for Microsoft 365 Server
      description: Returns a collection resource representation of all backup repositories connected to a Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: GetVb365BackupRepositories
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365BackupRepository'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 68aa677b-3d8f-4c31-85b7-2d9a6301d904
                    name: Default Backup Repository
                    description: Created by Veeam Backup for Microsoft 365
                    proxyUid: 14ec6e2f-f957-45ad-a632-890879dd970a
                    proxyPoolUid: 
                    path: C:\VeeamRepository
                    isArchiveRepository: false
                    isAvailableForBackupJob: true
                    isAvailableForCopyJob: false
                    isObjectStorageRepository: false
                    objectStorageRepositoryUid: 
                    objectStorageRepositoryCachePath: 
                    objectStorageRepositoryEncryptionEnabled: 
                    encryptionKeyId: 
                    isOutOfSync: false
                    capacityBytes: 85372956672
                    freeSpaceBytes: 27886977024
                    usedSpaceBytes: 31719424
                    dailyRetentionPeriod: 
                    monthlyRetentionPeriod: 
                    dailyTime: '2025-09-09T01:00:00.0000000+02:00'
                    monthlyTime: 
                    retentionType: SnapshotBased
                    retentionPeriodType: Yearly
                    yearlyRetentionPeriod: Years3
                    retentionFrequencyType: Daily
                    dailyType: Everyday
                    monthlyDayNumber: 
                    monthlyDayOfWeek: 
                  - instanceUid: 937c7b9b-bf91-4a09-b6b7-851756216006
                    name: bRepoToOsr
                    description: Created by powershell script CreateBackupRepositoryToOSR.ps1
                    proxyUid: 14ec6e2f-f957-45ad-a632-890879dd970a
                    proxyPoolUid: 
                    path: 
                    isArchiveRepository: false
                    isAvailableForBackupJob: true
                    isAvailableForCopyJob: true
                    isObjectStorageRepository: true
                    objectStorageRepositoryUid: 0e2fe5b7-a42f-470b-ba8d-3d11665769a3
                    objectStorageRepositoryCachePath: C:\localCacheBackup
                    objectStorageRepositoryEncryptionEnabled: false
                    encryptionKeyId: 
                    isOutOfSync: false
                    capacityBytes: 
                    freeSpaceBytes: 
                    usedSpaceBytes: 0
                    dailyRetentionPeriod: 
                    monthlyRetentionPeriod: 
                    dailyTime: '2025-09-09T22:00:00.0000000+02:00'
                    monthlyTime: 
                    retentionType: SnapshotBased
                    retentionPeriodType: Yearly
                    yearlyRetentionPeriod: Years3
                    retentionFrequencyType: Daily
                    dailyType: Everyday
                    monthlyDayNumber: 
                    monthlyDayOfWeek: 
                  - instanceUid: c9eddd9f-0d61-4ffa-8596-50a4789bdc52
                    name: bCopyRepoToOsr
                    description: Created by powershell script CreateBackupRepositoryToOSR.ps1
                    proxyUid: 14ec6e2f-f957-45ad-a632-890879dd970a
                    proxyPoolUid: 
                    path: 
                    isArchiveRepository: false
                    isAvailableForBackupJob: true
                    isAvailableForCopyJob: true
                    isObjectStorageRepository: true
                    objectStorageRepositoryUid: 51aa66a7-214a-498c-9e39-c29f337bee0a
                    objectStorageRepositoryCachePath: C:\localCacheCopy
                    objectStorageRepositoryEncryptionEnabled: false
                    encryptionKeyId: 
                    isOutOfSync: false
                    capacityBytes: 
                    freeSpaceBytes: 
                    usedSpaceBytes: 0
                    dailyRetentionPeriod: 
                    monthlyRetentionPeriod: 
                    dailyTime: '2025-09-09T22:00:00.0000000+02:00'
                    monthlyTime: 
                    retentionType: SnapshotBased
                    retentionPeriodType: Yearly
                    yearlyRetentionPeriod: Years3
                    retentionFrequencyType: Daily
                    dailyType: Everyday
                    monthlyDayNumber: 
                    monthlyDayOfWeek: 
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/organizations/jobs/backup/{vb365BackupJobUid}/availableBackupRepositories':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get Available Backup Repositories for Veeam Backup for Microsoft 365 Backup Job
      description: Returns a collection resource representation of backup repositories that can be selected as target repositories of a Veeam Backup for Microsoft 365 backup job with the specified UID.
      operationId: GetVb365BackupJobAvailableBackupRepositories
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365BackupJobUid
          in: path
          description: Veeam Backup for Microsoft 365 backup job UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365BackupRepository'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 68aa677b-3d8f-4c31-85b7-2d9a6301d904
                    name: Default Backup Repository
                    description: Created by Veeam Backup for Microsoft 365
                    proxyUid: 14ec6e2f-f957-45ad-a632-890879dd970a
                    proxyPoolUid: 
                    path: C:\VeeamRepository
                    isArchiveRepository: false
                    isAvailableForBackupJob: true
                    isAvailableForCopyJob: false
                    isObjectStorageRepository: false
                    objectStorageRepositoryUid: 
                    objectStorageRepositoryCachePath: 
                    objectStorageRepositoryEncryptionEnabled: 
                    encryptionKeyId: 
                    isOutOfSync: false
                    capacityBytes: 85372956672
                    freeSpaceBytes: 27886977024
                    usedSpaceBytes: 31719424
                    dailyRetentionPeriod: 
                    monthlyRetentionPeriod: 
                    dailyTime: '2025-09-09T01:00:00.0000000+02:00'
                    monthlyTime: 
                    retentionType: SnapshotBased
                    retentionPeriodType: Yearly
                    yearlyRetentionPeriod: Years3
                    retentionFrequencyType: Daily
                    dailyType: Everyday
                    monthlyDayNumber: 
                    monthlyDayOfWeek: 
                  - instanceUid: 937c7b9b-bf91-4a09-b6b7-851756216006
                    name: bRepoToOsr
                    description: Created by powershell script CreateBackupRepositoryToOSR.ps1
                    proxyUid: 14ec6e2f-f957-45ad-a632-890879dd970a
                    proxyPoolUid: 
                    path: 
                    isArchiveRepository: false
                    isAvailableForBackupJob: true
                    isAvailableForCopyJob: true
                    isObjectStorageRepository: true
                    objectStorageRepositoryUid: 0e2fe5b7-a42f-470b-ba8d-3d11665769a3
                    objectStorageRepositoryCachePath: C:\localCacheBackup
                    objectStorageRepositoryEncryptionEnabled: false
                    encryptionKeyId: 
                    isOutOfSync: false
                    capacityBytes: 
                    freeSpaceBytes: 
                    usedSpaceBytes: 0
                    dailyRetentionPeriod: 
                    monthlyRetentionPeriod: 
                    dailyTime: '2025-09-09T22:00:00.0000000+02:00'
                    monthlyTime: 
                    retentionType: SnapshotBased
                    retentionPeriodType: Yearly
                    yearlyRetentionPeriod: Years3
                    retentionFrequencyType: Daily
                    dailyType: Everyday
                    monthlyDayNumber: 
                    monthlyDayOfWeek: 
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/backupProxies':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Backup Proxies Connected to Veeam Backup for Microsoft 365 Server
      description: Returns a collection resource representation of all backup proxies connected to a Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: GetVb365BackupProxies
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365BackupProxy'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 6604f67d-1871-4474-867e-9a8d1547231a
                    proxyType: Local
                    status: Online
                    hostName: LRSVBOTR
                    description: Default backup proxy
                    port: 9193
                  - instanceUid: 3aa7bce7-dd6b-4b98-bdc9-f353de83f77f
                    proxyType: Local
                    status: Online
                    hostName: VB1
                    description: Additional backup proxy
                    port: 9193
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/infrastructure/vb365Servers/{vb365ServerUid}/backupProxyPools':
    get:
      tags:
        - Veeam Backup for Microsoft 365 Server
      summary: Get All Backup Proxy Pools Connected to Veeam Backup for Microsoft 365 Server
      description: Returns a collection resource representation of all backup proxy pools connected to a Veeam Backup for Microsoft 365 server with the specified UID.
      operationId: GetVb365BackupProxyPools
      parameters:
        - name: vb365ServerUid
          in: path
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365BackupProxyPool'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: f6972ef4-530b-4dbd-bbde-4881f0d26431
                    name: VB2_proxyPool
                    description: Alpha Backup Proxy Pool
                  - instanceUid: e53450ee-87d4-47af-918a-20d2cd15a499
                    name: VB5_proxyPool
                    description: Beta Backup Proxy Pool
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /protectedWorkloads/vb365ProtectedObjects:
    get:
      tags:
        - Protected Workloads
      summary: Get All Objects Protected by Veeam Backup for Microsoft 365
      description: Returns a collection resource representation of all objects protected by Veeam Backup for Microsoft 365.
      operationId: GetVb365ProtectedObjects
      parameters:
        - name: orderBy
          in: query
          description: "Name of the property by which the resources must be sorted.\n> Cannot be applied to the following properties `organizationUid`, `organizationName`, `siteUid`, `siteName`, `locationUid`, `locationName`.\n"
          schema:
            maxLength: 30
            minLength: 1
            type: string
            nullable: true
        - name: orderDirection
          in: query
          description: Type of the sort direction.
          schema:
            enum:
              - ascending
              - descending
            type: string
            default: ascending
            x-ms-enum:
              name: SortDirection
        - name: objectNameFilter
          in: query
          description: Substring to filter resources by the `name` property value.
          schema:
            maxLength: 512
            type: string
            nullable: true
        - name: objectTypeFilter
          in: query
          description: Type of protected objects to filter the resources by the `protectedDataType` property value.
          style: form
          schema:
            type: array
            items:
              $ref: '#/components/schemas/Vb365ProtectedObjectType'
            nullable: true
        - name: skipCache
          in: query
          description: Defines whether cache usage is disabled for the operation.
          schema:
            type: boolean
            nullable: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: siteFilter
          in: query
          description: Specifies the list of Veeam Cloud Connect site UIDs that limits the resources to the ones associated with those sites.
          style: form
          schema:
            type: array
            items:
              type: string
              format: uuid
            nullable: true
          x-veeam-pagination-global-site-filer: true
        - name: organizationFilter
          in: query
          description: Specifies the list of organization UIDs that limits the resources to the ones associated with those organizations.
          schema:
            type: string
            format: uuid
            nullable: true
          x-veeam-pagination-global-organization-filter: true
        - name: locationFilter
          in: query
          description: Specifies the list of location UIDs that limits the resources to the ones associated with those locations.
          schema:
            type: string
            format: uuid
            nullable: true
          x-veeam-pagination-global-location-filter: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365ProtectedObject'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: d41c84f5-1210-55e8-0cb0-ecf0ce89a715:2607d69c-fefa-4876-a274-531c6fdc43d7
                    name: ad_count
                    repositoryUid: 2607d69c-fefa-4876-a274-520c6fdc32d7
                    repositoryName: Default Backup Repository
                    archiveRepositoryUid: 
                    archiveRepositoryName: 
                    protectedDataType: Site
                    restorePointsCount: 14
                    archiveRestorePointsCount: 0
                    latestRestorePointDate: '2023-11-17T23:06:36.2100000+01:00'
                    vb365ServerUid: 43bd6147-4201-43b3-b8cd-5e6e45af6023
                    vb365ServerName: LRSVBOTR
                    organizationUid: 04aac689-6676-47e4-8411-1c71129f514e
                    organizationName: alpha
                    vb365OrganizationUid: 44a2a2b1-c3b7-4268-9f1e-c7c7437e964f
                    vb365OrganizationName: alpha.onmicrosoft.com
                    siteUid: 592a9947-235f-4234-b8e8-5c8a559d6d3a
                    siteName: lrsvbr11cc
                    locationUid: 1bb59128-5a2b-4313-960e-a092abbd8296
                    locationName: Default location
                    consumesLicense: 
                    isEducationalUser: false
                    fileRestorePortalUrl: 
                    isFileRestorePortalEnabled: false
                  - id: a9abe3e1-8180-5d83-8060-9d9eb8a1cd2d:1a3ba6e2-2d1d-5fa1-83a1-8fb2a042c2d2
                    name: sigma_ob2
                    repositoryUid: 1a3ba5d2-2d1d-4ea1-83a1-8fb1f042d2d2
                    repositoryName: oblimit
                    archiveRepositoryUid: c1492aac-5a67-47bd-9c5b-5d238b056350
                    archiveRepositoryName: ob1
                    protectedDataType: Site
                    restorePointsCount: 48
                    archiveRestorePointsCount: 52
                    latestRestorePointDate: '2023-11-18T08:10:40.8900000+01:00'
                    vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                    vb365ServerName: LRSVBO
                    organizationUid: e9729230-883d-4766-9676-6f917506f040
                    organizationName: My Company
                    vb365OrganizationUid: 9864b18b-ba6c-4679-b924-35cac4818739
                    vb365OrganizationName: rdcloudbackup3.onmicrosoft.com
                    siteUid: 
                    siteName: 
                    locationUid: da859d42-d39f-433d-8f8d-34d826c5e8c8
                    locationName: Default location
                    consumesLicense: 
                    isEducationalUser: false
                    fileRestorePortalUrl: 
                    isFileRestorePortalEnabled: false
                  - id: beccc760-417e-588a-ad29-35bbc3750dc5:1a3ba5d2-2d1d-4ea1-83a1-8fb1f042d2d2
                    name: sigma_ob5
                    repositoryUid: 1a3ba5d2-2d1d-4ea1-83a1-8fb1f042d2d2
                    repositoryName: oblimit
                    archiveRepositoryUid: c1492aac-5a67-47bd-9c5b-5d238b056350
                    archiveRepositoryName: ob1
                    protectedDataType: Group
                    restorePointsCount: 48
                    archiveRestorePointsCount: 52
                    latestRestorePointDate: '2023-11-18T08:10:40.8900000+01:00'
                    vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                    vb365ServerName: LRSVBO
                    organizationUid: e9729230-883d-4766-9676-6f917506f040
                    organizationName: My Company
                    vb365OrganizationUid: 9864b18b-ba6c-4679-b924-35cac4818739
                    vb365OrganizationName: rdcloudbackup3.onmicrosoft.com
                    siteUid: 
                    siteName: 
                    locationUid: da859d42-d39f-433d-8f8d-34d826c5e8c8
                    locationName: Default location
                    consumesLicense: 
                    isEducationalUser: false
                    fileRestorePortalUrl: 
                    isFileRestorePortalEnabled: false
                  - id: b6893cce-e715-5067-8cd8-2d475923c1cd:1a3ba5d2-2d1d-4ea1-83a1-8fb1f042d2d2
                    name: 1GeneralChannel
                    repositoryUid: 1a3ba5d2-2d1d-4ea1-83a1-8fb1f042d2d2
                    repositoryName: oblimit
                    archiveRepositoryUid: c1492aac-5a67-47bd-9c5b-5d238b056350
                    archiveRepositoryName: ob1
                    protectedDataType: Site
                    restorePointsCount: 12
                    archiveRestorePointsCount: 13
                    latestRestorePointDate: '2023-11-18T07:39:36.9470000+01:00'
                    vb365ServerUid: 41eff96a-23c6-402c-b640-d0a59288b0c7
                    vb365ServerName: LRSVBO
                    organizationUid: e9729230-883d-4766-9676-6f917506f040
                    organizationName: My Company
                    vb365OrganizationUid: 9864b18b-ba6c-4679-b924-35cac4818739
                    vb365OrganizationName: rdcloudbackup3.onmicrosoft.com
                    siteUid: 
                    siteName: 
                    locationUid: da859d42-d39f-433d-8f8d-34d826c5e8c8
                    locationName: Default location
                    consumesLicense: 
                    isEducationalUser: false
                    fileRestorePortalUrl: 
                    isFileRestorePortalEnabled: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/protectedWorkloads/vb365ProtectedObjects/{vb365ProtectedObjectId}/restorePoints':
    get:
      tags:
        - Protected Workloads
      summary: Get All Restore Points of Object Protected by Veeam Backup for Microsoft 365
      description: Returns a collection resource representation of all restore points of an object with the specified UID protected by Veeam Backup for Microsoft 365.
      operationId: GetVb365RestorePoints
      parameters:
        - name: vb365ProtectedObjectId
          in: path
          description: Protected object UID.
          required: true
          schema:
            type: string
        - name: vb365ServerUid
          in: query
          description: Veeam Backup for Microsoft 365 server UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: vb365BackupRepositoryUid
          in: query
          description: Veeam Backup for Microsoft 365 backup repository UID.
          schema:
            type: string
            format: uuid
            nullable: true
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Vb365RestorePoint'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - id: 2c6cdda6-7ea2-530a-9610-03549355f993
                    protectedObjectId: d41c84e4-1209-55d7-9db0-ecf0ce78a704
                    vb365JobUid: ffda6c41-28b5-4c45-bc79-0f7fa5b6790a
                    repositoryUid: 2607d69c-fefa-4876-a274-520c6fdc32d7
                    repositoryName: Default Backup Repository
                    backupTime: '2023-11-09T23:06:22.0030000+01:00'
                    isArchive: false
                    processedObjectTypes:
                      - Site
                    processedObjectTypesStr: Site
                  - id: 30db0ddb-000f-5c7f-8e70-0b6666a5620e
                    protectedObjectId: d41c84e4-1209-55d7-9db0-ecf0ce78a704
                    vb365JobUid: ffda6c41-28b5-4c45-bc79-0f7fa5b6790a
                    repositoryUid: 2607d69c-fefa-4876-a274-520c6fdc32d7
                    repositoryName: Default Backup Repository
                    backupTime: '2023-11-11T23:06:33.7800000+01:00'
                    isArchive: false
                    processedObjectTypes:
                      - Site
                    processedObjectTypesStr: Site
                  - id: e169cfe5-fe1d-5308-85e1-1160a37db424
                    protectedObjectId: d41c84e4-1209-55d7-9db0-ecf0ce78a704
                    vb365JobUid: ffda6c41-28b5-4c45-bc79-0f7fa5b6790a
                    repositoryUid: 2607d69c-fefa-4876-a274-520c6fdc32d7
                    repositoryName: Default Backup Repository
                    backupTime: '2023-11-07T23:06:21.6470000+01:00'
                    isArchive: false
                    processedObjectTypes:
                      - Site
                    processedObjectTypesStr: Site
                  - id: 2381c2dc-d246-5f2e-8bf5-46a0c9169cda
                    protectedObjectId: d41c84e4-1209-55d7-9db0-ecf0ce78a704
                    vb365JobUid: ffda6c41-28b5-4c45-bc79-0f7fa5b6790a
                    repositoryUid: 2607d69c-fefa-4876-a274-520c6fdc32d7
                    repositoryName: Default Backup Repository
                    backupTime: '2023-11-06T15:27:51.2970000+01:00'
                    isArchive: false
                    processedObjectTypes:
                      - Site
                    processedObjectTypesStr: Site
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /pulse:
    get:
      tags:
        - Pulse
      summary: Get VCSP Pulse Configuration
      description: Returns a resource representation of VCSP Pulse plugin configuration.
      operationId: GetPulseConfiguration
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PulseConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  token: 
                  status: 2
                  statusMessage: ''
                  isCompanyMappingEnabled: true
                  isLicenseManagementEnabled: true
                  isPushingNewCompaniesToPulseEnabled: false
                  lastUpdateDate: '2023-11-18T04:12:35.1616467+01:00'
                  tokenExpirationDate: 
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PulseConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Pulse
      summary: Modify VCSP Pulse Configuration
      description: "Modifies VCSP Pulse plugin configuration.\n> To disconnect the plugin, replace the `token` property value with `null`.\n"
      operationId: PatchPulseConfiguration
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: pulse_token
                path: /token
                op: add
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PulseConfiguration'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  token: pulse_token
                  status: Configured
                  statusMessage: ''
                  isCompanyMappingEnabled: false
                  isLicenseManagementEnabled: false
                  isPushingNewCompaniesToPulseEnabled: false
                  lastUpdateDate: '2023-11-18T03:58:25.1801781+01:00'
                  tokenExpirationDate: '2023-02-24T07:01:54.0000000+01:00'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PulseConfiguration'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /pulse/sync:
    post:
      tags:
        - Pulse
      summary: Synchronize with VCSP Pulse Portal
      description: Initiates synchronization with the VCSP Pulse portal.
      operationId: SyncPulseData
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /pulse/contracts:
    get:
      tags:
        - Pulse
      summary: Get All Rental Agreement Contracts
      description: Returns a collection resource representation of all rental agreement contracts.
      operationId: GetPulseLicenseContracts
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PulseLicenseContract'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - contractId: '02553265'
                    expirationDate: '2024-09-30T02:00:00.0000000+02:00'
                    pointsLimit: 
                    automaticExtensionAlwaysOn: false
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /pulse/products:
    get:
      tags:
        - Pulse
      summary: Get Veeam Products Available in VCSP Pulse
      description: Returns a collection resource representation of all Veeam products managed in VCSP Pulse.
      operationId: GetPulseLicenseProducts
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PulseLicenseProduct'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - productId: VBR_PLS_11_0_0
                    name: Veeam Backup & Replication
                    edition: Enterprise Plus
                    version: 11.0.0
                    workloads:
                      - workloadId: Public Cloud Database_VBR_PLS_11_0_0
                        name: Public Cloud Database
                        multiplier: 11
                      - workloadId: Public Cloud Fileshare_VBR_PLS_11_0_0
                        name: Public Cloud Fileshare
                        multiplier: 11
                      - workloadId: Server_VBR_PLS_11_0_0
                        name: Server
                        multiplier: 11
                  - productId: VBR_ENT_11_0_0
                    name: Veeam Backup & Replication
                    edition: Enterprise
                    version: 11.0.0
                    workloads:
                      - workloadId: Public Cloud Database_VBR_ENT_11_0_0
                        name: Public Cloud Database
                        multiplier: 11
                      - workloadId: Public Cloud Fileshare_VBR_ENT_11_0_0
                        name: Public Cloud Fileshare
                        multiplier: 11
                      - workloadId: File Share_VBR_ENT_11_0_0
                        name: File Share
                        multiplier: 10
                  - productId: VBR_STD_11_0_0
                    name: Veeam Backup & Replication
                    edition: Standard
                    version: 11.0.0
                    workloads:
                      - workloadId: Public Cloud Database_VBR_STD_11_0_0
                        name: Public Cloud Database
                        multiplier: 11
                      - workloadId: Public Cloud Fileshare_VBR_STD_11_0_0
                        name: Public Cloud Fileshare
                        multiplier: 11
                      - workloadId: Server_VBR_STD_11_0_0
                        name: Server
                        multiplier: 11
                      - workloadId: VM_VBR_STD_11_0_0
                        name: VM
                        multiplier: 5
                      - workloadId: Workstation_VBR_STD_11_0_0
                        name: Workstation
                        multiplier: 4
                      - workloadId: Public Cloud VM_VBR_STD_11_0_0
                        name: Public Cloud VM
                        multiplier: 11
                      - workloadId: File Share_VBR_STD_11_0_0
                        name: File Share
                        multiplier: 10
                  - productId: VCC_000_11_0_0
                    name: Veeam Cloud Connect & Public Cloud Workloads
                    edition: 
                    version: 11.0.0
                    workloads:
                      - workloadId: Public Cloud Database_VCC_000_11_0_0
                        name: Public Cloud Database
                        multiplier: 11
                      - workloadId: Public Cloud Fileshare_VCC_000_11_0_0
                        name: Public Cloud Fileshare
                        multiplier: 10
                      - workloadId: Replica VM_VCC_000_11_0_0
                        name: Replica VM
                        multiplier: 10
                      - workloadId: Server_VCC_000_11_0_0
                        name: Server
                        multiplier: 7
                      - workloadId: Workstation_VCC_000_11_0_0
                        name: Workstation
                        multiplier: 3
                      - workloadId: Backup VM_VCC_000_11_0_0
                        name: Backup VM
                        multiplier: 5
                      - workloadId: Public Cloud VM_VCC_000_11_0_0
                        name: Public Cloud VM
                        multiplier: 11
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /pulse/licenses:
    get:
      tags:
        - Pulse
      summary: Get All Licenses Managed in VCSP Pulse
      description: Rerurns a collection resource representation of all licenses managed in VCSP Pulse.
      operationId: GetPulseLicenses
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PulseLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 911a1b9c-d873-493c-8d4e-0d2cfe69d233
                    licenseId: 29ec3e54-f7a8-34e2-e42c-5ca261296d2a
                    type: Rental
                    assignStatus: Assigned
                    usageType: SingleCustomerUse
                    contractId: '02553265'
                    createdBy: My Company
                    productId: VBR_PLS_11_0_0
                    description: MapPulseTenant 2023-11-18 03:00
                    expirationDate: '2023-04-18T02:00:00.0000000+02:00'
                    points: 80
                    automaticExtensionStatus: Off
                    automaticReportingStatus: On
                    assignedCompanyUid: cdee458d-8c39-45f5-a1e0-1943a231ff5e
                    assignedResellerUid: 
                    workloads:
                      - workloadId: Workstation_VBR_PLS_11_0_0
                        name: Workstation
                        multiplier: 4
                        count: 1
                      - workloadId: File Share_VBR_PLS_11_0_0
                        name: File Share
                        multiplier: 10
                        count: 1
                      - workloadId: Server_VBR_PLS_11_0_0
                        name: Server
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud Database_VBR_PLS_11_0_0
                        name: Public Cloud Database
                        multiplier: 11
                        count: 1
                      - workloadId: VM_VBR_PLS_11_0_0
                        name: VM
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud VM_VBR_PLS_11_0_0
                        name: Public Cloud VM
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud Fileshare_VBR_PLS_11_0_0
                        name: Public Cloud Fileshare
                        multiplier: 11
                        count: 1
                      - workloadId: Application_VBR_PLS_11_0_0
                        name: Application
                        multiplier: 11
                        count: 1
                  - instanceUid: 919bc79a-d4eb-41bf-af23-c5445c528ac8
                    licenseId: 0da8720c-f749-f49f-649b-38211b90262c
                    type: Rental
                    assignStatus: Assigned
                    usageType: SingleCustomerUse
                    contractId: '02553265'
                    createdBy: My Company
                    productId: VBR_PLS_11_0_0
                    description: MapPulseTenant 2023-11-18 03:00
                    expirationDate: '2023-04-18T02:00:00.0000000+02:00'
                    points: 80
                    automaticExtensionStatus: Off
                    automaticReportingStatus: Off
                    assignedCompanyUid: cdee458d-8c39-45f5-a1e0-1943a231ff5e
                    assignedResellerUid: 
                    workloads:
                      - workloadId: Workstation_VBR_PLS_11_0_0
                        name: Workstation
                        multiplier: 4
                        count: 1
                      - workloadId: File Share_VBR_PLS_11_0_0
                        name: File Share
                        multiplier: 10
                        count: 1
                      - workloadId: Server_VBR_PLS_11_0_0
                        name: Server
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud Database_VBR_PLS_11_0_0
                        name: Public Cloud Database
                        multiplier: 11
                        count: 1
                      - workloadId: VM_VBR_PLS_11_0_0
                        name: VM
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud VM_VBR_PLS_11_0_0
                        name: Public Cloud VM
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud Fileshare_VBR_PLS_11_0_0
                        name: Public Cloud Fileshare
                        multiplier: 11
                        count: 1
                      - workloadId: Application_VBR_PLS_11_0_0
                        name: Application
                        multiplier: 11
                        count: 1
                  - instanceUid: 10a6d3d4-8a07-4b7d-b41f-e20e79ca5341
                    licenseId: 06d71898-a88c-2239-2b77-92a443cd8739
                    type: Rental
                    assignStatus: Assigned
                    usageType: SingleCustomerUse
                    contractId: '02553265'
                    createdBy: My Company
                    productId: VBR_ENT_11_0_0
                    description: MapPulseTenant 2023-11-18 03:00
                    expirationDate: '2023-04-18T02:00:00.0000000+02:00'
                    points: 67
                    automaticExtensionStatus: Off
                    automaticReportingStatus: On
                    assignedCompanyUid: cdee458d-8c39-45f5-a1e0-1943a231ff5e
                    assignedResellerUid: 
                    workloads:
                      - workloadId: Workstation_VBR_ENT_11_0_0
                        name: Workstation
                        multiplier: 4
                        count: 1
                      - workloadId: File Share_VBR_ENT_11_0_0
                        name: File Share
                        multiplier: 10
                        count: 1
                      - workloadId: Server_VBR_ENT_11_0_0
                        name: Server
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud Database_VBR_ENT_11_0_0
                        name: Public Cloud Database
                        multiplier: 11
                        count: 1
                      - workloadId: VM_VBR_ENT_11_0_0
                        name: VM
                        multiplier: 9
                        count: 1
                      - workloadId: Public Cloud VM_VBR_ENT_11_0_0
                        name: Public Cloud VM
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud Fileshare_VBR_ENT_11_0_0
                        name: Public Cloud Fileshare
                        multiplier: 11
                        count: 1
                  - instanceUid: 97071499-e9c0-4d70-88bd-51b64a626473
                    licenseId: 35bb4c5a-56b4-f35d-9724-4bb04b4b7924
                    type: Rental
                    assignStatus: Assigned
                    usageType: SingleCustomerUse
                    contractId: '02553265'
                    createdBy: My Company
                    productId: VBR_STD_11_0_0
                    description: MapPulseTenant 2023-11-18 03:01
                    expirationDate: '2023-04-18T02:00:00.0000000+02:00'
                    points: 63
                    automaticExtensionStatus: Off
                    automaticReportingStatus: On
                    assignedCompanyUid: cdee458d-8c39-45f5-a1e0-1943a231ff5e
                    assignedResellerUid: 
                    workloads:
                      - workloadId: Workstation_VBR_STD_11_0_0
                        name: Workstation
                        multiplier: 4
                        count: 1
                      - workloadId: File Share_VBR_STD_11_0_0
                        name: File Share
                        multiplier: 10
                        count: 1
                      - workloadId: Server_VBR_STD_11_0_0
                        name: Server
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud Database_VBR_STD_11_0_0
                        name: Public Cloud Database
                        multiplier: 11
                        count: 1
                      - workloadId: VM_VBR_STD_11_0_0
                        name: VM
                        multiplier: 5
                        count: 1
                      - workloadId: Public Cloud VM_VBR_STD_11_0_0
                        name: Public Cloud VM
                        multiplier: 11
                        count: 1
                      - workloadId: Public Cloud Fileshare_VBR_STD_11_0_0
                        name: Public Cloud Fileshare
                        multiplier: 11
                        count: 1
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
    post:
      tags:
        - Pulse
      summary: Add License to VCSP Pulse
      description: Adds a new license configuration with the specified parameters to VCSP Pulse.
      operationId: CreatePulseLicense
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: License parameters.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PulseLicenseInput'
            example:
              productId: VBR_PLS_12_0_0
              contractId: '02553275'
              description: 
              expirationDate: '2024-04-18T04:09:36.3594704+02:00'
              isAutomaticReportingEnabled: false
              workloads:
                - workloadId: Public Cloud Database_VBR_PLS_12_0_0
                  count: 1
                - workloadId: Public Cloud Fileshare_VBR_PLS_12_0_0
                  count: 1
                - workloadId: Server_VBR_PLS_12_0_0
                  count: 1
                - workloadId: VM_VBR_PLS_12_0_0
                  count: 1
                - workloadId: Workstation_VBR_PLS_12_0_0
                  count: 1
                - workloadId: Public Cloud VM_VBR_PLS_12_0_0
                  count: 1
                - workloadId: File Share_VBR_PLS_12_0_0
                  count: 1
                - workloadId: Application_VBR_PLS_12_0_0
                  count: 1
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PulseLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 703d9de8-8f0c-4b50-a582-5d2a10af1335
                  licenseId: 
                  type: Rental
                  assignStatus: NotAssigned
                  usageType: SingleCustomerUse
                  contractId: '02553275'
                  createdBy: PulseReseller
                  productId: VBR_PLS_12_0_0
                  description: 
                  expirationDate: '2023-04-18T04:09:36.3594704+02:00'
                  points: 80
                  automaticExtensionStatus: Unknown
                  automaticReportingStatus: Off
                  assignedCompanyUid: 
                  assignedResellerUid: 
                  workloads:
                    - workloadId: Public Cloud Database_VBR_PLS_12_0_0
                      name: Public Cloud Database
                      multiplier: 11
                      count: 1
                    - workloadId: Public Cloud Fileshare_VBR_PLS_12_0_0
                      name: Public Cloud Fileshare
                      multiplier: 11
                      count: 1
                    - workloadId: Server_VBR_PLS_12_0_0
                      name: Server
                      multiplier: 11
                      count: 1
                    - workloadId: VM_VBR_PLS_12_0_0
                      name: VM
                      multiplier: 11
                      count: 1
                    - workloadId: Workstation_VBR_PLS_12_0_0
                      name: Workstation
                      multiplier: 4
                      count: 1
                    - workloadId: Public Cloud VM_VBR_PLS_12_0_0
                      name: Public Cloud VM
                      multiplier: 11
                      count: 1
                    - workloadId: File Share_VBR_PLS_12_0_0
                      name: File Share
                      multiplier: 10
                      count: 1
                    - workloadId: Application_VBR_PLS_12_0_0
                      name: Application
                      multiplier: 11
                      count: 1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/pulse/licenses/{licenseUid}':
    get:
      tags:
        - Pulse
      summary: Get License Managed in VCSP Pulse
      description: Rerurns a resource representation of a license managed in VCSP Pulse with the specified UID.
      operationId: GetPulseLicense
      parameters:
        - name: licenseUid
          in: path
          description: License UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PulseLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 24b75ad4-cf4c-45fe-b38b-029561081e04
                  licenseId: 4f154b11-9fde-95f6-5289-a5eb78a6af91
                  type: Rental
                  assignStatus: Assigned
                  usageType: SingleCustomerUse
                  contractId: '02553265'
                  createdBy: PulseReseller
                  productId: VBR_PLS_11_0_0
                  description: 
                  expirationDate: '2023-04-18T04:09:36.3594704+02:00'
                  points: 80
                  automaticExtensionStatus: Off
                  automaticReportingStatus: On
                  assignedCompanyUid: 24335e39-0924-4b1a-a451-f33e72f343fd
                  assignedResellerUid: 
                  workloads:
                    - workloadId: Public Cloud Database_VBR_PLS_11_0_0
                      name: Public Cloud Database
                      multiplier: 11
                      count: 1
                    - workloadId: Public Cloud Fileshare_VBR_PLS_11_0_0
                      name: Public Cloud Fileshare
                      multiplier: 11
                      count: 1
                    - workloadId: Server_VBR_PLS_11_0_0
                      name: Server
                      multiplier: 11
                      count: 1
                    - workloadId: VM_VBR_PLS_11_0_0
                      name: VM
                      multiplier: 11
                      count: 1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PulseLicense'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
    patch:
      tags:
        - Pulse
      summary: Modify License Managed in VCSP Pulse
      description: Modifies a license managed in VCSP Pulse with the specified UID.
      operationId: PatchPulseLicense
      parameters:
        - name: licenseUid
          in: path
          description: License UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: cdee458d-8c39-45f5-a1e0-1943a231ff5e
                path: /assignedCompanyUid
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PulseLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 24b75ad4-cf4c-45fe-b38b-029561081e04
                  licenseId: 4f154b11-9fde-95f6-5289-a5eb78a6af91
                  type: Rental
                  assignStatus: Assigned
                  usageType: SingleCustomerUse
                  contractId: '02653762'
                  createdBy: PulseReseller
                  productId: VBR_PLS_11_0_0
                  description: 
                  expirationDate: '2023-04-18T04:09:36.3594704+02:00'
                  points: 80
                  automaticExtensionStatus: Unknown
                  automaticReportingStatus: Off
                  assignedCompanyUid: cdee458d-8c39-45f5-a1e0-1943a231ff5e
                  assignedResellerUid: 
                  workloads:
                    - workloadId: Public Cloud Database_VBR_PLS_11_0_0
                      name: Public Cloud Database
                      multiplier: 11
                      count: 1
                    - workloadId: Public Cloud Fileshare_VBR_PLS_11_0_0
                      name: Public Cloud Fileshare
                      multiplier: 11
                      count: 1
                    - workloadId: Server_VBR_PLS_11_0_0
                      name: Server
                      multiplier: 11
                      count: 1
                    - workloadId: VM_VBR_PLS_11_0_0
                      name: VM
                      multiplier: 11
                      count: 1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PulseLicense'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    delete:
      tags:
        - Pulse
      summary: Delete License Managed in VCSP Pulse.
      description: Deletes a license managed in VCSP Pulse with the specified UID.
      operationId: DeletePulseLicense
      parameters:
        - name: licenseUid
          in: path
          description: License UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/pulse/licenses/{licenseUid}/copy':
    post:
      tags:
        - Pulse
      summary: Copy License Managed in VCSP Pulse
      description: Creates a copy of a license managed in VCSP Pulse with the specified UID.
      operationId: CopyPulseLicense
      parameters:
        - name: licenseUid
          in: path
          description: License UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PulseLicense'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 24b75ad4-cf4c-45fe-b38b-029561081e04
                  licenseId: 
                  type: Rental
                  assignStatus: NotAssigned
                  usageType: SingleCustomerUse
                  contractId: '02663265'
                  createdBy: PulseReseller
                  productId: VBR_PLS_12_0_0
                  description: 
                  expirationDate: '2023-04-18T04:09:36.3594704+02:00'
                  points: 80
                  automaticExtensionStatus: Unknown
                  automaticReportingStatus: Off
                  assignedCompanyUid: 
                  assignedResellerUid: 
                  workloads:
                    - workloadId: Public Cloud Database_VBR_PLS_12_0_0
                      name: Public Cloud Database
                      multiplier: 11
                      count: 1
                    - workloadId: Public Cloud Fileshare_VBR_PLS_12_0_0
                      name: Public Cloud Fileshare
                      multiplier: 11
                      count: 1
                    - workloadId: Server_VBR_PLS_12_0_0
                      name: Server
                      multiplier: 11
                      count: 1
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/pulse/licenses/{licenseUid}/revoke':
    post:
      tags:
        - Pulse
      summary: Revoke License Managed in VCSP Pulse
      description: Revokes a license managed in VCSP Pulse with the specified UID.
      operationId: RevokePulseLicense
      parameters:
        - name: licenseUid
          in: path
          description: License UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/pulse/licenses/{licenseUid}/install':
    post:
      tags:
        - Pulse
      summary: Install License Managed in VCSP Pulse
      description: "Installs a license managed in VCSP Pulse with the specified UID.\n>License must be issued to a company on whose server it will be installed. It also must not be installed on any other server.\n>Otherwise, the operation will create a copy of the license and install it on the server.\n"
      operationId: InstallPulseLicense
      parameters:
        - name: licenseUid
          in: path
          description: License UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: serverUid
          in: query
          description: UID assigned to a server on which the license must be installed.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/pulse/licenses/{licenseUid}/download':
    post:
      tags:
        - Pulse
      summary: Download License Managed in VCSP Pulse
      description: Downloads a license managed in VCSP Pulse with the specified UID.
      operationId: DownloadPulseLicense
      parameters:
        - name: licenseUid
          in: path
          description: License UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: License file in the Base64 format.
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: string
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data: BAAKCAQBkzpzoQRvsrfsFWRUJxPUHFpwFrFePCIvrKbyOAw0nuiu0HOUgAuDUoktJRGArJDJ7uXIM6dnC8rcERUgpt/Zn0HcPkkOgRA2e5fTz5iYvia1YhI2p0MiLc1wKRmYM/li4rN/rTupdgucsE1eHJj9q1/hZ0kAfjsvCX6zt4Sq/SPeIom8lTAp5cfYuBX7efWI/EeAEs9BX/3JEPVyKplPji8nFPR8HTbxbNw+ntgMc8ymXYBeWrT7wa17eNcq7Ozzn+LzagGw+AP4Ky6DqlZTGWPPoV4f+Y0tznXMJXVTtI6BM33zK7T40ftiIjrPpvuOU3qFb2pTBHgymmlGtY03AgMBAAECggEALhgnuS+kZCn9wSlFrGzqGa6l8xYmB1pCGGrCNDGC/2pqd3ZK8sM+KRx4zmy8iJ2Jk/dtBiicET9InmRLpf/fZQL2niEkWRElJVAn0Yt4XEd+javlZiY/VU6aRLIWaPlDDItaxoPg5xD6KFCZX/I1prCJLBk9UUNnLo/p5qWAvWplfkbY4VpU7p67Cwgs37dBE87jjzqWZEQNc+aB87dz6hJfamBMZ/HKYdY3RwxA+XQCRfhl+qAgR26T/Y7PWEo5NH8kwBtkJ7U+IndNNjjTyW/med4HqNCYLINvSHRQkrs+rfUpY/+b5ObhA9UcdgIyRL1TryBDjpVqMNgn4ZvemQKBgQCtAL0/+EhUwDjKLbHM7JSZAYEhfgwfighB2kIf34YAoqT8t9i4aZX87Pj9GUKJVHiqvdeB32/QccmKkU8/g62DSe8KFDPWqK5r80LpC1JEsYifpcQ9dSmnuRGUGMBkMdDosLAkV8D3j5R03mcMhKXQ91f8NS5YQ5xQMwTBoo0oKwKBgQCVKy7PUEeTQuUGiZYg8UTG5xvRJudhai5UdITjwHijfp2MBjah6q7p0kjbqIM4LUo3AB8JnkKKvdVa9l8qKQhVYoKCX+gYBiGdfS9rAJvYyRhqwd5pvjpA3u+TcRbtJDbkotHCwhkzUEE5pBk3ebO5Yc6u5GK0u26boWx0onW9JQKBgArQrgQOwG7T6XjyLFhUPeHmzyzJ1XYvSd7cByA4+AaYJFpMH/c/WooKQnKIHrm5FyYNYiiTUEkmo+POu7aLw9AeUhw+MRNtTiIffgJVm9oBgzn/wenZpjX/AtNQTM62sompagmLltujFTPNJ4IH1NngbJauuGv6Jg55cgWs5MgrAoGBAIgUw/hWqWU7conbPH1C/VZjAWp1jkG9RxS+03ieXq/wUzOpe2+NFBK1Rsg027iFAJ5aWvZATT4a3ifEeJ6SnkqeuqbLbYV1Gnd8+6QnAwXqtn616/wVkTka5/5e/eZK0lUUAD4nKiw4u7gk7ug/+2hUROQh77YnA0mxIqrohnaNAoGAUdN3OYE0E95SPjrIuZGpJ/2zkruFjWT6Tie6EqZmxMgM+9ZlmfMIY5ED4jcewN7Q59v1zwDRrRMbUzUxzbqE7t7TgydFEESdUg4Q9iU9s90lopQnpcFThCrogigiTXmOhnqB5vkcYbtAZz/H1vRi3jN3YVgeXpw+X2tcEQ5SNck=
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyOwner
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
        - CompanyAdministrator
  /pulse/tenants:
    get:
      tags:
        - Pulse
      summary: Get All VCSP Pulse Tenants
      description: Returns a collection resource representation of all VCSP Pulse tenants.
      operationId: GetPulseTenants
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PulseTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: a7m7d0000000I31AAE
                    mappingStatus: 1
                    mappingStatusMessage: 
                    name: PulseTenant
                    mappedMasterOrganizationUid: 
                    mergedOrganizationUids: [ ]
                  - instanceUid: a7m7d0000000I3HAAU
                    mappingStatus: 1
                    mappingStatusMessage: 
                    name: MapPulseResTenant
                    mappedMasterOrganizationUid: 
                    mergedOrganizationUids: [ ]
                  - instanceUid: a7m7d0000000I3GAAU
                    mappingStatus: 1
                    mappingStatusMessage: 
                    name: PulseResTenant
                    mappedMasterOrganizationUid: 
                    mergedOrganizationUids: [ ]
                  - instanceUid: a7m7d0000000I36AAE
                    mappingStatus: 1
                    mappingStatusMessage: 
                    name: MapPulseTenant
                    mappedMasterOrganizationUid: 
                    mergedOrganizationUids: [ ]
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    post:
      tags:
        - Pulse
      summary: Create VCSP Pulse Tenant
      description: Creates a VCSP Pulse tenant based on a specific company.
      operationId: CreatePulseTenantByCompany
      parameters:
        - $ref: '#/components/parameters/companyUid_query'
        - name: rewriteExisting
          in: query
          description: Defines whether a company must be mapped to an existing tenant with the same name.
          schema:
            type: boolean
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PulseTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: a7m7d0000000JgsAAI
                  mappingStatus: Mapped
                  mappingStatusMessage: 
                  name: PulseTenant
                  mappedMasterOrganizationUid: bb06d15-37f8-4480-bb0b-943c53cfc3cc
                  mergedOrganizationUids: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/pulse/tenants/{tenantUid}':
    get:
      tags:
        - Pulse
      summary: Get VCSP Pulse Tenant
      description: Returns a resource representation of a VCSP Pulse tenant with the specified UID.
      operationId: GetPulseTenant
      parameters:
        - name: tenantUid
          in: path
          description: VCSP Pulse tenant UID.
          required: true
          schema:
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PulseTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: a7m7d0000000I3HAAU
                  mappingStatus: 2
                  mappingStatusMessage: 
                  name: MapPulseResTenant
                  mappedMasterOrganizationUid: 7af30a7d-ce8b-4b0d-adc8-ce96395449e5
                  mergedOrganizationUids: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/PulseTenant'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
    patch:
      tags:
        - Pulse
      summary: Modify VCSP Pulse Tenant
      description: Modifies a VCSP Pulse tenant with the specified UID.
      operationId: PatchPulseTenant
      parameters:
        - name: tenantUid
          in: path
          description: VCSP Pulse tenant UID.
          required: true
          schema:
            type: string
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: cdee458d-8c39-45f5-a1e0-1943a231ff5e
                path: /mappedMasterOrganizationUid
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PulseTenant'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: a7m7d0000000I3GEAU
                  mappingStatus: Mapped
                  mappingStatusMessage: 
                  name: MapPulseResTenant
                  mappedMasterOrganizationUid: cdee458d-8c39-45f5-a1e0-1943a231ff5e
                  mergedOrganizationUids: [ ]
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/PulseTenant'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  '/pulse/tenants/{tenantUid}/createCompany':
    post:
      tags:
        - Pulse
      summary: Create Company from VCSP Tenant
      description: Creates a company based on VCSP Pulse tenant with the specified UID.
      operationId: CreateCompanyByPulseTenant
      parameters:
        - name: tenantUid
          in: path
          description: VCSP Pulse tenant UID.
          required: true
          schema:
            type: string
        - name: siteUid
          in: query
          description: Veeam Cloud Connect site UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: gatewayPoolUid
          in: query
          description: Gateway pool UID.
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/Organization'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 24335e39-0924-4b1a-a451-f33e72f343fd
                  name: Exon
                  alias: exon
                  type: Company
                  taxId: '09876'
                  email: m.lore@exon.com
                  phone: 503-254-0212
                  country: 1
                  state: 5
                  countryName: USA
                  regionName: West
                  city: Portland
                  street: 5006 Gateway Road
                  locationAdmin0Code: us
                  locationAdmin1Code: us-or
                  locationAdmin2Code: 
                  notes: 
                  zipCode: '97220'
                  website: www.exon.com
                  veeamTenantId: a7m7d0000000I3GBBU
                  companyId: ''
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderAdministrator
  /users/serviceProvider/localUserRule:
    get:
      tags:
        - Accounts
      summary: Get All Administrator Portal Users and Groups
      description: Returns a collection resource representation of all Administrator Portal users and groups.
      operationId: GetLocalUserRules
      parameters:
        - name: filter
          in: query
          description: Specifies the conditions that a resource must meet to be returned in the output.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FilterParameter'
          x-veeam-pagination-filter: true
        - name: sort
          in: query
          description: Specifies the order in which resources are returned from the collection.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SortParameter'
          x-veeam-pagination-sort: true
        - name: limit
          in: query
          description: Specifies the first N resources that must be returned in the output.
          schema:
            maximum: 500
            minimum: 1
            type: integer
            format: int32
            default: 100
          x-veeam-pagination-limit: true
        - name: offset
          in: query
          description: Excludes the first N resources from the query output.
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
            default: 0
          x-veeam-pagination-offset: true
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LocalUserRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - instanceUid: 05e1e465-0806-44ce-a3e1-c0f469885fba
                    sid: S-1-0-0
                    name: Administrators
                    description: Local administrator group of Veeam Service Provider Console Server. This group has unrestricted access to this portal.
                    enabled: true
                    roleType: portalAdministrator
                    contextType: domain
                    scope:
                      - type: all
                        objectUid: 
                    type: winNTGroup
                    mfaPolicyStatus: disabled
                    hasAccessToProvider: false
                  - instanceUid: d5d3c2a2-a0c0-4fb9-87fb-4af4d12c958b
                    sid: S-1-0-529155602
                    name: r2vac Site Administrators
                    description: All users and groups which are added to the administrator group on a Veeam Cloud Connect server. Members of this group have full access to the companies created on this server.
                    enabled: true
                    roleType: siteAdministrator
                    contextType: domain
                    scope:
                      - type: all
                        objectUid: 
                    type: winNTGroup
                    mfaPolicyStatus: disabled
                    hasAccessToProvider: false
                  - instanceUid: 80ced255-aae4-4249-8789-5b29a360c610
                    sid: S-1-0-926637897
                    name: r2SecondCC Site Administrators
                    description: All users and groups which are added to the administrator group on a Veeam Cloud Connect server. Members of this group have full access to the companies created on this server.
                    enabled: true
                    roleType: siteAdministrator
                    contextType: domain
                    scope:
                      - type: all
                        objectUid: 
                    type: winNTGroup
                    mfaPolicyStatus: disabled
                    hasAccessToProvider: false
                  - instanceUid: cf663c82-c9c3-437b-b23d-6adee3bf8dbd
                    sid: S-1-0-873799823
                    name: r2ThirdCC Site Administrators
                    description: All users and groups which are added to the administrator group on a Veeam Cloud Connect server. Members of this group have full access to the companies created on this server.
                    enabled: true
                    roleType: siteAdministrator
                    contextType: domain
                    scope:
                      - type: all
                        objectUid: 
                    type: winNTGroup
                    mfaPolicyStatus: disabled
                    hasAccessToProvider: false
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    post:
      tags:
        - Accounts
      summary: Create Administrator Portal User or Group
      description: Creates a new Administrator Portal user or group.
      operationId: CreateLocalUserRule
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: User or group parameters.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LocalUserRuleInput'
            example:
              sid: S-1-5-21-3655030342-2499544343-4802907742-1002
              name: PortalAdmin
              description: Created by admin
              enabled: true
              roleType: portalAdministrator
              contextType: machine
              scope:
                - type: all
                  objectUid: 
              mfaPolicyStatus: disabled
              hasAccessToProvider: 
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LocalUserRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: be7a3198-5gcc-4a7b-9221-24a16064e993
                  sid: S-1-5-21-3655030342-2499544343-4802907742-1002
                  name: PortalAdmin
                  description: Created by admin
                  enabled: true
                  roleType: portalAdministrator
                  contextType: machine
                  scope:
                    - type: all
                      objectUid: 
                  type: winNTUser
                  mfaPolicyStatus: disabled
                  hasAccessToProvider: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/users/serviceProvider/localUserRule/{winPrincipalId}':
    get:
      tags:
        - Accounts
      summary: Get Administrator Portal User or Group
      description: Returns a resource representation of an Administrator Portal user or group with the specified UID.
      operationId: GetLocalUserRule
      parameters:
        - name: winPrincipalId
          in: path
          description: Administrator Portal user or group UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LocalUserRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: 05e1e465-0806-44ce-a3e1-c0f469885fba
                  sid: S-1-0-0
                  name: Administrators
                  description: Local administrator group of Veeam Service Provider Console Server. This group has unrestricted access to this portal.
                  enabled: true
                  roleType: portalAdministrator
                  contextType: domain
                  scope:
                    - type: all
                      objectUid: 
                  type: winNTGroup
                  mfaPolicyStatus: disabled
                  hasAccessToProvider: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/LocalUserRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    patch:
      tags:
        - Accounts
      summary: Modify Administrator Portal User or Group
      description: Modifies an Administrator Portal user or group with the specified UID.
      operationId: PatchLocalUserRule
      parameters:
        - name: winPrincipalId
          in: path
          description: Administrator Portal user or group UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - value: Created by admin
                path: /Description
                op: replace
              - value: false
                path: /Enabled
                op: replace
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/LocalUserRule'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  instanceUid: df4c0fd4-83e8-48d7-bc51-9e854fba2667
                  sid: S-1-5-21-3655030342-2499544343-4802907742-1002
                  name: PortalAdmin
                  description: Portal Administrator
                  enabled: false
                  roleType: portalAdministrator
                  contextType: machine
                  scope:
                    - type: all
                      objectUid: 
                  type: winNTUser
                  mfaPolicyStatus: disabled
                  hasAccessToProvider: false
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/LocalUserRule'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    delete:
      tags:
        - Accounts
      summary: Delete Administrator Portal User or Group
      description: Deletes an Administrator Portal user or group with the specified UID.
      operationId: DeleteLocalUserRule
      parameters:
        - name: winPrincipalId
          in: path
          description: Administrator Portal user or group UID.
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  /users/serviceProvider/localUserRule/discovery:
    post:
      tags:
        - Accounts
      summary: Discover Domain Users and Groups
      description: Discovers users and groups in the domain and on the machine on which Veeam Service Provider Console is installed.
      operationId: DiscoverObjectsForLocalUserRule
      parameters:
        - name: domain
          in: query
          description: Domain name.
          required: true
          schema:
            type: string
        - name: type
          in: query
          description: Account type.
          required: true
          schema:
            enum:
              - winNTUser
              - winNTGroup
            type: string
            x-ms-enum:
              name: LocalUserRuleType
        - name: filterName
          in: query
          description: Name filter.
          schema:
            type: string
        - name: userName
          in: query
          description: User name required to connect to the domain.
          required: true
          schema:
            type: string
        - name: password
          in: query
          description: Password required to connect to the domain.
          required: true
          schema:
            type: string
            format: password
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/LocalUserRuleDiscoveryItem'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - sid: S-1-5-32-580
                    name: Access Control Assistance Operators
                    displayName: Access Control Assistance Operators
                    description: Members of this group can remotely query authorization attributes and permissions for resources on this computer.
                    type: winNTGroup
                    contextType: machine
                  - sid: S-1-5-32-555
                    name: Administrators
                    displayName: Administrators
                    description: 
                    type: winNTGroup
                    contextType: machine
                  - sid: S-1-5-32-562
                    name: Backup Operators
                    displayName: Backup Operators
                    description: Backup Operators can override security restrictions for the sole purpose of backing up or restoring files
                    type: winNTGroup
                    contextType: machine
                  - sid: S-1-5-32-585
                    name: Certificate Service DCOM Access
                    displayName: Certificate Service DCOM Access
                    description: Members of this group are allowed to connect to Certification Authorities in the enterprise
                    type: winNTGroup
                    contextType: machine
                meta:
                  pagingInfo:
                    total: 4
                    count: 4
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
  '/permissions/{entityUid}':
    get:
      tags:
        - Companies
      summary: Get Permissions of Veeam Service Provider Console Entity
      description: Returns a resource representation of permissions provided to a Veeam Service Provider Console entity with the specified UID.
      operationId: GetEntityPermissions
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/EntityPermissions'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  claims:
                    - HostedVbrJobCreate
                    - HostedVbrJobEdit
                    - HostedVbrJobDelete
                    - HostedVbrJobEnableDisable
                    - HostedVbrJobStartStop
                    - HostedVbrJobScopeWrite
                    - HostedVbrJobStorageWrite
                    - HostedVbrJobRetentionWrite
                    - HostedVbrJobGuestProcessingWrite
                    - HostedVbm365JobCreate
                    - HostedVbm365JobDelete
                    - HostedVbm365JobEdit
                    - HostedVbm365JobEnableDisable
                    - HostedVbm365JobStartStop
                    - HostedVbm365JobScopeWrite
                    - HostedVbm365JobRepositoryWrite
                    - PublicCloudJobCreate
                    - PublicCloudJobEdit
                    - PublicCloudJobDelete
                    - PublicCloudJobEnableDisable
                    - PublicCloudJobStartStop
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-get-for:
        $ref: '#/components/schemas/EntityPermissions'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    patch:
      tags:
        - Companies
      summary: Modify Veeam Service Provider Console Entity Permissions
      description: Modifies permissions provided to a Veeam Service Provider Console entity with the specified UID.
      operationId: PatchEntityPermissions
      parameters:
        - name: entityUid
          in: path
          description: "UID of a Veeam Service Provider Console entity.\n> In the current version it can only be company UID.\n"
          required: true
          schema:
            type: string
            format: uuid
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        description: Array of JSON Patch operations according to RFC 6902.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/JsonPatches'
            example:
              - op: add
                path: /claims
                value: PublicCloudJobStartStop
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/EntityPermissions'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  claims:
                    - HostedVbrJobCreate
                    - HostedVbrJobEdit
                    - HostedVbrJobDelete
                    - HostedVbrJobEnableDisable
                    - HostedVbrJobStartStop
                    - HostedVbrJobScopeWrite
                    - HostedVbrJobStorageWrite
                    - HostedVbrJobRetentionWrite
                    - HostedVbrJobGuestProcessingWrite
                    - HostedVbm365JobCreate
                    - HostedVbm365JobDelete
                    - HostedVbm365JobEdit
                    - HostedVbm365JobEnableDisable
                    - HostedVbm365JobStartStop
                    - HostedVbm365JobScopeWrite
                    - HostedVbm365JobRepositoryWrite
                    - PublicCloudJobCreate
                    - PublicCloudJobEdit
                    - PublicCloudJobDelete
                    - PublicCloudJobEnableDisable
                    - PublicCloudJobStartStop
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-patch-for:
        $ref: '#/components/schemas/EntityPermissions'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderAdministrator
        - SiteAdministrator
    parameters:
      - name: entityUid
        in: path
        description: "UID of a Veeam Service Provider Console entity.\n> In the current version it can only be company UID. \n"
        required: true
        schema:
          type: string
          format: uuid
      - name: entityType
        in: query
        description: Type of a Veeam Service Provider Console entity.
        required: true
  '/plugins/{pluginId}':
    get:
      tags:
        - Plugins
      summary: Get Plugin
      description: Returns a resource representation of a currently installed plugin with the specified ID.
      operationId: GetPlugin
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PluginInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  pluginId: acfa09fe-1286-45f0-9cd5-b794d9d183d0
                  name: Veeam Intelligence
                  icon: content\any\any\ui-content\favicon.svg
                  description: 'Veeam Intelligence provides AI-powered insights and guidance to help you monitor, analyze and optimize your data protection environment using technical documentation and your infrastructure data.'
                  version: 1.0.0.131
                  availableVersions: [ ]
                  enabled: true
                  hasApiKey: false
                  supportedFeatures:
                    - HealthMonitoring
                    - ReadinessCheck
                    - DataPurge
                    - LogsDownload
                  agentPermissionRules:
                    rules: [ ]
                    agentsAreAllowedByDefault: true
                  organizationPermissionRules:
                    rules: [ ]
                    organizationsAreAllowedByDefault: true
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
    delete:
      tags:
        - Plugins
      summary: Uninstall Plugin
      description: Uninstalls a currently installed plugin with the specified ID.
      operationId: UninstallPlugin
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/pluginId_path'
  '/plugins/{pluginId}/apikey':
    post:
      tags:
        - Plugins
      summary: Assign API Key to Plugin
      description: Assigns an API key to a plugin with the specified ID.
      operationId: AssignApiKey
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignPluginApiKeyRequest'
            example:
              apiKey: 310cfbbe3fc812741b4RdLdu2uKCqFGzv8YN3SbSF5UXwQ5Ny28h6UvG692J5s2iIvNlci7ssP5cjk1FMFVvmwL1IjWanUQVR2qqmjpHzXy1SpYmL6hUBMGPVW5xl370
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/pluginId_path'
  '/plugins/{pluginId}/organizations':
    post:
      tags:
        - Plugins
      summary: Configure Plugin Access Permissions for Organizations
      description: Assigns and limits permissions for organizations to access a plugin with the specified ID.
      operationId: UpdateOrganizationRules
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePluginOrganizationRulesRequest'
            example:
              allowOrganizationIds:
                - 77bdcd9b-af00-405c-bb89-c24abac90e36
                - 8919fb54-90df-4465-a641-e545fb287f29
              denyOrganizationIds:
                - 8f6506f7-b2c4-456f-b417-00e28d82504d
              allowOrganizationsByDefault: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/pluginId_path'
  '/plugins/{pluginId}/agents':
    post:
      tags:
        - Plugins
      summary: Configure Plugin Access Permissions for Management Agents
      description: Assigns and limits permissions for management agents to access a plugin with the specified ID.
      operationId: UpdateAgentRules
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdatePluginAgentRulesRequest'
            example:
              allowAgemtIds:
                - 77bdcd9b-af00-405c-bb89-c24abac90e36
                - 8919fb54-90df-4465-a641-e545fb287f29
              denyAgentIds:
                - 8f6506f7-b2c4-456f-b417-00e28d82504d
              allowAgentsByDefault: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/pluginId_path'
  '/plugins/{pluginId}/enabled':
    post:
      tags:
        - Plugins
      summary: Modify Plugin Status.
      description: Modifies a status of a plugin with the specified ID.
      operationId: EnableDisablePlugin
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnableDisablePluginRequest'
            example:
              enabled: true
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptyResponse'
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/pluginId_path'
  /plugins/user/islogged:
    get:
      tags:
        - Plugins
      summary: Get Plugin User Account Data
      description: "Returns a resource representation of information on plugin user account and server.\n> Should be used only by plugins.\n"
      operationId: GetPluginUserIsLogged
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    $ref: '#/components/schemas/PluginUserLoginData'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  logged: false
                  user: 
                  serviceTimeZone:
                    id: E. Europe Standard Time
                    description: (UTC+02:00) Chisinau
                    utcOffsetInMinutes: 180
                  version: 9.0.0.28288
                  sessionExpirationTime: 3600
                  tokenProlongationPeriod: 3600
                  formats:
                    netShortTime: h:mm tt
                    netLongTime: h:mm:ss tt
                    netShortDate: M/d/yyyy
                    shortTime: g:i A
                    longTime: g:i:s A
                    shortDate: n/j/Y
                  colorScheme: blue
                  portalName: Veeam Service Provider Console
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-allow-anonymous: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  /plugins/:
    get:
      tags:
        - Plugins
      summary: Get All Installed Plugins
      description: Returns a collection resource representation of all installed plugins.
      operationId: GetAllPlugins
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PluginInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - pluginId: acfa09fe-1286-45f0-9cd5-b794d9d183d0
                    name: Veeam Intelligence
                    icon: content\any\any\ui-content\favicon.svg
                    description: 'Veeam Intelligence provides AI-powered insights and guidance to help you monitor, analyze and optimize your data protection environment using technical documentation and your infrastructure data.'
                    version: 1.0.0.131
                    availableVersions: [ ]
                    enabled: true
                    hasApiKey: false
                    supportedFeatures:
                      - HealthMonitoring
                      - ReadinessCheck
                      - DataPurge
                      - LogsDownload
                    agentPermissionRules:
                      rules: [ ]
                      agentsAreAllowedByDefault: true
                    organizationPermissionRules:
                      rules: [ ]
                      organizationsAreAllowedByDefault: true
                  - pluginId: b343ccc4-de5a-42e1-9351-57906464752e
                    name: Company List
                    icon: content\any\any\ui-content\favicon.png
                    description: Monitor managed companies
                    version: 1.0.16
                    availableVersions: [ ]
                    enabled: true
                    hasApiKey: true
                    supportedFeatures:
                      - RestApiKey
                      - DataPurge
                      - LogsDownload
                    agentPermissionRules:
                      rules: [ ]
                      agentsAreAllowedByDefault: true
                    organizationPermissionRules:
                      rules:
                        - id: 9430969a-0ac1-4c65-9286-ca8fa79a5d18
                          allowed: true
                      organizationsAreAllowedByDefault: false
                meta:
                  pagingInfo:
                    total: 2
                    count: 2
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
  '/plugins/{pluginId}/versions':
    get:
      tags:
        - Plugins
      summary: Get Plugin Available Versions
      description: Returns a collection resource representation of all available versions of a plugin with the specified ID.
      operationId: GetPluginVersions
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PluginVersionInfo'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - pluginId: acfa09fe-1286-45f0-9cd5-b794d9d183d0
                    version: 1.0.0.131
                meta:
                  pagingInfo:
                    total: 1
                    count: 1
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
    parameters:
      - $ref: '#/components/parameters/pluginId_path'
  /plugins/charges:
    get:
      tags:
        - Plugins
      summary: Get Charges for All Plugins
      description: Returns a collection resource representation of charges for all registered plugins.
      operationId: GetPluginCharges
      parameters:
        - name: X-Request-id
          in: header
          description: "Random UID that you can assign to a request for idempotence and async action progress tracking.\n>Note that an operation is idempotent only during 5 minute time interval."
          schema:
            type: string
            format: uuid
          example: ba547d14-c556-42bb-b85c-eeeb16e2f5e7
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                required:
                  - data
                type: object
                properties:
                  meta:
                    $ref: '#/components/schemas/ResponseMetadata'
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/PluginCharge'
                  errors:
                    type: array
                    items:
                      $ref: '#/components/schemas/ResponseError'
                    nullable: true
                    readOnly: true
              example:
                data:
                  - pluginId: 2adbd8ad-8a9e-40c4-a466-76b127bc535e
                    chargeUid: 00000000-0000-0000-0000-000000000022
                    displayName: 'Object storage [charge]'
                    categoryId: 00000000-0000-0000-0000-000000000002
                    categoryDisplayName: 'Consumed space [category]'
                    measureCategory: Size
                  - pluginId: 2adbd8ad-8a9e-40c4-a466-76b127bc535e
                    chargeUid: 00000000-0000-0000-0000-000000000011
                    displayName: 'Virtual Machines [charge]'
                    categoryId: 00000000-0000-0000-0000-000000000001
                    categoryDisplayName: 'Protected objects [category]'
                    measureCategory: Units
                  - pluginId: 2adbd8ad-8a9e-40c4-a466-76b127bc535e
                    chargeUid: 00000000-0000-0000-0000-000000000033
                    displayName: 'Workstation Agents [charge]'
                    categoryId: 00000000-0000-0000-0000-000000000001
                    categoryDisplayName: 'Protected objects [category]'
                    measureCategory: Units
                meta:
                  pagingInfo:
                    total: 3
                    count: 3
                    offset: 0
        '202':
          description: Request has been queued for execution.
          headers:
            Location:
              description: 'Contains a link to the async action tracking endpoint. Example: https://vspc:1280/api/v3/asyncActions/97431954-0dd7-472a-8cb7-d0cb0fbccaf7'
              schema:
                type: string
        default:
          description: 'All client errors (400–499) are returned with the associated HTTP status codes. All server errors (≥500) are returned with the 520 HTTP status code. For details, see the response body.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - CompanyInvoiceAuditor
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - ReadOnlyUser
  /token:
    post:
      tags:
        - Authentication
      summary: OAuth 2.0 Authentication
      description: Performs authentication using the OAuth 2.0 Authorization Framework.
      operationId: OAuth2IssueToken
      parameters:
        - name: X-Client-Version
          in: header
          description: Version of Veeam Service Provider Console REST API supported by client.
          schema:
            type: string
          example: '3.6'
        - name: select
          in: query
          description: Returns explicitly requested properties.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SelectParameter'
          x-veeam-pagination-select: true
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              required:
                - grant_type
              properties:
                grant_type:
                  enum:
                    - password
                    - refresh_token
                    - authorization_code
                    - public_key
                    - mfa
                    - as
                  type: string
                  description: Grant type according to RFC 6749.
                  example: password
                username:
                  maxLength: 2048
                  minLength: 1
                  type: string
                  description: "User name.\n> Used with the `password` grant type.\n"
                  nullable: true
                  example: restv3vacadministrator
                password:
                  maxLength: 128
                  minLength: 1
                  type: string
                  description: "Password.\n> Used with the `password` grant type.\n"
                  format: password
                  nullable: true
                  example: secretPassword
                refresh_token:
                  maxLength: 2048
                  minLength: 1
                  type: string
                  description: "Refresh token.\n> Used with the `refresh_token` and `as` grant type.\n"
                  nullable: true
                  example: 
                mfa_token:
                  type: string
                  description: "Multi-factor authentication token.\n> Used with the `mfa` grant type.\n"
                  nullable: true
                  example: 
                mfa_code:
                  maxLength: 100
                  type: string
                  description: "Multi-factor authentication code.\n> Used with the `mfa` grant type.\n"
                  nullable: true
                  example: 
                code:
                  type: string
                  description: "Authorization code.\n> Used with the `authorization_code` grant type.\n"
                  nullable: true
                  example: 
                public_key:
                  type: string
                  description: "Public key encoded in the Base64 format.\n> Used with the `public_key` grant type.\n"
                  nullable: true
                  example: 
                userUid:
                  type: string
                  description: "UID assigned to a user whose account must be used for authentication.\n> Used with the `as` grant type.\n"
                  format: uuid
                  nullable: true
                  example: 
                readOnly:
                  type: boolean
                  description: "Defines whether a read-only access token must be issued.\n> Used with any grant type.\n"
                  nullable: true
                  example: 
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuth2Result'
              example:
                access_token: Zm91cm5laWdoYm9ybWlnaHRwYXR0ZXJuY2hvb3NlaG93YXdhcmVjbHVieWVzdGVyZGF5ZXNwZWNpYWxseWZhbWlsaWFybGFyZ2VzdHNwb3J0b3RoZXJhY3R1YWx0aG91Z2hzb21ldGhpbmdzaW5nZ29vc2VqZXRqb2lueW91bmdkaWZmZXJlbmNlYnJpZ2h0aW5zdGVhZGFnYWlud2hhdGZpbmdlcndlc3Rlcm5leHBsYWluZmF0aGVycGhyYXNlY29tcGFueWRyaXZlbmFibGV3aGV0-GVyd2VsY29tZW5vZGRlZHNhdmVkbG9uZ2ltcG9zc2libGVjcmVhdHVyZWZhc3RlcmJyZWFrZmFzdGxhc3RiYXJlZm9sa3NhcHByb3ByaWF0ZW91Z2h0cm9wZW1hbm5vdHNpZ250aGlubGlzdGVubWlsbGxpc3RzbGlwcGVkZW5kYWdyZWVnZW50bHljaGFpbmNoZWVzZXRoaW5rZXhpc3Rrbm93bmJlZ2lubmluZ2Jyb2tlb3BlbnNwZWFrY2FsbGF2b2lkYnJhdmVwYXNzYWdlbGFkeXBlbmNpbGRhd250aGlua3BhcnR5d29tZW5tZXRodW5ncnlzaG9lcG93ZXJmdWxleHRyYWVuZ2luZWRyYXdjb3VudHJ5d291bGR0b3VjaHBocmFzZXdyaXRpbmdzaW1wbHl0b25ld29ybGRzdGF0ZW1lbnRzb2x1dGlvbnJlY29yZHJlcGVhdHJ1c2h0cnVua3Zhc3RzdH-1Y2t5ZWFycGllY2VmZWx0dW5jbGVpbnN0YW5jZWxhbmd1YWdlc29uZ2pvYmdyYWRlZHJpZWRnZW50bHljaGFydHRyb29wc2NvdmVyYXR0YWNoZWRidXJpZWRiYXNpc2F0dGVtcHRtYXliZXplcm9jbG9ja3NpdHRpbmd3aW5kc3VjY2Vzc2Z1bGNhcHRhaW5nZW5lcmFsbHlldmVyeXRoaW5nc2VlbW91dGhzcGVuZHByb2JhYg
                token_type: bearer
                refresh_token: cGx1c2VzdGFibGlzaGV2ZXJ5Ym9keWNvbHVtbmxhd2NvYWxtYWpvcnRvd25zaXhjYXJyaWVkc3RhbmRmaWZ0eWdyYWluY2lyY2xld2hvbXNwaXJpdHBsZWFzYW50ZHJpbmtwcmVzc3VyZWF2b2lkZmF2b3JpdGVsb2NhdGVzYWxlc2F0YmV0d2VlbmJvcm5mYWN0b3J5ZmVsdHNpbXBsZXdoZWVsd3JpdHRlbnByb3Blcmx5bGlzdGVuaG9zcGl0YWxncm91cHRvbW9ycm93c2xpZ2h0aG9sbG93c29saWRhbHRob3VnaHRhbGtzdG9waGl0dmlzaXR0aXRsZXJvYXJzcGVsbHNhdGVsbGl0ZXNyZWNvZ25pemVoaWRkZW5mb3J0eW1haWxjb21wYXJla2lsbHNvZnRwb3NpdGlvbnJlZ2lvbmJlYXR3aGVyZW1hbmFnZWR0aGlua2lsbGJ-aW5nY3V0c2xpcHRoZW9yeWFydGV4ZXJjaXNlc2h1dGRvbGxhcmJhbmRhY3R1YWxseW11ZGZ1bGx5cmVjYWxsZHJlc3NldmVudHVhbGx5b2JqZWN0cGFja2FnZWNodXJjaHN1cHBlcmRhcmtuZXNzcmVhZHdvcmVyYWJiaXRhY3R1YWxseXBvb3J0cmFkZXNoYWtlcHJpemVzZXR0bGVlbXB0eWhvbWVhc3Jlc2VhcmNocmVndWxhcnBvd2VyZnVsY29sZG1lc2lsa3Blb3BsZWxpbWl0ZWRhZHZlbnR1cmVjb21tdW5pdHlyaHltZXdpbmRvd2NvbWJpbmVj-3JyZWN0bHloYXJib3JjdXB3aW5kb3dmb3VydGhsaXZlZGVlcGx5aW5kdXN0cnl0aHJvd2ZvcndhcmRyaWNlaGF2aW5nb2NjYXNpb25hbGx5bm9yYW5jdXRzeXN0ZW1zeWxsYWJsZXN0cmF3d2F5bW90aGVybW9ybmluZ2NvbnZlcnNhdGlvbmJvdHRvbWV4cGVyaWVuY2VtZXRobw
                mfa_token: 
                encrypted_code: 
                expires_in: 3600
        '400':
          description: Invalid data input.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OAuth2Error'
      x-veeam-allow-anonymous: true
      x-veeam-vspc-deny-async-action-registration: true
      x-veeam-vspc-admitted-roles:
        - PortalAdministrator
        - LocationAdministrator
        - LocationUser
        - CompanyOwner
        - CompanyInvoiceAuditor
        - Subtenant
        - PortalOperator
        - ServiceProviderGlobalAdministrator
        - ServiceProviderOperator
        - ServiceProviderUser
        - ServiceProviderInvoiceAuditor
        - ServiceProviderAdministrator
        - SiteAdministrator
        - CompanyAdministrator
        - ReadOnlyUser
        - CompanyTenant
components:
  schemas:
    BackupJobOperationMode:
      enum:
        - Unknown
        - Workstation
        - Server
      type: string
      description: Backup job operation mode.
      x-extensible-enum: true
      x-ms-enum:
        name: BackupJobOperationMode
    DaysOfWeek:
      enum:
        - Sunday
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
      type: string
      x-ms-enum:
        name: DaysOfWeek
    DaysOfWeekNullable:
      enum:
        - Sunday
        - Monday
        - Tuesday
        - Wednesday
        - Thursday
        - Friday
        - Saturday
      type: string
      nullable: true
      x-ms-enum:
        name: DaysOfWeek
    Month:
      enum:
        - Jan
        - Feb
        - Mar
        - Apr
        - May
        - Jun
        - Jul
        - Aug
        - Sep
        - Oct
        - Nov
        - Dec
      type: string
      x-ms-enum:
        name: Month
    FilterParameter:
      type: array
      items:
        $ref: '#/components/schemas/FilterExpression'
      description: Array of the `filter` query expressions.
      nullable: true
    SortParameter:
      type: array
      items:
        $ref: '#/components/schemas/SortExpression'
      description: Array of the `sort` query expressions.
      nullable: true
    Collation:
      enum:
        - ordinal
        - ignorecase
        - lexicographic
      type: string
      description: Type of rules that determine how specified values are compared with resource property values.
      nullable: true
    FilterExpression:
      required:
        - operation
      type: object
      properties:
        property:
          type: string
          description: Path to the required resource property.
          nullable: true
        items:
          type: array
          items:
            $ref: '#/components/schemas/FilterExpression'
          description: 'Inner expressions. Can be used only with `and`, `or` and `not` operation.'
          nullable: true
        operation:
          enum:
            - in
            - contains
            - subset
            - superset
            - equals
            - notEquals
            - lessThan
            - lessThanOrEqual
            - greaterThan
            - greaterThanOrEqual
            - exclusiveOr
            - or
            - and
            - not
          type: string
          description: Filter operation.
          x-ms-enum:
            name: FilterOperation
        collation:
          $ref: '#/components/schemas/Collation'
        value:
          type: object
          description: Resource property value.
          nullable: true
    SortExpression:
      required:
        - property
        - direction
      type: object
      properties:
        property:
          type: string
          description: Path to the required resource property.
        direction:
          enum:
            - ascending
            - descending
          type: string
          description: Direction specifier.
          default: ascending
          x-ms-enum:
            name: SortDirection
        collation:
          $ref: '#/components/schemas/Collation'
    SelectParameter:
      type: array
      items:
        $ref: '#/components/schemas/SelectExpression'
      description: Array of the `select` query expressions.
      nullable: true
    SelectExpression:
      required:
        - propertyPath
      type: object
      properties:
        propertyPath:
          type: string
          description: Path to the required resource property.
    AsyncActionInfo:
      required:
        - id
        - initiatorUid
        - actionName
        - status
        - queryParameters
      type: object
      properties:
        id:
          type: string
          description: UID assigned to an async action.
          format: uuid
        initiatorUid:
          type: string
          description: UID assigned to a user who initiates an async action.
          format: uuid
        actionName:
          type: string
          description: Name of an operation that initiated an async action.
        status:
          type: object
          allOf:
            - $ref: '#/components/schemas/AsyncActionStatus'
          description: Status of an async action.
        requestBody:
          type: string
          description: Content of a request body of the operation that initiated an async action.
          nullable: true
        queryParameters:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Key-value map containing query parameters of the operation that initiated an async action.
    AsyncActionStatus:
      enum:
        - running
        - succeed
        - canceled
        - failed
      type: string
      x-ms-enum:
        name: AsyncActionStatus
    AsyncActionsConfig:
      required:
        - resultRetentionTime
      type: object
      properties:
        resultRetentionTime:
          type: integer
          description: 'Amount of time an async action result is retained, in seconds.'
          format: int32
    AsyncActionRequestData:
      type: object
      properties:
        requestBody:
          maxLength: 2000000
          type: string
          description: Content of a request body of the operation that initiated an async action.
          nullable: true
        queryParameters:
          type: object
          additionalProperties:
            type: array
            items:
              maxLength: 100000
              type: string
          description: Key-value map containing query parameters of the operation that initiated an async action.
          nullable: true
    JsonPatches:
      type: array
      items:
        $ref: '#/components/schemas/JsonPatch'
    JsonPatch:
      required:
        - op
        - value
        - path
      type: object
      properties:
        op:
          enum:
            - add
            - replace
            - test
            - remove
            - move
            - copy
          type: string
          description: Performed operation.
        value:
          type: string
          description: 'Value that is added, replaced, tested or removed by the PATCH operation.'
        from:
          type: string
          description: JSON Pointer containing path to a location from which data is moved or copied.
          nullable: true
        path:
          type: string
          description: JSON Pointer containing path to a target location where the PATCH operation is performed.
      externalDocs:
        description: Link to RFC 6902.
        url: https://tools.ietf.org/html/rfc6902
    Alarm:
      required:
        - name
        - isEnabled
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to an alarm template.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of an alarm template.
        category:
          enum:
            - Unknown
            - ManagementAgent
            - Location
            - Company
            - User
            - Internal
            - BackupAgent
            - VmFailoverPlan
            - BackupServer
            - EnterpriseManager
            - BackupProxy
            - BackupRepository
            - BackupVmJob
            - BackupServerAgentJob
            - BackupWanAccelerator
            - BackupCloudGateway
            - BackupLicense
            - BackupTenantRepository
            - SureBackupJob
            - BackupAgentJob
            - DiscoveryRule
            - Integrator
            - Site
            - Reseller
            - ResellerCloudRepository
            - BackupMicrosoft365Server
            - OneServer
            - BackupAppliance
          type: string
          description: Category of an alarm template.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: AlarmCategoryType
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        internalId:
          type: integer
          description: ID assigned to an alarm template in Veeam Service Provider Console internal alarm database.
          format: int32
          readOnly: true
        knowledge:
          $ref: '#/components/schemas/AlarmKnowledge'
        isPredifined:
          type: boolean
          description: Indicates whether an alarm template is predefined.
          readOnly: true
        isEnabled:
          type: boolean
          description: ' Indicates whether an alarm template is enabled.'
      example:
        instanceUid: fcdb7145-3634-4d34-99fd-138879cd9c2c
        name: Job state
        category: BackupVmJob
        organizationUid: 39f65b4c-a7d2-451e-936d-aeae418b53e1
        internalId: 1
        knowledge:
          summary: Job is in a disabled state for more than an allowed time period.
          cause: 'Veeam Backup & Replication server allows to disable scheduled backup jobs during maintenance windows. If backup job stays in a disabled state for more than an allowed time period, it should be enabled back.'
          resolution: Open Veeam Backup & Replication console and enable all disabled backup jobs.
        isPredifined: true
        isEnabled: false
    AlarmKnowledge:
      type: object
      properties:
        summary:
          type: string
          description: General description of an alarm template.
          readOnly: true
        cause:
          type: string
          description: Possible causes of an alarm trigger.
          readOnly: true
        resolution:
          type: string
          description: Recommended solutions.
          readOnly: true
      description: Knowledge base for an alarm template.
      readOnly: true
    ActiveAlarm:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a triggered alarm.
          format: uuid
          readOnly: true
        alarmTemplateUid:
          type: string
          description: UID assigned to an alarm template.
          format: uuid
          readOnly: true
        repeatCount:
          type: integer
          description: Number of times that an alarm changed its status.
          format: int32
          readOnly: true
        object:
          type: object
          allOf:
            - $ref: '#/components/schemas/AlarmObject'
          description: Alarm object.
          readOnly: true
        lastActivation:
          type: object
          allOf:
            - $ref: '#/components/schemas/AlarmActivation'
          description: Latest alarm activation.
          readOnly: true
        area:
          enum:
            - vspc
            - vone
          type: string
          description: Alarm area.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: AlarmArea
      example:
        instanceUid: 08b46982-1160-4804-bb12-6227b521972e
        alarmTemplateUid: 5cf175f4-d596-4636-bf8e-f166516418df
        repeatCount: 3
        object:
          instanceUid: baf8d020-fb95-41ba-be4f-89b44dca4fcd
          type: ObjectEntity
          companyUid: 39f65b4c-a7d2-451e-936d-aeae418b53e1
          locationUid: 5523b04d-077b-4526-a219-4533d6f23987
          managementAgentUid: d4b32a13-0b1b-4e7f-9050-309fa0eb7055
          computerName: ws-5floor
          objectName: Premium repository
        lastActivation:
          instanceUid: 86477f51-389e-49bb-9480-25dc9abc71d2
          time: '2020-01-12T23:20:50.5200000+00:00'
          status: Error
          message: "Free space (2.55%, 1.01 GB) is below the defined threshold (5%).\r\n"
          remark: "\r\n"
    AlarmObject:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to an object for which an alarm was triggered.
          format: uuid
          readOnly: true
        type:
          enum:
            - Unknown
            - ManagementAgent
            - Location
            - Company
            - User
            - Internal
            - ObjectEntity
            - DiscoveryRule
            - Integrator
            - Reseller
            - Site
            - ResellerCloudRepository
            - BackupAgent
            - FailoverPlan
            - BackupServer
            - BackupServerJob
            - EnterpriseManagerServer
            - BackupProxy
            - BackupRepository
            - BackupWanAccelerator
            - CloudGateway
            - CloudRepository
            - VOneServer
            - BackupMicrosoft365Server
            - VbAppliance
          type: string
          description: Object type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: AlarmObjectType
        organizationUid:
          type: string
          description: UID assigned to a organization for which an alarm was triggered.
          format: uuid
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a location for which an alarm was triggered.
          format: uuid
          nullable: true
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a managed agent that is installed on an alarm object.
          format: uuid
          nullable: true
          readOnly: true
        computerName:
          type: string
          description: Name of a computer for which an alarm was triggered.
          readOnly: true
        objectUid:
          type: string
          description: UID assigned to an alarm object.
          format: uuid
          nullable: true
          readOnly: true
        objectName:
          type: string
          description: Name of an alarm object.
          nullable: true
          readOnly: true
    AlarmActivation:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to an alarm trigger.
          format: uuid
          readOnly: true
        time:
          type: string
          description: Date and time of an alarm trigger.
          format: date-time
          readOnly: true
        status:
          enum:
            - Unknown
            - Resolved
            - Info
            - Warning
            - Error
            - Acknowledged
          type: string
          description: Alarm status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: AlarmStatus
        message:
          type: string
          description: "Cause of an alarm trigger.\n> Every line break is represented by the `\\r\\n` control characters.\n"
          nullable: true
          readOnly: true
        remark:
          type: string
          description: "Comment to the resolved alarm.\n> Every line break is represented by the `\\r\\n` control characters.\n"
          nullable: true
          readOnly: true
    WelcomeEmailOptions:
      required:
        - password
      type: object
      properties:
        password:
          maxLength: 128
          minLength: 1
          type: string
          description: Password for created account.
          format: password
          nullable: true
    Reseller:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        proPartnerId:
          type: string
          description: ProPartner Portal ID assigned to a reseller.
          nullable: true
        name:
          type: string
          description: "Name of a reseller.\n> Can be changed using the `PatchOrganization` operation.\n"
          readOnly: true
        status:
          enum:
            - Unknown
            - Active
            - Disabled
          type: string
          description: Reseller status.
          default: Active
          x-extensible-enum: true
          x-ms-enum:
            name: ResellerStatus
        isRestAccessEnabled:
          type: boolean
          description: Indicates whether access to REST API is enabled for a reseller.
          default: false
        resellerServices:
          type: object
          allOf:
            - $ref: '#/components/schemas/ResellerServices'
          description: Services available to a reseller.
          x-veeam-create-by-default: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForOrganizationChildren'
      description: ''
    ResellerLicenseResource:
      type: object
      properties:
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        pulseConfigurationStatus:
          enum:
            - Unknown
            - NotConfigured
            - Configured
            - Warning
            - Error
          type: string
          description: Status of VCSP Pulse configuration.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: PulseConfigurationStatus
        pulseConfigurationStatusMessage:
          type: string
          description: Status message.
          readOnly: true
        pulseAutoConnectWithProviderToken:
          type: boolean
          description: Indicates whether reseller is forced to connect to VCSP Pulse using a provider token.
          default: false
        isLicenseManagementEnabled:
          type: boolean
          description: Indicates whether license management is enabled for a reseller.
          default: false
        licenseContractId:
          type: string
          description: ID assigned to a license rental agreement contract.
          nullable: true
        licensePointsQuota:
          maximum: 99999
          minimum: 0
          type: integer
          description: Number of license points available to a reseller.
          format: int32
          nullable: true
        isLicensePointsQuotaUnlimited:
          type: boolean
          description: Indicates whether a reseller can use an unlimited number of license points.
          default: true
        licensePointsUsage:
          type: number
          description: Number of license points used by a reseller.
          format: double
          readOnly: true
        isCreatingNewCompaniesToPulseEnabled:
          type: boolean
          description: Indicates whether a reseller can add new companies to VCSP Pulse.
          readOnly: true
      description: ''
    ResellerSiteResource:
      required:
        - siteUid
      type: object
      properties:
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: "UID assigned to a Veeam Cloud Connect site.\n> The property value cannot be changed after creation.\n"
          format: uuid
        tenantsQuota:
          maximum: 99999
          minimum: 1
          type: integer
          description: Maximum number of tenants that a reseller can manage on a Veeam Cloud Connect site.
          format: int32
          default: 20
          nullable: true
        usedTenantsQuota:
          type: integer
          description: Number of tenants that a reseller manages on a Veeam Cloud Connect site.
          format: int32
          readOnly: true
        isTenantsQuotaUnlimited:
          type: boolean
          description: Indicates whether a reseller can manage an unlimited number of tenants.
          default: false
    ResellerSiteBackupResource:
      required:
        - resourceFriendlyName
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud backup resource.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a cloud backup repository.
          format: uuid
          readOnly: true
        resourceFriendlyName:
          type: string
          description: Cloud repository friendly name configured for a reseller.
        storageQuota:
          maximum: 1124774006935781400
          minimum: 1073741824
          type: integer
          description: 'Amount of space allocated to a reseller, in bytes.'
          format: int64
          nullable: true
        isStorageQuotaUnlimited:
          type: boolean
          description: Indicates whether the amount of space allocated to a reseller is unlimited.
          default: true
        serversQuota:
          type: integer
          description: Number of servers that a reseller can store on a cloud backup repository.
          format: int32
          nullable: true
        isServersQuotaUnlimited:
          type: boolean
          description: Indicates whether the number of servers that a reseller can store on a cloud backup repository is unlimited.
          default: true
        workstationsQuota:
          type: integer
          description: Number of workstations that a reseller can store on a cloud backup repository.
          format: int32
          nullable: true
        isWorkstationsQuotaUnlimited:
          type: boolean
          description: Indicates whether the number of workstations that a reseller can store on a cloud backup repository is unlimited.
          default: true
        vmsQuota:
          type: integer
          description: Number of VMs that a reseller can store on a cloud backup repository.
          format: int32
          nullable: true
        isVmsQuotaUnlimited:
          type: boolean
          description: Indicates whether the number of VMs that a reseller can store on a cloud backup repository is unlimited.
          default: true
      description: ''
    ResellerSiteBackupResourceInput:
      required:
        - repositoryUid
        - resourceFriendlyName
      type: object
      properties:
        repositoryUid:
          type: string
          description: UID assigned to a cloud backup repository.
          format: uuid
        resourceFriendlyName:
          type: string
          description: Cloud repository friendly name configured for a reseller.
        storageQuota:
          maximum: 1124774006935781400
          minimum: 1073741824
          type: integer
          description: 'Amount of space allocated to a reseller, in bytes.'
          format: int64
          nullable: true
        isStorageQuotaUnlimited:
          type: boolean
          description: Indicates whether the amount of space allocated to a reseller is unlimited.
          default: true
        serversQuota:
          type: integer
          description: Number of servers that a reseller can store on a cloud backup repository.
          format: int32
          nullable: true
        isServersQuotaUnlimited:
          type: boolean
          description: Indicates whether the number of servers that a reseller can store on a cloud backup repository is unlimited.
          default: true
        workstationsQuota:
          type: integer
          description: Number of workstations that a reseller can store on a cloud backup repository.
          format: int32
          nullable: true
        isWorkstationsQuotaUnlimited:
          type: boolean
          description: Indicates whether the number of workstations that a reseller can store on a cloud backup repository is unlimited.
          default: true
        vmsQuota:
          type: integer
          description: Number of VMs that a reseller can store on a cloud backup repository.
          format: int32
          nullable: true
        isVmsQuotaUnlimited:
          type: boolean
          description: Indicates whether the number of VMs that a reseller can store on a cloud backup repository is unlimited.
          default: true
      description: ''
    ResellerSiteWanAcceleratorResource:
      required:
        - wanAcceleratorUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud backup resource.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a site.
          format: uuid
          readOnly: true
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        wanAcceleratorUid:
          type: string
          description: UID assigned to a cloud backup repository.
          format: uuid
      description: ''
    ResellerSiteWanAcceleratorResourceInput:
      required:
        - wanAcceleratorUid
      type: object
      properties:
        wanAcceleratorUid:
          type: string
          description: UID assigned to a cloud backup repository.
          format: uuid
      description: ''
    ResellerSiteBackupResourceUsage:
      type: object
      properties:
        backupResourceUid:
          type: string
          description: UID assigned to a cloud backup resource.
          format: uuid
          readOnly: true
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        storageQuota:
          type: integer
          description: 'Amount of space allocated to a reseller, in bytes.'
          format: int64
          readOnly: true
        usedStorageQuota:
          type: integer
          description: 'Amount of space consumed by all companies of a reseller, in bytes.'
          format: int64
          readOnly: true
        archiveTierUsage:
          type: integer
          description: 'Amount of archive tier space consumed by all companies of a reseller, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        capacityTierUsage:
          type: integer
          description: 'Amount of capacity tier space consumed by all company backups excluding backup copies, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        performanceTierUsage:
          type: integer
          description: 'Amount of performance tier space consumed by all companies of a reseller, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        serverBackups:
          type: integer
          description: Number of server backups that a reseller stores on a cloud repository.
          format: int32
          readOnly: true
        workstationBackups:
          type: integer
          description: Number of workstation backups that a reseller stores on a cloud repository.
          format: int32
          readOnly: true
        vmBackups:
          type: integer
          description: Number of VM backups that a reseller stores on a cloud repository.
          format: int32
          readOnly: true
    ResellerSiteReplicationResource:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud replication resource.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        hardwarePlanUid:
          type: string
          description: UID assigned to a hardware plan.
          format: uuid
          readOnly: true
        tenantsPerPlanQuota:
          minimum: 1
          type: integer
          description: Maximum number of companies that a reseller can subscribe to a hardware plan.
          format: int32
          nullable: true
        isWanAccelerationEnabled:
          type: boolean
          description: Indicates whether WAN acceleration is enabled.
          default: false
        wanAcceleratorUid:
          type: string
          description: UID assigned to a WAN accelerator.
          format: uuid
          nullable: true
      description: ''
    ResellerSiteReplicationResourceInput:
      required:
        - hardwarePlanUid
      type: object
      properties:
        hardwarePlanUid:
          type: string
          description: UID assigned to a hardware plan.
          format: uuid
        tenantsPerPlanQuota:
          minimum: 1
          type: integer
          description: Maximum number of companies that a reseller can subscribe to a hardware plan.
          format: int32
          nullable: true
        isWanAccelerationEnabled:
          type: boolean
          description: Indicates whether WAN acceleration is enabled.
          default: false
        wanAcceleratorUid:
          type: string
          description: UID assigned to a WAN accelerator.
          format: uuid
          nullable: true
      description: ''
    ResellerSiteReplicationResourceUsage:
      type: object
      properties:
        replicationResourceUid:
          type: string
          description: UID assigned to a cloud replication resource.
          format: uuid
          readOnly: true
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        hardwarePlanUid:
          type: string
          description: UID assigned to a hardware plan.
          format: uuid
          readOnly: true
        tenantsPerPlanUsage:
          type: integer
          description: Number of companies that are subscribe to a hardware plan.
          format: int32
          readOnly: true
    ResellerSiteVcdReplicationResource:
      required:
        - vcdOrganizationUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a reseller VMware Cloud Director replication resource.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        vcdOrganizationUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization whose resources are allocated to a reseller.
          format: uuid
    ResellerVb365Resource:
      required:
        - vb365ServerUid
        - resellerUid
        - friendlyName
        - vb365Repositories
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 resource.
          format: uuid
          readOnly: true
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          readOnly: true
        friendlyName:
          maxLength: 256
          minLength: 1
          type: string
          description: Friendly name of a Veeam Backup for Microsoft 365 resource.
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        vb365Repositories:
          type: array
          items:
            $ref: '#/components/schemas/ResellerVb365RepositoryResource'
          description: Array of Veeam Backup for Microsoft 365 backup repositories.
          x-veeam-empty-array-by-default: true
    ResellerVb365ResourceInput:
      required:
        - vb365ServerUid
        - friendlyName
        - vb365Repositories
      type: object
      properties:
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 resource.
          format: uuid
        friendlyName:
          maxLength: 256
          minLength: 1
          type: string
          description: Friendly name of a Veeam Backup for Microsoft 365 resource.
        vb365RepositoriesUids:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to Veeam Backup for Microsoft 365 backup repositories.
          x-veeam-empty-array-by-default: true
    ResellerVb365RepositoryResource:
      required:
        - instanceUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 backup repository.
          format: uuid
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        vb365ResourceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 resource.
          format: uuid
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
          readOnly: true
        proxyUid:
          type: string
          description: UID assigned to a backup proxy.
          format: uuid
          nullable: true
        proxyPoolUid:
          type: string
          description: UID assigned to a backup proxy pool.
          format: uuid
          nullable: true
        storageQuota:
          maximum: 1124774006935781400
          minimum: 1073741824
          type: integer
          description: 'Amount of allocated storage space, in bytes.'
          format: int64
          nullable: true
        isStorageQuotaUnlimited:
          type: boolean
          description: Indicates whether a storage quota is unlimited.
          default: false
          readOnly: true
    ResellerVbrResource:
      required:
        - vbrServerUid
        - resellerUid
        - friendlyName
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server resource.
          format: uuid
          readOnly: true
        vbrServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server server.
          format: uuid
          readOnly: true
        friendlyName:
          maxLength: 256
          minLength: 1
          type: string
          description: Friendly name of a Veeam Backup & Replication server resource.
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
    ResellerVbrResourceInput:
      required:
        - vbrServerUid
        - friendlyName
        - vbrRepositories
      type: object
      properties:
        vbrServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server resource.
          format: uuid
        friendlyName:
          maxLength: 256
          minLength: 1
          type: string
          description: Friendly name of a Veeam Backup & Replication server resource.
    ResellerSiteVcdReplicationResourceInput:
      required:
        - vcdOrganizationUid
      type: object
      properties:
        vcdOrganizationUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization whose resources are allocated to a reseller.
          format: uuid
    ResellerInput:
      required:
        - organizationInput
        - ownerCredentials
      type: object
      properties:
        description:
          type: string
          description: Description of a reseller.
          nullable: true
        proPartnerId:
          type: string
          description: ProPartner Portal ID assigned to a reseller.
          nullable: true
        organizationInput:
          type: object
          allOf:
            - $ref: '#/components/schemas/OrganizationInput'
          description: Reseller organization settings.
        resellerServices:
          type: object
          allOf:
            - $ref: '#/components/schemas/ResellerServices'
          description: Services available to a reseller.
          x-veeam-create-by-default: true
        ownerCredentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/OwnerCredentials'
          description: User credentials configured for Service Provider Global Administrator.
        isRestAccessEnabled:
          type: boolean
          description: Defines whether access to REST API is enabled for a reseller.
          default: false
    ResellerServices:
      type: object
      properties:
        hostedServices:
          type: object
          allOf:
            - $ref: '#/components/schemas/ResellerHostedServices'
          description: Remote services that a reseller can provide to managed companies.
          x-veeam-create-by-default: true
        remoteServices:
          type: object
          allOf:
            - $ref: '#/components/schemas/ResellerRemoteServices'
          description: Remote client services that a reseller can manage.
          x-veeam-create-by-default: true
        cloudConnectQuota:
          $ref: '#/components/schemas/ResellerCloudConnectQuota'
        cloudConnectManagementEnabled:
          type: boolean
          description: "Indicates whether Veeam Cloud Connect resources are available to a reseller.\n"
          default: false
        isFileLevelRestoreEnabled:
          type: boolean
          description: Indicates whether file-level restore is available to reseller companies.
          default: false
    ResellerHostedServices:
      type: object
      properties:
        backupResourcesEnabled:
          type: boolean
          description: "Indicates whether reseller companies can create jobs on a hosted Veeam Backup & Replication server.\n"
          default: false
        vb365ManagementEnabled:
          type: boolean
          description: "Indicates whether reseller companies can use Microsoft 365 resources.\n"
          default: false
        vbPublicCloudManagementEnabled:
          type: boolean
          description: Indicates whether integration with Veeam Backup for Public Clouds is available to a reseller.
          default: false
    ResellerCloudConnectQuota:
      type: object
      properties:
        dataTransferOutQuota:
          maximum: 1073740750258176
          minimum: 1073741824
          type: integer
          description: "Maximum amount of data transfer out traffic available to a reseller, in bytes.\n> If quota is unlimited, the property value is `null`.\n"
          format: int64
          nullable: true
        insiderProtectionQuota:
          maximum: 99
          type: integer
          description: "Number of days during which deleted backup files of reseller clients must be kept in the recycle bin by the service provider.\n> If quota is unlimited, the property value is `null`.\n"
          format: int32
          default: 1
          nullable: true
        throttlingValue:
          maximum: 9999
          minimum: 1
          type: integer
          description: "Maximum amount of incoming network traffic accepted from reseller clients.\n> If throttling is disabled, the property value is `null`.\n"
          format: int32
          default: 1
          nullable: true
        throttlingUnit:
          enum:
            - MbitPerSec
            - KbytePerSec
            - MbytePerSec
          type: string
          description: Measurement units of the amount of incoming network traffic accepted from reseller clients.
          default: MbytePerSec
          nullable: true
          x-ms-enum:
            name: SpeedUnit
        maxConcurrentTask:
          maximum: 10000
          minimum: 1
          type: integer
          description: "Maximum number of concurrent tasks that reseller clients can perform.\n> If concurrent tasks count is unlimited, the property value is `null`.\n"
          format: int32
          default: 1
          nullable: true
        isWanAccelerationEnabled:
          type: boolean
          description: Indicates whether WAN acceleration is enabled for replication jobs of reseller clients.
          default: false
      description: "Veeam Cloud Connect resources provided to a reseller.\n> If you do not provide the `null` value for this property during reseller creation, you will not be able to change it to `null`.\n"
      nullable: true
    ResellerRemoteServices:
      type: object
      properties:
        backupAgentsManagement:
          type: object
          allOf:
            - $ref: '#/components/schemas/ResellerBackupAgentsManagement'
          description: Indicates whether a reseller is allowed to manage Veeam backup agents.
          x-veeam-create-by-default: true
        vb365ManagementEnabled:
          type: boolean
          description: "Indicates whether a reseller is allowed to manage remote Microsoft 365 servers.\n"
          default: false
        backupServersManagementEnabled:
          type: boolean
          description: "Indicates whether a reseller is allowed to manage remote Veaam Backup & Replication servers.\n"
          default: false
        vbPublicCloudManagementEnabled:
          type: boolean
          description: Indicates whether a reseller is alowed to manage remote public cloud appliances.
          default: false
    ResellerBackupAgentsManagement:
      type: object
      properties:
        workstationAgentsQuota:
          maximum: 99999
          minimum: 0
          type: integer
          description: "Maximum number of Veeam backup agents in the Workstation mode that a reseller is allowed to manage.\n> The `null` value indicates that the number is unlimited.\n"
          format: int32
          nullable: true
        serverAgentsQuota:
          maximum: 99999
          minimum: 0
          type: integer
          description: "Maximum number of Veeam backup agents in the Server mode that a reseller is allowed to manage.\n> The `null` value indicates that the number is unlimited.\n"
          format: int32
          nullable: true
      x-veeam-create-by-default: true
    Provider:
      required:
        - instanceUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a service provider.
          format: uuid
        _embedded:
          $ref: '#/components/schemas/EmbeddedForOrganizationChildren'
    Company:
      required:
        - ownerCredentials
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          readOnly: true
        name:
          type: string
          description: "Name of a company.\n> Can be changed using the `PatchOrganization` operation.\n"
          readOnly: true
        status:
          enum:
            - Unknown
            - Active
            - Disabled
            - REMOVED_Expired
            - REMOVED_Creating
            - REMOVED_Deleting
            - REMOVED_Deleted
            - REMOVED_SiteResourceCreationFailed
            - REMOVED_SiteResourceCreating
            - REMOVED_SiteResourceUpdating
            - REMOVED_SiteResourceUpdateFailed
          type: string
          description: Status of a service provider. You can set the `Active` or `Disabled` value using the PATCH method.
          default: Active
          x-extensible-enum: true
          x-ms-enum:
            name: CompanyStatus
        resellerUid:
          type: string
          description: UID assigned to a reseller that manages the company.
          format: uuid
          nullable: true
        subscriptionPlanUid:
          type: string
          description: UID assigned to a company subscription plan.
          format: uuid
          nullable: true
        isRestAccessEnabled:
          type: boolean
          description: Indicates whether access to REST API is enabled for a company.
          default: false
        isAlarmDetectEnabled:
          type: boolean
          description: Indicates whether a company must receive notifications about alarms that were triggered for this company.
          default: false
        companyServices:
          type: object
          allOf:
            - $ref: '#/components/schemas/CompanyServices'
          description: Components available to a company.
          x-veeam-create-by-default: true
        loginUrl:
          type: string
          description: "Company portal URL.\n> Can be configured by performing the `ReplaceCompanyLoginUrl` operation.'\n"
          nullable: true
          readOnly: true
        ownerCredentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/OwnerCredentials'
          description: Company owner credentials.
        _embedded:
          $ref: '#/components/schemas/EmbeddedForOrganizationChildren'
    EmbeddedForOrganizationChildren:
      type: object
      properties:
        organization:
          type: object
          allOf:
            - $ref: '#/components/schemas/Organization'
          description: Resource representation of an organization.
          nullable: true
          readOnly: true
      description: Resource representation of the related organization entity.
      nullable: true
      readOnly: true
    CompanyInput:
      required:
        - organizationInput
        - ownerCredentials
      type: object
      properties:
        resellerUid:
          type: string
          description: UID assigned to a reseller that manages the company.
          format: uuid
          nullable: true
        organizationInput:
          type: object
          allOf:
            - $ref: '#/components/schemas/OrganizationInput'
          description: Company properties.
        subscriptionPlanUid:
          type: string
          description: UID assigned to a company subscription plan.
          format: uuid
          nullable: true
        isRestAccessEnabled:
          type: boolean
          description: Defines whether access to REST API is enabled for a reseller.
          default: false
        isAlarmDetectEnabled:
          type: boolean
          description: Defines whether a company must receive notifications about alarms that were triggered for this company.
          default: false
        companyServices:
          type: object
          allOf:
            - $ref: '#/components/schemas/CompanyServices'
          description: Services available to a company.
          x-veeam-create-by-default: true
        ownerCredentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/OwnerCredentials'
          description: Company owner credentials.
    CompanyServices:
      type: object
      properties:
        hostedServices:
          type: object
          allOf:
            - $ref: '#/components/schemas/CompanyHostedServices'
          description: Hosted services provided to a company.
          nullable: true
          x-veeam-create-by-default: true
        remoteServices:
          type: object
          allOf:
            - $ref: '#/components/schemas/CompanyRemoteServices'
          description: Remote services that a company is allowed to manage.
          nullable: true
          x-veeam-create-by-default: true
    CompanyHostedServices:
      type: object
      properties:
        isVbPublicCloudManagementEnabled:
          type: boolean
          description: Indicates whether a company is allowed to manage public cloud appliances.
          default: false
    CompanyRemoteServices:
      type: object
      properties:
        isBackupResourcesEnabled:
          type: boolean
          description: Indicates whether cloud backup resources are allocated to a company.
          default: true
        backupAgentsManagement:
          $ref: '#/components/schemas/CompanyBackupAgentsManagement'
        backupServersManagement:
          $ref: '#/components/schemas/CompanyBackupServerManagement'
        vb365ServersManagement:
          $ref: '#/components/schemas/CompanyVb365ServerManagement'
        isVbPublicCloudManagementEnabled:
          type: boolean
          description: Indicates whether a company is allowed to manage public cloud appliances.'
          default: false
    CompanyBackupAgentsManagement:
      type: object
      properties:
        workstationAgentsQuota:
          maximum: 99999
          minimum: 0
          type: integer
          description: "Maximum number of Veeam backup agents in the Workstation mode that a company is allowed to manage.\n> The `null` value indicates that the number is unlimited.\n"
          format: int32
          nullable: true
        serverAgentsQuota:
          maximum: 99999
          minimum: 0
          type: integer
          description: "Maximum number of Veeam backup agents in the Server mode that a company is allowed to manage.\n> The `null` value indicates that the number is unlimited.\n"
          format: int32
          nullable: true
      description: Number of Veeam backup agents that a company is allowed to manage.
      nullable: true
    CompanyBackupServerManagement:
      type: object
      properties:
        backupServerQuota:
          minimum: 1
          type: integer
          description: "Number of Veeam Backup & Replication servers that a company is allowed to manage.\n> The `null` value indicates that the amount is unlimited.\n"
          format: int32
          nullable: true
      description: Managed Veeam Backup & Replication server quota.
      nullable: true
    CompanyVb365ServerManagement:
      type: object
      properties:
        backupServerQuota:
          minimum: 1
          type: integer
          description: "Number of Veeam Backup for Microsoft 365 servers that a company is allowed to manage.\n> The `null` value indicates that the amount is unlimited.\n"
          format: int32
          nullable: true
      description: Managed Veeam Backup for Microsoft 365 server quota.
      nullable: true
    OrganizationLoginUrlAndSuggestion:
      type: object
      properties:
        loginUrl:
          maxLength: 256
          pattern: '^(http|https):\/\/[\w\d\-._~:/?#$&''()*+,;=]+$'
          type: string
          description: "Current portal URL of a company.\n> Has the `null` value if the URL is not configured.\n"
          nullable: true
        loginUrlIsInherited:
          type: boolean
          description: Indicates whether an portal URL is inherited from the manager organization.
          readOnly: true
        loginUrlSuggestion:
          type: string
          description: "Suggested portal URL based on the organization alias and the current request URL.\n> Has the `null` value if the URL is already configured.\n"
          nullable: true
          readOnly: true
    TenantTrafficResource:
      type: object
      properties:
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID of a company to which a tenant is assigned. Has the `null` value if no tenant is assigned.
          format: uuid
          nullable: true
          readOnly: true
        dataTransferOutQuota:
          maximum: 999424
          minimum: 1
          type: integer
          description: "Maximum amount of data transfer out traffic available to a tenant, in GB.\n> Minimum value is equal to 1 GB. <br>\n> Maximum value is equal to 976 TB. <br>\n> If quota is unlimited, the property value is `null`.'\n"
          format: int64
          nullable: true
        isDataTransferOutQuotaUnlimited:
          type: boolean
          description: Indicates whether the amount of data transfer out traffic available to a company is unlimited.
          default: true
    TenantBackupResource:
      required:
        - cloudRepositoryName
        - storageQuota
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a site backup resource allocated to a company.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          nullable: true
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a cloud repository.
          format: uuid
          readOnly: true
        cloudRepositoryName:
          type: string
          description: Name of a cloud backup repository.
        storageQuota:
          maximum: 1124774006935781400
          minimum: 1073741824
          type: integer
          description: 'Amount of space allocated to a company on a cloud repository, in bytes.'
          format: int64
        usedSpace:
          type: integer
          description: 'Amount of used space on a cloud repository, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        serversQuota:
          type: integer
          description: Maximum number of Veeam backup agents in the Server mode that a company is allowed to store on a cloud repository.
          format: int32
          nullable: true
        isServersQuotaUnlimited:
          type: boolean
          description: Indicates whether a company is allowed to store an unlimited number of Veeam backup agents in the Server mode on a cloud repository.
          default: true
        workstationsQuota:
          type: integer
          description: Maximum number of Veeam backup agents in the Workstation mode that a company is allowed to store on a cloud repository.
          format: int32
          nullable: true
        isWorkstationsQuotaUnlimited:
          type: boolean
          description: Indicates whether a company is allowed to store an unlimited number of Veeam backup agents in the Workstation mode on a cloud repository.
          default: true
        vmsQuota:
          type: integer
          description: Maximum number of VMs that a company is allowed to store on a cloud repository.
          format: int32
          nullable: true
        isVmsQuotaUnlimited:
          type: boolean
          description: Indicates whether a company is allowed to store an unlimited number of VMs on a cloud repository.
          default: true
        isWanAccelerationEnabled:
          type: boolean
          description: Indicates whether WAN acceleration is enabled.
          default: false
        wanAcceleratorUid:
          type: string
          description: UID assigned to a WAN accelerator.
          format: uuid
          nullable: true
        isDefault:
          type: boolean
          description: Indicates whether the repository is used by default.
          default: false
    TenantBackupResourceInput:
      required:
        - repositoryUid
        - cloudRepositoryName
        - storageQuota
      type: object
      properties:
        repositoryUid:
          type: string
          description: UID assigned to a cloud repository.
          format: uuid
        cloudRepositoryName:
          type: string
          description: Name of a cloud backup repository.
        storageQuota:
          maximum: 1124774006935781400
          minimum: 1073741824
          type: integer
          description: 'Amount of space allocated to a company on a cloud repository, in bytes.'
          format: int64
        serversQuota:
          type: integer
          description: Maximum number of Veeam backup agents in the Server mode that a company is allowed to store on a cloud repository.
          format: int32
          nullable: true
        isServersQuotaUnlimited:
          type: boolean
          description: Indicates whether a company is allowed to store an unlimited number of Veeam backup agents in the Server mode on a cloud repository.
          default: true
        workstationsQuota:
          type: integer
          description: Maximum number of Veeam backup agents in the Workstation mode that a company is allowed to store on a cloud repository.
          format: int32
          nullable: true
        isWorkstationsQuotaUnlimited:
          type: boolean
          description: Indicates whether a company is allowed to store an unlimited number of Veeam backup agents in the Workstation mode on a cloud repository.
          default: true
        vmsQuota:
          type: integer
          description: Maximum number of VMs that a company is allowed to store on a cloud repository.
          format: int32
          nullable: true
        isVmsQuotaUnlimited:
          type: boolean
          description: Indicates whether a company is allowed to store an unlimited number of VMs on a cloud repository.
          default: true
        isWanAccelerationEnabled:
          type: boolean
          description: Indicates whether WAN acceleration is enabled.
          default: false
        wanAcceleratorUid:
          type: string
          description: UID assigned to a WAN accelerator.
          format: uuid
          nullable: true
        isDefault:
          type: boolean
          description: Defines whether a cloud repository is set by default.
          default: false
      description: ''
    TenantBackupResourceUsage:
      type: object
      properties:
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          nullable: true
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant.
          format: uuid
          readOnly: true
        backupResourceUid:
          type: string
          description: UID assigned to a cloud backup resource.
          format: uuid
          readOnly: true
        storageQuota:
          type: integer
          description: 'Amount of space allocated to a company, in bytes.'
          format: int64
          readOnly: true
        usedStorageQuota:
          type: integer
          description: 'Amount of space consumed by a company, in bytes.'
          format: int64
          readOnly: true
        archiveTierUsage:
          type: integer
          description: 'Amount of archive tier space consumed by a company, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        capacityTierUsage:
          type: integer
          description: 'Amount of capacity tier space consumed by all company backups excluding backup copies, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        performanceTierUsage:
          type: integer
          description: 'Amount of performance tier space consumed by a company, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        serverBackups:
          type: integer
          description: Number of server backups that a company stores on a cloud repository.
          format: int32
          readOnly: true
        workstationBackups:
          type: integer
          description: Number of workstation backups that a company stores on a cloud repository.
          format: int32
          readOnly: true
        vmBackups:
          type: integer
          description: Number of VM backups that a company stores on a cloud repository.
          format: int32
          readOnly: true
    TenantReplicationResourceInput:
      type: object
      properties:
        hardwarePlans:
          type: array
          items:
            $ref: '#/components/schemas/TenantReplicationResourceHardwarePlan'
          description: Array of hardware plans.
          x-veeam-empty-array-by-default: true
        isFailoverCapabilitiesEnabled:
          type: boolean
          description: Indicates whether performing failover is available to a company.
          default: false
        isPublicAllocationEnabled:
          type: boolean
          description: Indicates whether public IP addresses are allocated to a company.
          default: false
          nullable: true
        numberOfPublicIps:
          minimum: 0
          type: integer
          description: Number of allocated public IP addresses.
          format: int32
          default: 0
          nullable: true
    TenantReplicationResourceHardwarePlan:
      required:
        - hardwarePlanUid
      type: object
      properties:
        hardwarePlanUid:
          type: string
          description: UID assigned to a hardware plan.
          format: uuid
        isWanAccelerationEnabled:
          type: boolean
          description: Indicates whether WAN acceleration is enabled.
          default: false
        wanAcceleratorUid:
          type: string
          description: UID assigned to a WAN accelerator.
          format: uuid
          nullable: true
    TenantReplicationResource:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud replication resource.
          format: uuid
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          nullable: true
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        hardwarePlans:
          type: array
          items:
            $ref: '#/components/schemas/TenantReplicationResourceHardwarePlan'
          description: Array of hardware plans.
          x-veeam-empty-array-by-default: true
        isFailoverCapabilitiesEnabled:
          type: boolean
          description: Indicates whether performing failover is available to a company.
          default: false
        isPublicAllocationEnabled:
          type: boolean
          description: Indicates whether public IP addresses are allocated to a company.
          default: false
        numberOfPublicIps:
          type: integer
          description: Number of allocated public IP addresses.
          format: int32
          default: 0
    TenantReplicationResourceUsage:
      type: object
      properties:
        hardwarePlanUid:
          type: string
          description: UID assigned to a hardware plan.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          nullable: true
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect server on which a management agent is installed.
          format: uuid
          readOnly: true
        vCPUsConsumed:
          type: integer
          description: Number of replicated VMs vCPUs.
          format: int32
          readOnly: true
        memoryUsage:
          type: integer
          description: 'Amount of RAM consumed by company replicas, in bytes.'
          format: int64
          readOnly: true
        storageUsage:
          type: integer
          description: 'Amount of cloud storage space consumed by company replicas, in bytes.'
          format: int64
          readOnly: true
        hostsCoresCount:
          type: integer
          description: Number of physical cores in cloud hosts.
          format: int32
          readOnly: true
        numberOfVms:
          type: integer
          description: Number of replicated VMs.
          format: int32
          readOnly: true
    TenantReplicationResourceNetworkAppliance:
      required:
        - name
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a network extension appliance.
          format: uuid
          readOnly: true
        name:
          maxLength: 512
          minLength: 1
          type: string
          description: Name of a network extension appliance.
        hardwarePlanUid:
          type: string
          description: UID assigned to a hardware plan.
          format: uuid
          readOnly: true
        hostName:
          type: string
          description: Name of a host on which network extension appliance is deployed.
          nullable: true
          readOnly: true
        rootHostName:
          type: string
          description: Name of a root host on which network extension appliance is deployed.
          nullable: true
          readOnly: true
        externalNetworkName:
          type: string
          description: Name of an external production network.
          readOnly: true
        tcpIpSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/NetworkApplianceTcpIpSettings'
          description: IP addressing settings for the configured network extension appliance.
          x-veeam-create-by-default: true
    NetworkApplianceTcpIpSettings:
      type: object
      properties:
        dhcpEnabled:
          type: boolean
          description: Indicates whether IP address is automatically assigned to network extension appliance by a DHCP server.
          default: true
        ipAddress:
          pattern: '^(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)$'
          type: string
          description: "IP address of a network extension appliance.\n> The `null` value indicates that IP address is automatically assigned by a DHCP server.\n"
          nullable: true
        subnetMask:
          pattern: '^(((255\.){3}(255|254|252|248|240|224|192|128+))|((255\.){2}(255|254|252|248|240|224|192|128|0+)\.0)|((255\.)(255|254|252|248|240|224|192|128|0+)(\.0+){2})|((255|254|252|248|240|224|192|128|0+)(\.0+){3}))$'
          type: string
          description: "Subnet mask of a network extension appliance.\n> The `null` value indicates that IP address is automatically assigned by a DHCP server.\n"
          nullable: true
        defaultGateway:
          pattern: '^(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)$'
          type: string
          description: "Default gateway of a network extension appliance.\n> The `null` value indicates that IP address is automatically assigned by a DHCP server.        \n"
          nullable: true
    TenantReplicationResourceVcdNetworkAppliance:
      required:
        - name
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a network extension appliance.
          format: uuid
          readOnly: true
        name:
          maxLength: 512
          minLength: 1
          type: string
          description: Name of a network extension appliance.
        dataCenterUid:
          type: string
          description: UID assigned to an organization VDC.
          format: uuid
          readOnly: true
        dataCenterName:
          type: string
          description: Name of an organization VDC.
          nullable: true
          readOnly: true
        tcpIpSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/NetworkApplianceTcpIpSettings'
          description: IP addressing settings for the configured network extension appliance.
          x-veeam-create-by-default: true
    TenantVcdReplicationResource:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a VMware Cloud Director replication resource.
          format: uuid
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          nullable: true
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        dataCenters:
          type: array
          items:
            $ref: '#/components/schemas/TenantVcdReplicationResourceDataCenter'
          description: Array of datacenters
          x-veeam-empty-array-by-default: true
        isFailoverCapabilitiesEnabled:
          type: boolean
          description: Indicates whether performing failover is available to a company.
          default: false
    TenantVcdReplicationResourceInput:
      type: object
      properties:
        dataCenters:
          type: array
          items:
            $ref: '#/components/schemas/TenantVcdReplicationResourceDataCenter'
          description: Array of organization VDCs.
          x-veeam-empty-array-by-default: true
        isFailoverCapabilitiesEnabled:
          type: boolean
          description: Indicates whether performing failover is available to a company.
          default: false
      description: ''
    TenantVcdReplicationResourceDataCenter:
      required:
        - dataCenterUid
      type: object
      properties:
        dataCenterUid:
          type: string
          description: UID assigned to an organization VDC.
          format: uuid
        isWanAccelerationEnabled:
          type: boolean
          description: Indicates whether WAN acceleration is enabled.
          default: false
        wanAcceleratorUid:
          type: string
          description: UID assigned to a WAN accelerator.
          format: uuid
          nullable: true
      description: ''
    TenantVcdReplicationResourceUsage:
      type: object
      properties:
        dataCenterUid:
          type: string
          description: UID assigned to a VMware Cloud Director replication resource.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          nullable: true
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect server on which a management agent is installed.
          format: uuid
          readOnly: true
        cpuCountConsumed:
          type: integer
          description: Number of replicated VMs CPUs.
          format: int32
          readOnly: true
        memoryUsage:
          type: integer
          description: 'Amount of RAM consumed by company replicas, in bytes.'
          format: int64
          readOnly: true
        storageUsage:
          type: integer
          description: 'Amount of space consumed by company replicas, in bytes.'
          format: int64
          readOnly: true
    CompanyVb365Resource:
      required:
        - vb365ServerUid
        - friendlyName
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 resource.
          format: uuid
          readOnly: true
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          readOnly: true
        friendlyName:
          maxLength: 256
          minLength: 1
          type: string
          description: Friendly name of a Veeam Backup for Microsoft 365 resource.
          nullable: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          nullable: true
          readOnly: true
    CompanyVb365ResourceInput:
      required:
        - vb365ServerUid
        - friendlyName
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 resource.
          format: uuid
          readOnly: true
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 Server.
          format: uuid
        friendlyName:
          maxLength: 256
          minLength: 1
          type: string
          description: Friendly name of a Veeam Backup for Microsoft 365 resource.
        isJobSchedulingEnabled:
          type: boolean
          description: Defines whether job schedule can be enabled.
          default: false
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          readOnly: true
    CompanyVb365BackupResource:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 backup resource.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          readOnly: true
        vb365ResourceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 resource.
          format: uuid
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
          readOnly: true
        proxyUid:
          type: string
          description: UID assigned to a backup proxy.
          format: uuid
          nullable: true
        proxyPoolUid:
          type: string
          description: UID assigned to a backup proxy pool.
          format: uuid
          nullable: true
        usersQuota:
          maximum: 999999
          minimum: 1
          type: integer
          description: Maximum number of protected user accounts.
          format: int32
          nullable: true
        isUsersQuotaUnlimited:
          type: boolean
          description: Indicates whether a number of protected user accounts is unlimited.
          default: true
        storageQuota:
          maximum: 1048576
          minimum: 1
          type: integer
          description: 'Maximum amount of Veeam Backup for Microsoft 365 repository storage space that a company is allowed to use, in GB.'
          format: int64
          nullable: true
        isStorageQuotaUnlimited:
          type: boolean
          description: Indicates whether a storage quota is unlimited.
          default: true
    CompanyVb365BackupResourceInput:
      required:
        - repositoryUid
      type: object
      properties:
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
        proxyUid:
          type: string
          description: UID assigned to a backup proxy.
          format: uuid
          nullable: true
        proxyPoolUid:
          type: string
          description: UID assigned to a backup proxy pool.
          format: uuid
          nullable: true
        usersQuota:
          maximum: 999999
          minimum: 1
          type: integer
          description: Maximum number of protected user accounts.
          format: int32
          nullable: true
        isUsersQuotaUnlimited:
          type: boolean
          description: Indicates whether a number of protected user accounts is unlimited.
          default: true
        storageQuota:
          maximum: 1048576
          minimum: 1
          type: integer
          description: 'Maximum amount of Veeam Backup for Microsoft 365 repository storage space that a company is allowed to use, in GB.'
          format: int64
          nullable: true
        isStorageQuotaUnlimited:
          type: boolean
          description: Indicates whether a storage quota is unlimited.
          default: true
    CompanyHostedVbrResource:
      required:
        - serverUid
        - friendlyName
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a company hosted resource.
          format: uuid
          readOnly: true
        serverUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server that provides resources to a company.
          format: uuid
          readOnly: true
        friendlyName:
          maxLength: 256
          minLength: 1
          type: string
          description: Friendly name of a company hosted resource.
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          nullable: true
          readOnly: true
    CompanyHostedVbrResourceInput:
      required:
        - serverUid
        - friendlyName
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a company hosted resource.
          format: uuid
          readOnly: true
        serverUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server that will provide resources to a company.
          format: uuid
        friendlyName:
          maxLength: 256
          minLength: 1
          type: string
          description: Friendly name of a company hosted resource.
        isJobSchedulingEnabled:
          type: boolean
          description: Defines whether job schedule can be enabled.
          default: false
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          readOnly: true
    CompanyHostedVbrBackupResource:
      required:
        - repositoryUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a company hosted repository resource.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          readOnly: true
        hostedResourceUid:
          type: string
          description: UID assigned to a company hosted resource.
          format: uuid
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
        storageQuota:
          maximum: 1048576
          minimum: 1
          type: integer
          description: 'Amount of space allocated to a company on a repository, in GB.'
          format: int64
          nullable: true
        isStorageQuotaUnlimited:
          type: boolean
          description: Indicates whether a storage quota is unlimited.
          default: true
    CompanyHostedVbrTagResource:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a company tag resource.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          readOnly: true
        hostedResourceUid:
          type: string
          description: UID assigned to a company hosted resource.
          format: uuid
          readOnly: true
        tagUrn:
          type: string
          description: URN assigned to a tag.
          readOnly: true
        tagName:
          type: string
          description: Name of a tag.
          readOnly: true
        virtualCenterUid:
          type: string
          description: UID assigned to a vCenter Server.
          format: uuid
          readOnly: true
    CompanyHostedVbrTagResourceInput:
      required:
        - virtualCenterUid
        - virtualServerTag
      type: object
      properties:
        virtualCenterUid:
          type: string
          description: vCenter Server UID.
          format: uuid
        virtualServerTag:
          type: object
          allOf:
            - $ref: '#/components/schemas/VirtualServerTag'
          description: "vCenter Server tag.\n> You can retrieve all vCenter Server tags using the `GetBackupServerVirtualServerTags` operation.\n"
    VcdOrganizationToCompanyMapping:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a mapping of a VMware Cloud Director organization to a company.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          readOnly: true
        hostedResourceUid:
          type: string
          description: UID assigned to a company hosted resource.
          format: uuid
          readOnly: true
        vcdOrganizationUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization.
          format: uuid
          readOnly: true
        vcdOrganizationName:
          type: string
          description: Name of a VMware Cloud Director organization.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a hosted Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        backupServerName:
          type: string
          description: Name of a hosted Veeam Backup & Replication server.
          readOnly: true
    OrganizationLocation:
      required:
        - name
        - quotaGb
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a location in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          maxLength: 512
          minLength: 1
          type: string
          description: Name of a location.
        quotaGb:
          minimum: 0
          type: integer
          description: 'Amount of storage space available to a location, in GB.'
          format: int64
        type:
          enum:
            - Unknown
            - Default
            - Hosted
            - Custom
          type: string
          description: Type of an organization location.
          default: Custom
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: OrganizationLocationType
    OrganizationLocationInput:
      required:
        - name
        - organizationUid
        - quotaGb
      type: object
      properties:
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
        name:
          maxLength: 512
          minLength: 1
          type: string
          description: Name of a location.
        quotaGb:
          minimum: 0
          type: integer
          description: 'Amount of storage space available to a location, in GB.'
          format: int32
    OrgContainer:
      required:
        - name
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^\/\\\[\]:;|=,+\*\?<>@"]+$'
          type: string
          description: Name of an organization.
        type:
          enum:
            - Unknown
            - DefaultCompanies
            - DefaultResellers
            - Custom
          type: string
          description: Type of an organization container.
          default: Custom
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: OrgContainerType
        childrenOrganizations:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to organizations in a container.
          nullable: true
        childrenContainers:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to child organization containers.
          nullable: true
    OrgContainerInput:
      required:
        - name
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^\/\\\[\]:;|=,+\*\?<>@"]+$'
          type: string
          description: Name of a container.
        childrenOrganizations:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to organizations that must be included in a container.
          nullable: true
        childrenContainers:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to child organization containers.
          nullable: true
    Organization:
      required:
        - name
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^<>=%~]+$'
          type: string
          description: Name of an organization.
        alias:
          maxLength: 32
          minLength: 1
          pattern: '^[a-zA-Z\d\!\#\$\%\&\(\)\-\.\^\"\_\{\}\~\''\ \`]+$'
          type: string
          description: Alias of an organization.
          nullable: true
        type:
          enum:
            - Unknown
            - Company
            - Provider
            - Reseller
          type: string
          description: Type of an organization.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: OrganizationType
        taxId:
          maxLength: 100
          type: string
          description: Organization Tax ID.
          nullable: true
        email:
          maxLength: 128
          minLength: 1
          pattern: '^(")?(?:[^\."])(?:(?:[\.])?(?:[\w\-!#$%&''*+\/=?\^_`{|}~]))*\1@(\w[\-\w]*\.){1,5}([A-Za-z]){2,6}$'
          type: string
          description: Contact email address.
          nullable: true
        phone:
          maxLength: 128
          type: string
          description: Telephone number of a primary contact of an organization.
          nullable: true
        country:
          minimum: 1
          type: integer
          description: System ID assigned to an organization country of residence.
          format: int32
          nullable: true
        state:
          minimum: 1
          type: integer
          description: System ID assigned to a USA state where an organization is located.
          format: int32
          nullable: true
        countryName:
          type: string
          description: Country name.
          nullable: true
        regionName:
          type: string
          description: Region name.
          nullable: true
        city:
          maxLength: 128
          type: string
          description: City where an organization is located.
          nullable: true
        street:
          maxLength: 128
          type: string
          description: Street where an organization is located.
          nullable: true
        locationAdmin0Code:
          maxLength: 32
          type: string
          description: Code of a country where an organization is located.
          nullable: true
        locationAdmin1Code:
          maxLength: 32
          type: string
          description: 'Code of a state, region or area where an organization is located.'
          nullable: true
        locationAdmin2Code:
          maxLength: 32
          type: string
          description: Code of a district or municipality where an organization is located.
          nullable: true
        notes:
          maxLength: 512
          type: string
          description: Additional information about an organization.
          nullable: true
        zipCode:
          maxLength: 128
          type: string
          description: Postal code.
          nullable: true
        website:
          maxLength: 128
          type: string
          description: Organization website.
          nullable: true
        veeamTenantId:
          maxLength: 128
          type: string
          description: ID of an organization used in Veeam records.
          nullable: true
        companyId:
          maxLength: 128
          type: string
          description: ID of an organization used for 3rd party applications.
          nullable: true
      description: ''
    OrganizationInput:
      required:
        - name
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^<>=%~]+$'
          type: string
          description: Name of an organization.
        alias:
          maxLength: 32
          minLength: 1
          pattern: '^[a-zA-Z\d\!\#\$\%\&\(\)\-\.\^\"\_\{\}\~\''\ \`]+$'
          type: string
          description: Alias of an organization.
          nullable: true
        taxId:
          maxLength: 100
          type: string
          description: Organization Tax ID.
          nullable: true
        email:
          maxLength: 128
          minLength: 1
          pattern: '^(")?(?:[^\."])(?:(?:[\.])?(?:[\w\-!#$%&''*+\/=?\^_`{|}~]))*\1@(\w[\-\w]*\.){1,5}([A-Za-z]){2,6}$'
          type: string
          description: Contact email address.
          nullable: true
        phone:
          maxLength: 128
          type: string
          description: Telephone number of a primary contact of an organization.
          nullable: true
        country:
          minimum: 1
          type: integer
          description: System ID assigned to an organization country of residence.
          format: int32
          nullable: true
        state:
          maximum: 51
          minimum: 1
          type: integer
          description: System ID assigned to a USA state where an organization is located.
          format: int32
          nullable: true
        countryName:
          type: string
          description: Country name.
          nullable: true
        regionName:
          type: string
          description: Region name.
          nullable: true
        city:
          maxLength: 128
          type: string
          description: City where an organization is located.
          nullable: true
        street:
          maxLength: 128
          type: string
          description: Street where an organization is located.
          nullable: true
        locationAdmin0Code:
          maxLength: 32
          type: string
          description: Code of a country where an organization is located.
          nullable: true
        locationAdmin1Code:
          maxLength: 32
          type: string
          description: 'Code of a state, region or area where an organization is located.'
          nullable: true
        locationAdmin2Code:
          maxLength: 32
          type: string
          description: Code of a district or municipality where an organization is located.
          nullable: true
        notes:
          maxLength: 512
          type: string
          description: Additional information about an organization.
          nullable: true
        zipCode:
          maxLength: 128
          type: string
          description: Postal code.
          nullable: true
        website:
          maxLength: 128
          type: string
          description: Organization website.
          nullable: true
        veeamTenantId:
          maxLength: 128
          type: string
          description: ID of an organization used in Veeam records.
          nullable: true
        companyId:
          maxLength: 128
          type: string
          description: ID of an organization used for 3rd party applications.
          nullable: true
      description: ''
    UnverifiedAgent:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization to which a management agent belongs.
          format: uuid
          nullable: true
          readOnly: true
        hostName:
          type: string
          description: Name of a computer on which a management agent is deployed.
          nullable: true
          readOnly: true
        registrationTime:
          type: string
          description: Time when a management agent was registered.
          format: date-time
          readOnly: true
        tag:
          type: string
          description: Additional information.
          nullable: true
        rejectReason:
          type: string
          description: Reason for management agent being unverified.
          nullable: true
        type:
          enum:
            - Unknown
            - CloudConnect
            - Client
            - Hosted
          type: string
          description: Role of a management agent.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ManagementAgentType
        status:
          enum:
            - Unknown
            - Accepted
            - Inaccessible
            - Pending
            - Rejected
            - Applying
          type: string
          description: Status of a management agent.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: UnverifiedAgentStatus
        statusMessage:
          type: string
          description: Management agent status message.
          nullable: true
        platformType:
          enum:
            - Unknown
            - Windows
            - Linux
            - Mac
          type: string
          description: Platform type of an agent.
          readOnly: true
          x-ms-enum:
            name: UnverifiedAgentPlatformType
          x-extensible-enum: true
    ManagementAgent:
      required:
        - locationUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a location to which a management agent belongs.
          format: uuid
        organizationUid:
          type: string
          description: UID assigned to an organization to which a management agent belongs.
          format: uuid
          readOnly: true
        hostName:
          type: string
          description: Name of a computer on which a management agent is deployed.
          nullable: true
          readOnly: true
        friendlyName:
          maxLength: 256
          type: string
          description: Friendly name of a management agent.
          nullable: true
        lastHeartbeatTime:
          type: string
          description: Date and time when a management agent on a computer sent the latest heartbeat.
          format: date-time
          readOnly: true
        version:
          type: string
          description: Version of a management agent deployed on a computer.
          readOnly: true
        discoveryTime:
          type: string
          description: Date and time when a computer was discovered.
          format: date-time
          readOnly: true
        tag:
          maxLength: 256
          type: string
          description: Additional information.
          nullable: true
        status:
          $ref: '#/components/schemas/ManagementAgentStatus'
        type:
          enum:
            - Unknown
            - CloudConnect
            - Client
            - Hosted
          type: string
          description: Role of a management agent.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ManagementAgentType
        computerInfo:
          type: object
          allOf:
            - $ref: '#/components/schemas/ComputerInfo'
          description: Information about a computer on which a management agent is deployed.
          nullable: true
          readOnly: true
        connectionStatus:
          enum:
            - Unknown
            - Online
            - Inaccessible
            - Rejected
          type: string
          description: Connection status of a management agent.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ManagementAgentConnectionStatus
        isRebootRequired:
          type: boolean
          description: Indicates whether computer reboot is required.
          readOnly: true
        connectionAccount:
          type: string
          description: Company owner user name that is used to connect a management agent to a cloud gateway.
          format: uuid
          nullable: true
          readOnly: true
        versionStatus:
          enum:
            - Unknown
            - UpToDate
            - OutOfDate
            - PatchAvailable
          type: string
          description: Status of a management agent version.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ManagementAgentVersionStatus
        role:
          enum:
            - Unknown
            - Master
            - Client
          type: string
          description: Role of a management agent.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ManagementAgentRole
    ManagementAgentStatus:
      enum:
        - Unknown
        - Healthy
        - Inaccessible
        - Warning
        - Updating
        - Error
        - Restarting
        - Installation
        - FailedToUpdate
        - Applying
      type: string
      description: Status of a management agent.
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: ManagementAgentStatus
    CloudAgent:
      required:
        - siteName
      type: object
      properties:
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect server on which a management agent is installed.
          format: uuid
          readOnly: true
        siteName:
          maxLength: 128
          minLength: 1
          pattern: '^(?!\s*$)[^<>=%~]+$'
          type: string
          description: Name of a Veeam Cloud Connect site.
        description:
          maxLength: 512
          type: string
          description: Description of a Veeam Cloud Connect site.
          nullable: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
          readOnly: true
        maintenanceModeIsEnabled:
          type: boolean
          description: "Indicates whether the maintenance mode is enabled for a Veeam Cloud Connect site.\n> Can be changed by performing the `SetSiteMaintenanceMode` operation.\n"
          readOnly: true
        tenantManagementInCloudConnectIsEnabled:
          type: boolean
          description: "Indicates whether tenant and cloud resource management in Veeam Service Provider Console and Veeam Backup & Replication console is allowed.\n> Can be changed by performing the `SetSiteTenantManagementMode` operation.\n"
          readOnly: true
      description: Information about a Veeam Cloud Connect server on which a management agent is deployed.
    ComputerInfo:
      type: object
      properties:
        uniqueUid:
          type: string
          description: UID assigned to a computer.
          format: uuid
          readOnly: true
        biosUuid:
          type: string
          description: UUID in Win32_ComputerSystem WMI class.
          format: uuid
          readOnly: true
        hostName:
          type: string
          description: Name of a computer.
          readOnly: true
        fqdn:
          type: string
          description: FQDN of a computer.
          readOnly: true
        guestOs:
          type: string
          description: Operating system installed on a computer.
          readOnly: true
        guestOsType:
          enum:
            - Unknown
            - Workstation
            - DomainController
            - Server
            - Linux
            - Mac
          type: string
          description: Type of a computer operating system.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: OsType
        guestOsVersion:
          type: string
          description: Version of a computer operating system.
          readOnly: true
        guestOsSku:
          type: integer
          description: SKU of a computer operating system.
          format: int32
          nullable: true
          readOnly: true
        platformType:
          enum:
            - Unknown
            - Windows
            - HyperV
            - Linux
            - Mac
            - vSphere
            - Azure
            - Amazon
            - Other
            - Google
          type: string
          description: Type of a computer platform.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: PlatformType
        ipAddresses:
          type: array
          items:
            type: string
          description: Computer IP addresses.
          readOnly: true
        macAddresses:
          type: array
          items:
            type: string
          description: Computer MAC addresses.
          readOnly: true
        applications:
          type: array
          items:
            enum:
              - Unknown
              - OtherApp
              - MicrosoftExchangeServer
              - MicrosoftSqlServer
              - MicrosoftActiveDirectory
              - MicrosoftSharePoint
              - Oracle
              - MySQL
              - PostgreSQL
              - MongoDB
              - ApacheServer
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: Application
          description: Array of applications installed on a computer.
          nullable: true
          readOnly: true
      description: Information about a computer on which a management agent is deployed.
    BackupServer:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Backup & Replication server.
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization to which a management agent belongs.
          format: uuid
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server location.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        version:
          type: string
          description: Version of Veeam Backup & Replication installed on a server.
          readOnly: true
        displayVersion:
          type: string
          description: Version of Veeam Backup & Replication with additional information on installed patch version.
          readOnly: true
        installationUid:
          type: string
          description: UID assigned to Veeam Backup & Replication installation.
          readOnly: true
        backupServerRoleType:
          enum:
            - Unknown
            - CloudConnect
            - Client
            - Hosted
          type: string
          description: Role of a Veeam Backup & Replication server.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerRoleType
        status:
          enum:
            - Unknown
            - Healthy
            - Warning
            - Inaccessible
          type: string
          description: Backup server status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerStatus
      example:
        instanceUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        name: VBR
        managementAgentUid: 8BDD0D87-D160-40B5-88D3-E77A6F912AF6
        version: 9.5.4.1000
        installationUid: C42C94E9-DB8A-4CF4-AF57-911EFA7FEE87
    BackupServerPublicCloudAppliance:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          readOnly: true
        resourceId:
          type: string
          description: Resource ID of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        publicAddress:
          type: string
          description: URL of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        description:
          type: string
          description: Description of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        region:
          type: string
          description: Region where a Veeam Backup for Public Clouds appliance is located.
          readOnly: true
        certificateThumbprint:
          type: string
          description: Thumbprint of a security certificate.
          readOnly: true
        remoteUiAccessEnabled:
          type: boolean
          description: Indicates whether the Veeam Backup for Public Clouds appliance interface can be accessed in Veeam Service Provider Console.
          readOnly: true
        selfServicePortalUrl:
          type: string
          description: URL of the Veeam Backup for Public Clouds portal.
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization that owns a Veeam Backup & Replication server on which a Veeam Backup for Public Clouds appliance is registered.
          format: uuid
          readOnly: true
        mappedOrganizationUid:
          type: string
          description: UID assigned to an organization to which a Veeam Backup for Public Clouds appliance is assigned.
          format: uuid
          nullable: true
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance location.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam Backup for Public Clouds appliance server.
          format: uuid
          readOnly: true
        version:
          type: string
          description: Version of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        status:
          $ref: '#/components/schemas/BackupServerPublicCloudApplianceStatus'
        statusMessage:
          type: string
          description: Message that contains information on the status of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        platform:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatform'
        managementType:
          $ref: '#/components/schemas/BackupServerPublicCloudApplianceManagementType'
    BackupServerPublicCloudApplianceManagementType:
      enum:
        - Unknown
        - ByConsole
        - ByBackupServer
      type: string
      description: Management type of a Veeam Backup for Public Clouds appliance.
      readOnly: true
      x-extensible-enum: true
    SitePublicCloudAppliance:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        publicAddress:
          type: string
          description: URL of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        applianceName:
          type: string
          description: Name of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        description:
          type: string
          description: Description of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        region:
          type: string
          description: Region where a Veeam Backup for Public Clouds appliance is located.
          readOnly: true
        certificateThumbprint:
          type: string
          description: Thumbprint of a security certificate.
          readOnly: true
        remoteUiAccessEnabled:
          type: boolean
          description: Indicates whether the Veeam Backup for Public Clouds appliance can be accessed in Veeam Service Provider Console.
          readOnly: true
        selfServicePortalUrl:
          type: string
          description: URL of the Veeam Backup for Public Clouds portal.
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization that owns a Veeam Cloud Connect site on which a Veeam Backup for Public Clouds appliance is registered.
          format: uuid
          readOnly: true
        mappedOrganizationUid:
          type: string
          description: UID assigned to an organization to which a Veeam Backup for Public Clouds appliance is assigned.
          format: uuid
          nullable: true
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam Backup for Public Clouds appliance server.
          format: uuid
          readOnly: true
        version:
          type: string
          description: Version of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        status:
          $ref: '#/components/schemas/BackupServerPublicCloudApplianceStatus'
        statusMessage:
          type: string
          description: Message that contains information on the status of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        platform:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatform'
        deploymentStatus:
          $ref: '#/components/schemas/EVbApplianceDeploymentStatus'
    BackupServerPublicCloudApplianceStatus:
      enum:
        - Unknown
        - Healthy
        - Unavailable
        - Warning
        - Deleting
        - Removing
      type: string
      description: Status of a Veeam Backup for Public Clouds appliance.
      readOnly: true
      x-extensible-enum: true
    BackupServerPublicCloudAppliancePlatform:
      enum:
        - Unknown
        - Azure
        - Amazon
        - Google
      type: string
      description: Platform of a Veeam Backup for Public Clouds appliance.
      readOnly: true
      x-extensible-enum: true
    BackupServerPublicCloudAppliancePlatformInput:
      enum:
        - Azure
        - Amazon
        - Google
      type: string
      description: Platform of a Veeam Backup for Public Clouds appliance.
    EVbApplianceDeploymentStatus:
      enum:
        - Unknown
        - Success
        - Warning
        - Failed
        - Installing
        - Upgrading
        - Connecting
        - UpdateCredentials
        - ServiceAccountCreating
      type: string
      description: Deployment status.
      nullable: true
    PublicCloudSqlAccount:
      required:
        - accountName
      type: object
      properties:
        accountId:
          type: string
          description: ID assigned to a public cloud SQL account.
          readOnly: true
        accountName:
          maxLength: 255
          minLength: 1
          pattern: '^[^^!`$&+,:;#|/<>%''"]+$'
          type: string
          description: Name of a public cloud SQL account.
        userName:
          maxLength: 255
          minLength: 1
          type: string
          description: User name.
          nullable: true
        password:
          maxLength: 255
          type: string
          description: Password.
          format: password
          nullable: true
        description:
          maxLength: 512
          type: string
          description: Description of a public cloud SQL account.
          nullable: true
        status:
          enum:
            - Unknown
            - Available
            - Removing
          type: string
          description: Status of a public cloud SQL account.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: PublicCloudSqlAccountStatus
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam Backup for Public Clouds appliance server.
          format: uuid
          readOnly: true
    NewPublicCloudSqlAccount:
      required:
        - accountName
        - databaseType
        - userName
        - password
        - applianceUid
      type: object
      properties:
        accountName:
          maxLength: 255
          minLength: 1
          pattern: '^[^^!`$&+,:;#|/<>%''"]+$'
          type: string
          description: Name of a public cloud SQL account.
        databaseType:
          $ref: '#/components/schemas/PublicCloudSqlAccountDatabaseType'
        userName:
          maxLength: 255
          type: string
          description: User name.
          nullable: true
        password:
          maxLength: 255
          type: string
          description: Password.
          format: password
          nullable: true
        description:
          maxLength: 512
          type: string
          description: Description of a public cloud SQL account.
          nullable: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
    PublicCloudSqlAccountDatabaseType:
      enum:
        - AzureSql
        - GcpMySqlBuiltIn
        - GcpPostgres
        - AwsSql
      type: string
      description: Type of a public cloud SQL database.
    PublicCloudSqlAccountAppliance:
      type: object
      properties:
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          readOnly: true
        applianceName:
          type: string
          description: Name of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam Backup for Public Clouds appliance server.
          format: uuid
          readOnly: true
    BackupFailoverPlan:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a failover plan.
          format: uuid
          readOnly: true
        originalUid:
          type: string
          description: UID assigned to a failover plan in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server on which a failover plan is configured.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a failover plan.
          readOnly: true
        type:
          enum:
            - Unknown
            - Local
            - Cloud
            - Tenant
          type: string
          description: Type of a failover plan.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: FailoverPlanType
        status:
          enum:
            - Unknown
            - Ready
            - InProgress
            - InUndoProgress
            - Success
            - Failed
            - Completed
            - UndoFailed
          type: string
          description: Status of a failover plan.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: FailoverPlanState
        tenantUid:
          type: string
          description: UID assigned to a tenant for which a failover plan is configured.
          format: uuid
          nullable: true
          readOnly: true
        objectsCount:
          type: integer
          description: Number of objects in a job.
          format: int32
          readOnly: true
        preFailoverScriptEnabled:
          type: boolean
          description: Indicates whether a custom script must be executed before a failover plan.
          nullable: true
          readOnly: true
        preFailoverCommand:
          type: string
          description: "Path to a script file that is executed before a failover.\n> Property modification is performed asynchronously and cannot be tracked.\n"
          nullable: true
        postFailoverCommand:
          type: string
          description: "Path to a script file that is executed after a failover.\n> Property modification is performed asynchronously and cannot be tracked.\n"
          nullable: true
        postFailoverScriptEnabled:
          type: boolean
          description: Indicates whether a custom script must be executed after a failover plan.
          nullable: true
          readOnly: true
      example:
        instanceUid: 27a8baf5-179e-4eae-81d5-772aa2331562
        name: Media servers Failover to Columbus
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        type: Local
        objectsCount: 5
        status: InProgress
        tenantUid: ABC97BD3-4AE9-4841-8152-8FF5CC703678
        preFailoverCommand: ''
        postFailoverCommand: ''
    BackupFailoverPlanObject:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a VM included in a failover plan.
          format: uuid
          readOnly: true
        planUid:
          type: string
          description: UID assigned to a failover plan.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a VM included in a failover plan.
          readOnly: true
        hostName:
          type: string
          description: Name of a host running the VM.
          readOnly: true
        folderName:
          type: string
          description: Name of a folder that contains replicas.
          readOnly: true
        path:
          type: string
          description: Path to a folder that contains replicas.
          readOnly: true
        backupServerUid:
          type: string
          description: Veeam Backup & Replication server on which a failover plan is configured.
          format: uuid
          readOnly: true
        restoreSession:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupFailoverPlanRestoreSession'
          description: Information about a failover session. Can be obtained only from a server with Veeam Backup & Replication version 11 or later.
          nullable: true
          readOnly: true
    BackupFailoverPlanRestoreSession:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a protected VM.
          format: uuid
          readOnly: true
        backupStatus:
          enum:
            - Unknown
            - Running
            - Success
            - Warning
            - Failed
          type: string
          description: Status of a failover session.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupFailoverPlanRestoreSessionBackupStatus
        restorePointUid:
          type: string
          description: UID assigned to a replication restore point.
          format: uuid
          nullable: true
          readOnly: true
        restorePointDateTime:
          type: string
          description: Date and time of the replication restore point creation.
          format: date-time
          nullable: true
          readOnly: true
        startDateTime:
          type: string
          description: Failover session start date and time.
          format: date-time
          readOnly: true
        endDateTime:
          type: string
          description: Failover session end date and time.
          format: date-time
          nullable: true
          readOnly: true
    BackupHardwarePlan:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a hardware plan.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a hardware plan.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server on which a hardware plan is configured.
          format: uuid
          readOnly: true
        cpuQuota:
          type: integer
          description: 'Maximum CPU resources that VM replicas can utilize, in MHz.'
          format: int64
          nullable: true
          readOnly: true
        isCpuQuotaUnlimited:
          type: boolean
          description: Indicates whether CPU resources that VM replicas can utilize are unlimited.
          readOnly: true
        memoryQuota:
          type: integer
          description: 'Maximum RAM resources that VM replicas can utilize, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        isMemoryQuotaUnlimited:
          type: boolean
          description: Indicates whether RAM resources that VM replicas can utilize are unlimited.
          readOnly: true
        networkWithInternetQuota:
          type: integer
          description: Number of IP networks with internet access that are available to tenant VM replicas.
          format: int32
          readOnly: true
        networkWithoutInternetQuota:
          type: integer
          description: Number of IP networks without internet access that are available to tenant VM replicas.
          format: int32
          readOnly: true
      example:
        instanceUid: 8db62bf7-581b-437b-b640-76212ff40b3a
        name: Silver Hardware Plan
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        CpuQuota: 7770
        MemoryQuota: 7368000
        NetworkQuota: 3
    BackupHardwarePlanStorage:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a hardware plan storage.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Friendly name of a hardware plan storage.
          readOnly: true
        hardwarePlanUid:
          type: string
          description: UID assigned to a hardware plan.
          format: uuid
          readOnly: true
        quota:
          type: integer
          description: Amount of disk space provided to a tenant.
          format: int64
          nullable: true
          readOnly: true
    CloudBackup:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a backup.
          nullable: true
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant.
          format: uuid
          readOnly: true
        subTenantUid:
          type: string
          description: UID assigned to a subtenant.
          format: uuid
          nullable: true
          readOnly: true
        type:
          enum:
            - Unknown
            - VSphere
            - HyperV
            - Windows
            - Linux
            - Mac
            - NAS
            - VCD
            - Tape
            - AHV
            - Azure
            - Amazon
            - RHV
            - Google
            - ProxmoxVe
            - ScaleComputing
          type: string
          description: Type of a backed up object.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: CloudBackupType
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect repository.
          format: uuid
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a backup job that created the backup.
          format: uuid
          nullable: true
          readOnly: true
        sourceInstallationUid:
          type: string
          description: Installation UID of a Veeam product that is installed on the backed up object.
          format: uuid
          nullable: true
          readOnly: true
        restorePointsCount:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
    CloudTenant:
      required:
        - credentials
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a tenant.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        siteName:
          type: string
          description: Name assigned to a Veeam Cloud Connect site.
          readOnly: true
        type:
          enum:
            - Unknown
            - General
            - VCD
          type: string
          description: Type of a tenant account.
          default: General
          x-extensible-enum: true
          x-ms-enum:
            name: CloudTenantType
        vCloudOrganizationUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization.
          format: uuid
          nullable: true
        lastActive:
          type: string
          description: The last time when a tenant was active.
          format: date-time
          nullable: true
          readOnly: true
        isLeaseExpirationEnabled:
          type: boolean
          description: Indicates whether a tenant account must be disabled automatically.
          default: false
        leaseExpirationDate:
          type: string
          description: Date and time when a company account must be disabled.
          format: date-time
          nullable: true
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/OwnerCredentials'
          description: "Credentials or user name of a tenant account configured for a VMware Cloud Director organization.\n> The user name becomes tenant name on tenant creation.\n"
        description:
          type: string
          description: Description of a tenant account.
          nullable: true
        isThrottlingEnabled:
          type: boolean
          description: Indicates whether incoming network traffic that will be accepted from a tenant is limited.
          default: false
        throttlingValue:
          maximum: 9999
          minimum: 1
          type: integer
          description: "Maximum incoming network traffic bandwidth that will be accepted from a tenant.\n> If throttling is disabled, the property value is `null`.\n"
          format: int32
          default: 1
          nullable: true
        throttlingUnit:
          enum:
            - MbitPerSec
            - KbytePerSec
            - MbytePerSec
          type: string
          description: "Measurement units of incoming network traffic accepted from a company.\n> If throttling is disabled, the property value is `null`.\n"
          default: MbytePerSec
          nullable: true
          x-ms-enum:
            name: SpeedUnit
        maxConcurrentTask:
          maximum: 10000
          minimum: 1
          type: integer
          description: Maximum number of concurrent tasks available to a tenant.
          format: int32
          default: 1
        isBackupProtectionEnabled:
          type: boolean
          description: Indicates whether deleted backup file protection is enabled.
          default: false
        backupProtectionPeriod:
          maximum: 99
          minimum: 1
          type: integer
          description: Number of days during which deleted backup files must be kept in the recycle bin on the Veeam Cloud Connect server.
          format: int32
          default: 7
          nullable: true
        gatewaySelectionType:
          enum:
            - Unknown
            - StandaloneGateways
            - GatewayPool
          type: string
          description: Type of gateway selection.
          default: StandaloneGateways
          x-extensible-enum: true
          x-ms-enum:
            name: CloudTenantGatewaySelectionType
        gatewayPoolsUids:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: "Collection of UIDs assigned to gateway pools that are allocated to a company.\n> If the collection is empty, company will automatically use a standalone gateway.\n"
          nullable: true
        isGatewayFailoverEnabled:
          type: boolean
          description: Indicates whether a tenant is allowed to fail over to a cloud gateway that is not added to a selected cloud gateway pool.
          default: false
        name:
          type: string
          description: Name of a tenant account.
          nullable: true
          readOnly: true
        hashedPassword:
          type: string
          description: Hash of a tenant account password.
          readOnly: true
        isEnabled:
          type: boolean
          description: Indicates whether a tenant account is enabled.
          readOnly: true
        isBackupResourcesEnabled:
          type: boolean
          description: Indicates whether cloud backup resources are allocated to a tenant.
          readOnly: true
        isNativeReplicationResourcesEnabled:
          type: boolean
          description: Indicates whether cloud replication resources are allocated to a tenant.
          default: false
        isVcdReplicationResourcesEnabled:
          type: boolean
          description: Indicates whether organization VDCs are allocated to a tenant as cloud hosts.
          default: false
        assignedForCompany:
          type: string
          description: "UID of a company to which a tenant is assigned.\n> For reseller users, the property value is required.\n"
          format: uuid
          nullable: true
    CloudSubTenant:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a subtenant account.
          format: uuid
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant that manages a subtenant account.
          format: uuid
          readOnly: true
        name:
          type: string
          description: User name of a subtenant account.
          readOnly: true
        description:
          type: string
          description: Description of a subtenant account.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect server.
          format: uuid
          readOnly: true
        isEnabled:
          type: boolean
          description: Indicates whether a subtenant account is enabled.
          readOnly: true
      example:
        instanceUid: 1111568E-F90F-4702-8151-CBE3CE2A8C10
        tenantUid: 0000568E-F90F-4702-8151-CBE3CE2A8C10
        name: SubTenant01
        description: SubTenant X for Agent X
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        isEnabled: true
    BackupProxy:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup proxy.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a backup proxy.
          readOnly: true
        version:
          type: string
          description: Version of a backup proxy service.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        isOutOfDate:
          type: boolean
          description: Indicates whether a backup proxy service is outdated.
          readOnly: true
        isDisabled:
          type: boolean
          description: Indicates whether a backup proxy is disabled.
          readOnly: true
        hostUid:
          type: string
          description: UID assigned to a server that performs a role of a backup proxy.
          format: uuid
          readOnly: true
        hostName:
          type: string
          description: Computer name of a server that performs a role of a backup proxy.
          readOnly: true
        status:
          enum:
            - Unknown
            - Healthy
            - Warning
            - Error
          type: string
          description: Backup proxy status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupProxyStatus
        type:
          enum:
            - Unknown
            - vSphere
            - HyperV
            - HyperVOffhost
            - File
            - CDP
          type: string
          description: Type of a backup proxy.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupProxyType
      example:
        instanceUid: 6062568E-F90F-4702-8151-CBE3CE2A8C10
        name: BACKUPPRX01
        version: 9.5.4.2000
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        isOutOfDate: false
        isDisabled: false
        status: Healthy
        type: vSphere
    CloudGateway:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud gateway.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a cloud gateway.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        gatewayPoolUid:
          type: string
          description: UID assigned to a cloud gateway pool that includes the cloud gateway.
          format: uuid
          nullable: true
        port:
          type: integer
          description: Internal port that is listening to external connections.
          format: int32
          readOnly: true
        externalPort:
          type: integer
          description: Port for external connections.
          format: int32
          readOnly: true
        externalAddress:
          type: string
          description: "IP address or DNS name of a network interface card on a cloud gateway used to communicate with tenant Veeam Backup & Replication servers.\n> For cloud gateways with version 12, only the DNS name is returned.\n"
          readOnly: true
        externalIpList:
          type: array
          items:
            type: string
          description: List of available network interface cards.
          nullable: true
          readOnly: true
        isOutOfDate:
          type: boolean
          description: Indicates whether a cloud gateway service is outdated.
          readOnly: true
        hostUid:
          type: string
          description: UID assigned to a server that performs a role of a cloud gateway.
          format: uuid
          readOnly: true
        isDisabled:
          type: boolean
          description: Indicates whether a cloud gateway is disabled.
          readOnly: true
        status:
          enum:
            - Unknown
            - Healthy
            - Warning
            - Error
          type: string
          description: Status of a cloud gateway.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: CloudGatewayStatus
      example:
        instanceUid: 81536849-36C5-4044-9DC5-D1393062ADA8
        name: BACKUPCGW01
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        port: 10001
        isOutOfDate: false
        isDisabled: false
        status: Healthy
        externalPort: 666
        externalIp: 10.17.26.1
    CloudGatewayPool:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud gateway pool.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a cloud gateway pool.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        numberOfGateways:
          type: integer
          description: Number of cloud gateways added to a cloud gateway pool.
          format: int32
          readOnly: true
      example:
        instanceUid: 8B7AC327-3D08-4F51-9D36-ECA703D4565A
        name: BACKUPCGPOOLW01
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
    IdentityProvider:
      required:
        - name
        - displayName
        - template
        - type
      type: object
      properties:
        name:
          maxLength: 32
          minLength: 5
          pattern: '^[\._a-zA-Z0-9]+$'
          type: string
          description: Name of an identity provider.
        displayName:
          maxLength: 56
          minLength: 2
          pattern: '^[^\<\>\"\''\%\;\(\)\&\^\+\|]+$'
          type: string
          description: Display name of an identity provider.
        template:
          $ref: '#/components/schemas/IdentityProviderTemplate'
        type:
          $ref: '#/components/schemas/IdentityProviderType'
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        enabled:
          type: boolean
          description: Indicates whether an identity provider is enabled.
          default: true
      example:
        name: adfs
        displayName: Microsoft Entra ID Federation Services
        template: ADFS
        type: SAML2
        organizationUid: 0242e3ca-1cc2-4d90-8285-0e7a9b375418
        enabled: true
    IdentityProviderType:
      enum:
        - Unknown
        - SAML2
      type: string
      description: Type of an identity provider.
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: IdentityProviderType
    IdentityProviderTemplate:
      enum:
        - Unknown
        - Keycloak
        - ADFS
        - Okta
        - Custom
      type: string
      description: Identity provider template.
      default: Custom
      x-extensible-enum: true
      x-ms-enum:
        name: IdentityProviderTemplates
    IdentityProviderSettingsInput:
      required:
        - configuration
        - displayName
        - name
      type: object
      properties:
        name:
          maxLength: 32
          minLength: 5
          pattern: '^[\._a-zA-Z0-9]+$'
          type: string
          description: Name of an identity provider.
        displayName:
          maxLength: 56
          minLength: 2
          pattern: '^[^\<\>\"\''\%\;\(\)\&\^\+\|]+$'
          type: string
          description: Display name of an identity provider.
        template:
          $ref: '#/components/schemas/IdentityProviderTemplate'
        type:
          $ref: '#/components/schemas/IdentityProviderType'
        configuration:
          $ref: '#/components/schemas/Saml2Configuration'
        configurationCompleted:
          type: boolean
          description: "Indicates whether the identity provider configuration is completed.\n>If configuration is not completed, an identity provider is not available on the authorization screen of the Veeam Service Provider Console web interface.\n>You can complete configuration by modifying this property using the PATCH operation.\n>If another identity provider is already enabled for an organization, this value cannot be modified.\n"
          default: false
        enabled:
          type: boolean
          description: Indicates whether an identity provider is enabled.
          default: true
    IdentityProviderSettings:
      required:
        - configuration
        - displayName
      type: object
      properties:
        name:
          maxLength: 32
          minLength: 5
          pattern: '^[\._a-zA-Z0-9]+$'
          type: string
          description: Name of an identity provider.
          readOnly: true
        displayName:
          maxLength: 56
          minLength: 2
          pattern: '^[^\<\>\"\''\%\;\(\)\&\^\+\|]+$'
          type: string
          description: Display name of an identity provider.
        template:
          $ref: '#/components/schemas/IdentityProviderTemplate'
        type:
          $ref: '#/components/schemas/IdentityProviderType'
        configurationValidationSucceeded:
          type: boolean
          description: "Indicates whether an identity provider successfully passed validation procedure.\n> If the value is `false`, an identity provider is not functional. \n"
          readOnly: true
        errorMessage:
          type: string
          description: "Error message.\n> If identity provider validation fails, the property value is not `null`.\n"
          nullable: true
          readOnly: true
        configuration:
          $ref: '#/components/schemas/Saml2Configuration'
        rulesCount:
          type: integer
          description: Number of mapping rules configured for a service provider.
          format: int32
          readOnly: true
        configurationCompleted:
          type: boolean
          description: "Indicates whether the identity provider configuration is completed.\n>If configuration is not completed, an identity provider is not available on the authorization screen of the Veeam Service Provider Console web interface.\n>You can complete configuration by modifying this property using the PATCH operation.\n>If another identity provider is already enabled for an organization, this value cannot be modified.\n"
          default: false
        enabled:
          type: boolean
          description: Indicates whether an identity provider is enabled.
          default: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
    Saml2Configuration:
      required:
        - entityId
        - returnUrl
        - identityProviders
        - metadata
        - outboundSigningAlgorithm
        - minIncomingSigningAlgorithm
        - serviceCertificates
      type: object
      properties:
        entityId:
          type: string
          description: "Name that will be used for service provider when sending messages.\n"
        returnUrl:
          type: string
          description: "URL to which users are redirected once the authentication is complete.\n"
        modulePath:
          type: string
          description: "Base path of the SAML2 endpoints.\n"
          default: /Saml2
        authenticateRequestSigningBehavior:
          enum:
            - Never
            - Always
            - IfIdpWantAuthnRequestsSigned
          type: string
          description: "Type of AuthnRequest signing behavior.\n"
          default: IfIdpWantAuthnRequestsSigned
          x-ms-enum:
            name: Saml2AuthnRequestsSigningBehavior
        outboundSigningAlgorithm:
          enum:
            - RsaSha1
            - RsaSha256
            - RsaSha384
            - RsaSha512
          type: string
          description: "Default signing algorithm for messages that SAML2 generates.  \n"
          x-ms-enum:
            name: Saml2SigningAlgorithm
        minIncomingSigningAlgorithm:
          enum:
            - RsaSha1
            - RsaSha256
            - RsaSha384
            - RsaSha512
          type: string
          description: "Minimum strength of a signing algorithm for incoming messages.  \nIf the incoming message is signed with anything weaker, it can be rejected.\n"
          x-ms-enum:
            name: Saml2SigningAlgorithm
        validateCertificates:
          type: boolean
          description: Indicates whether the certificate validation is enabled.
          nullable: true
        publicOrigin:
          type: string
          description: Base URL of the SAML2 endpoints for external addresses.
          nullable: true
        requestedAuthnContext:
          $ref: '#/components/schemas/Saml2RequestedAuthnContextConfiguration'
        metadata:
          $ref: '#/components/schemas/Saml2MetadataConfiguration'
        identityProviders:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/Saml2IdentityProviderConfiguration'
          description: Array of identity providers known to a service provider.
        serviceCertificates:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/Saml2ServiceCertificateConfiguration'
          description: Array of certificates that a service provider uses for signing or decrypting SAML assertions.
        compatibility:
          $ref: '#/components/schemas/Saml2CompatibilityConfiguration'
      description: "Represents the `<sustainsys.saml2>` element of SAML2 configuration. For details, see the [Sustainsys.Saml2 documentation](https://saml2.sustainsys.com/en/v2/config-elements/sustainsys-saml2.html).\n"
    Saml2RequestedAuthnContextConfiguration:
      required:
        - classRef
        - comparison
      type: object
      properties:
        classRef:
          enum:
            - InternetProtocol
            - InternetProtocolPassword
            - Kerberos
            - MobileOneFactorUnregistered
            - MobileTwoFactorUnregistered
            - MobileOneFactorContract
            - MobileTwoFactorContract
            - Password
            - PasswordProtectedTransport
            - PreviousSession
            - X509
            - PGP
            - SPKI
            - XMLDSig
            - Smartcard
            - SmartcardPKI
            - SoftwarePKI
            - Telephony
            - NomadTelephony
            - PersonalTelephony
            - AuthenticatedTelephony
            - SecureRemotePassword
            - TLSClient
            - TimeSyncToken
            - unspecified
          type: string
          description: Class reference for the requested authentication context.
          x-ms-enum:
            name: Saml2AuthContext
        comparison:
          enum:
            - Exact
            - Minimum
            - Maximum
            - Better
          type: string
          description: Indicates how strictly the identity provider must match the requested AuthnContext.
          x-ms-enum:
            name: Saml2AuthContextComparison
      description: Configuration of the `<requestedAuthnContext>` element.
      nullable: true
    Saml2MetadataConfiguration:
      required:
        - organization
        - contactPerson
      type: object
      properties:
        cacheDuration:
          type: string
          description: Time period during which remote parties may cache metadata before refetching.
          default: PT1H
        validDuration:
          type: string
          description: Maximum time period during which metadata remains valid in case a refresh attempt fails.
          default: 7.00:00:00
        wantAssertionsSigned:
          type: boolean
          description: Indicates whether service provider requires signing Assertions in addition to signing the SAML response.
          default: true
        organization:
          $ref: '#/components/schemas/Saml2OrganizationConfiguration'
        contactPerson:
          $ref: '#/components/schemas/Saml2ContactPersonConfiguration'
        requestedAttributes:
          type: array
          items:
            $ref: '#/components/schemas/Saml2RequestedAttribute'
          description: Array of attributes that a service provider expects an identity provider to include in Assertions.
          nullable: true
      description: Configuration of generated service provider metadata.
    Saml2RequestedAttribute:
      required:
        - name
      type: object
      properties:
        name:
          type: string
          description: Unique name of an attribute.
        friendlyName:
          type: string
          description: "Friendy name of an attribute.\n"
          nullable: true
        nameFormat:
          enum:
            - Uri
            - Unspecified
            - Basic
          type: string
          description: Format of the `name` value.
          nullable: true
          x-ms-enum:
            name: Saml2RequestedAttributeFormat
        isRequired:
          type: boolean
          description: "Indicates whether an attribute is required by a service provider.     \n"
          nullable: true
    Saml2OrganizationConfiguration:
      required:
        - name
        - displayName
        - url
      type: object
      properties:
        name:
          type: string
          description: "Official name of an organization.\n"
        displayName:
          type: string
          description: "Friendly name of an organization.\n"
        url:
          type: string
          description: "URL of an organization public website.\n"
        language:
          type: string
          description: Language specification of the organization metadata.
          default: en
      description: Organization that supplies a SAML2 entity.
    Saml2ContactPersonConfiguration:
      required:
        - email
      type: object
      properties:
        type:
          enum:
            - Administrative
            - Billing
            - Other
            - Support
            - Technical
          type: string
          description: 'Type of contact. Common values include `Technical`, `Support`, or `Other`.'
          default: Other
          x-ms-enum:
            name: Saml2ContactType
        company:
          type: string
          description: Name of a contact person company.
          nullable: true
        givenName:
          type: string
          description: First name of a contact person
          nullable: true
        surname:
          type: string
          description: Last name of a contact person.
          nullable: true
        phoneNumber:
          type: string
          description: Telephone number of a contact person.
          nullable: true
        email:
          type: string
          description: "Email address of a contact person.\n> This property is required.\n"
      description: Contact person for a service provider.
    Saml2IdentityProviderConfiguration:
      required:
        - entityId
      type: object
      properties:
        entityId:
          type: string
          description: Issuer name or unique URI that an identity provider uses when sending responses.
        signOnUrl:
          type: string
          description: URL to which authentication requests are sent if metadata autoloading is not being used.
          nullable: true
        wantAuthnRequestsSigned:
          type: boolean
          description: "Indicates whether an identity provider requires authentication requests signed.\n> If the property value is `null`, it is treated as the `false` value.\n"
          nullable: true
        binding:
          enum:
            - HttpRedirect
            - HttpPost
            - Artifact
          type: string
          description: "Type of binding that a services provider should use when sending requests to an identity provider.            \n"
          nullable: true
          x-ms-enum:
            name: Saml2BindingType
        allowUnsolicitedAuthnResponse:
          type: boolean
          description: "Indicates whether an identity provider can initiate sign-on without prior authentication request.\n"
          default: false
        loadMetadata:
          type: boolean
          description: Indicates whether service provider loads the identity provider metadata for it to override the data in the configuration.
          default: true
        outboundSigningAlgorithm:
          enum:
            - RsaSha1
            - RsaSha256
            - RsaSha384
            - RsaSha512
          type: string
          description: Overrides the default signing algorithm for messages sent to an identity provider.
          nullable: true
          x-ms-enum:
            name: Saml2SigningAlgorithm
        metadataLocation:
          type: string
          description: "URL or path to a file containing identity provider metadata that is used instead of `entityId` value.\n"
          nullable: true
      description: Identity provider configuration.
    Saml2CompatibilityConfiguration:
      type: object
      properties:
        ignoreMissingInResponseTo:
          type: boolean
          description: Indicates whether SAML2 must ignore the lack of the `InResponseTo` attribute in identity provider responses.
          default: false
        ignoreAuthenticationContextInResponse:
          type: boolean
          description: Indicates whether SAML2 must ignore the `<AuthnContext>` element in identity provider responses.
          nullable: true
        unpackEntitiesDescriptorInIdentityProviderMetadata:
          type: boolean
          description: Indicates whether SAML2 must automatically use the `EntityDescriptor` value in case it is the only such value in the `EntitiesDescriptor` element of the identity provider metadata.
          nullable: true
      description: Configuration for processing of identity provider with non-standard behavior.
      x-veeam-create-by-default: true
    Saml2ServiceCertificateConfiguration:
      type: object
      properties:
        use:
          enum:
            - Both
            - Signing
            - Encryption
          type: string
          description: Type of certificate purpose.
          default: Both
          x-ms-enum:
            name: Saml2ServiceCertificateUse
        status:
          enum:
            - Current
            - Future
          type: string
          description: Indicates whether certificate is currently in use or will be used in the future.
          default: Current
          x-ms-enum:
            name: Saml2ServiceCertificateStatus
        privateKeyContent:
          type: string
          description: "Private key content in base64 format.\n> You can use the `GenerateNewPkcs12KeyPair` operation to generate a key.\n> For identity provider configuration, this property is required.\n"
          format: password
          nullable: true
          writeOnly: true
        certificateThumbprint:
          type: string
          description: Thumbprint of a currently used certificate.
          nullable: true
          readOnly: true
        storeName:
          type: string
          description: Name of a certificate store.
          nullable: true
          readOnly: true
        storeLocation:
          type: string
          description: Location of a certificate store.
          nullable: true
          readOnly: true
        x509FindType:
          type: string
          description: "Type of an expression used to serch for a certificate according to \n"
          nullable: true
          readOnly: true
        metadataPublishOverride:
          enum:
            - None
            - PublishUnspecified
            - PublishEncryption
            - PublishSigning
            - DoNotPublish
          type: string
          description: "Type of certificate usage rule that overrides the default certificate usage rule.\n> For datails on certificate usage rules, see the [Sustainsys.Saml2 documentation](https://saml2.sustainsys.com/en/v2/config-elements/service-certificates.html).\n"
          nullable: true
          x-ms-enum:
            name: Saml2MetadataPublishOverride
      description: Settings for certificate signing and encryption.
    IdentityProviderRoleMappingRule:
      required:
        - name
        - role
        - attributeMappingRules
        - organizationMappingSourceClaimType
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a mapping rule.
          format: uuid
          readOnly: true
        name:
          maxLength: 50
          minLength: 1
          type: string
          description: Name of a mapping rule. Each mapping rule configured for a single identity provider must have a unique name.
        providerName:
          type: string
          description: Name of an identity provider.
          readOnly: true
        description:
          maxLength: 500
          minLength: 1
          type: string
          description: Mapping rule description.
          nullable: true
        role:
          enum:
            - Unknown
            - PortalAdministrator
            - PortalOperator
            - PortalReadonlyOperator
            - CompanyLocationUser
            - CompanyLocationAdministrator
            - CompanyOwner
            - CompanyAdministrator
            - CompanyInvoiceAuditor
            - ResellerOwner
            - ResellerOperator
            - ResellerUser
            - ResellerInvoiceAuditor
            - ResellerAdministrator
            - CompanyTenant
          type: string
          description: "User role.\n"
          x-ms-enum:
            name: SsoRoles
          x-extensible-enum: true
        enabled:
          type: boolean
          description: Indicates whether a mapping rule is enabled.
          default: true
        managedCompaniesUids:
          type: array
          items:
            type: string
            format: uuid
          description: "Array of UIDs assigned to companies managed by a user.\n>Required for the `PortalOperator`, `PortalReadonlyOperator`, `ResellerOperator`, `ResellerUser` \nand `ResellerAdministrator` user roles.\n"
          nullable: true
        manageAllCompanies:
          type: boolean
          description: Indicates whether a user must manage all available companies. Overrides values of the `managedCompaniesUids` property.
          default: true
        hasAccessToProvider:
          type: boolean
          description: "Indicates whether a user is permitted to view service provider organization resources.\n>Required for the `PortalOperator` and `PortalReadonlyOperator` user roles.\n"
          nullable: true
        organizationMappingSourceClaimType:
          maxLength: 2048
          minLength: 1
          type: string
          description: Organization mapping claim type containing organization alias.
        locationsMappingSourceClaimType:
          maxLength: 2048
          minLength: 1
          type: string
          description: "Location mapping claim containing user locations in the following format: `Location1;Location2`.\n>This property can be specified for the `CompanyLocationUser`, `CompanyLocationAdministrator` and `CompanySubtenant` user roles. Otherwise a user is assigned to the first available company location.\n"
          nullable: true
        companyTenantMappingClaims:
          $ref: '#/components/schemas/IdentityProviderCompanyTenantMappingParameters'
        additionalMappings:
          type: array
          items:
            $ref: '#/components/schemas/IdentityProviderClaimMatchRule'
          description: Array of additional mappings required for rule selection.
          nullable: true
        attributeMappings:
          type: array
          items:
            $ref: '#/components/schemas/IdentityProviderAttributeMapping'
          description: Array of mapping claims attributed to user parameters.
          nullable: true
        _embedded:
          properties:
            providerInfo:
              type: object
              allOf:
                - $ref: '#/components/schemas/IdentityProvider'
              description: Resource representation of an identity provider.
              nullable: true
              readOnly: true
          description: Resource representation of the related identity provider entity.
          nullable: true
      example:
        name: Portal operators
        desciption: Portal operators from ADFS
        role: PortalOperator
        managedCompaniesUids:
          - ab452a99-51bf-4a40-a1c4-df01506f56a3
          - d8ba8d10-f2fb-4592-8c41-184d0e1b03f1
        organizationMappingSourceClaimType: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/ComanyNameAndAlias
        additionalMappings:
          - claimType: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress
            operator: Contains
            value: '@mycompany.com'
            matchCase: false
        attributeMappings:
          - claimType: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/firstName
            allowAliases: true
            attribute: FirstName
          - claimType: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/lastName
            allowAliases: true
            attribute: LastName
          - claimType: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name
            allowAliases: true
            attribute: Name
          - claimType: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/address
            allowAliases: true
            attribute: Address
          - claimType: http://schemas.xmlsoap.org/ws/2005/05/identity/claims/phone
            allowAliases: true
            attribute: Phone
        providerInfo:
          name: adfs
          displayName: Microsoft Entra ID Federation Services
          template: ADFS
          type: SAML2
          organizationUid: 0242e3ca-1cc2-4d90-8285-0e7a9b375418
          enabled: true
    IdentityProviderClaimMatchRule:
      required:
        - claimType
        - matchCase
        - operator
        - value
      type: object
      properties:
        claimType:
          maxLength: 2048
          minLength: 1
          type: string
          description: Mapping claim type.
        operator:
          enum:
            - Unknown
            - Equals
            - NotEquals
            - Contains
            - NotContains
            - MatchRegex
          type: string
          description: Logical operator.
          x-extensible-enum: true
          x-ms-enum:
            name: IdPClaimMappingOperators
        value:
          maxLength: 2048
          minLength: 1
          type: string
          description: Mapping claim value.
        matchCase:
          type: boolean
          description: Indicates whether value comparison must be case sensitive.
    IdentityProviderAttributeMapping:
      required:
        - attribute
        - claimType
      type: object
      properties:
        claimType:
          maxLength: 2048
          minLength: 1
          type: string
          description: Mapping claim type.
        allowAliases:
          type: boolean
          description: Indicates whether mapping claim name can be identified automatically.
          default: true
        attribute:
          enum:
            - Unknown
            - FirstName
            - LastName
            - Name
            - Address
            - Phone
          type: string
          description: User parameter to which a claim type is mapped.
          x-extensible-enum: true
          x-ms-enum:
            name: IdPMappingUserAttributes
        defaultValue:
          maxLength: 2048
          type: string
          description: Default attribute value.
          nullable: true
    SiteWanAcceleratorResource:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a WAN accelerator.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a WAN accelerator.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
      example:
        instanceUid: 447AC327-3D08-4F51-9D36-ECA703D4565A
        name: BACKUPWANACC01
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
    IdentityProviderCompanyTenantMappingParameters:
      required:
        - siteNameSourceClaimType
        - tenantNameSourceClaimType
      type: object
      properties:
        siteNameSourceClaimType:
          maxLength: 2048
          minLength: 1
          type: string
          description: Claim containing a name of a Veeam Cloud Connect site.
        tenantNameSourceClaimType:
          maxLength: 2048
          minLength: 1
          type: string
          description: Claim containing name of a tenant.
      description: Parameters required to create a mapping rule for users with `CompanyTenant` role.
      nullable: true
    BackupServerAgent:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          nullable: true
          readOnly: true
        name:
          type: string
          description: Name of a Veeam backup agent.
          nullable: true
          readOnly: true
        machineName:
          type: string
          description: DNS name of a machine on which a Veeam backup agent is installed.
          nullable: true
          readOnly: true
        guestOs:
          type: string
          description: Operating system installed on a computer.
          nullable: true
          readOnly: true
        version:
          type: string
          description: Version of a Veeam backup agent.
          nullable: true
          readOnly: true
        biosUid:
          type: string
          description: UUID in Win32_ComputerSystem WMI class.
          format: uuid
          nullable: true
          readOnly: true
        ipAddresses:
          type: array
          items:
            type: string
          description: Computer IP addresses.
          nullable: true
          readOnly: true
        protectionGroups:
          type: array
          items:
            type: string
            format: uuid
          description: Protection group UIDs.
          nullable: true
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server that manages a Veeam backup agent.
          format: uuid
          readOnly: true
        isUnmanaged:
          type: boolean
          description: Indicates whether a Veeam backup agent is unmanaged.
          nullable: true
          readOnly: true
        installationStatus:
          enum:
            - Unknown
            - NotInstalled
            - Installed
            - RebootRequired
            - Failed
            - UnsupportedOs
            - NotInitialized
          type: string
          description: Status of Veeam backup agent installation.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentInstallationStatus
        license:
          enum:
            - Unknown
            - Server
            - Workstation
            - Limited
          type: string
          description: Type of a Veeam backup agent license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentLicense
        licenseStatus:
          enum:
            - Unknown
            - Licensed
            - Unlicensed
            - LicenseRevoked
          type: string
          description: Status of a Veeam backup agent license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentLicenseStatus
        osType:
          enum:
            - Unknown
            - Windows
            - Linux
            - Mac
          type: string
          description: Type of a Veeam backup agent operating system.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentOsType
    BackupRepository:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a backup repository.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        _embedded:
          $ref: '#/components/schemas/BackupRepositoryInfo'
      example:
        instanceUid: 85C41EAE-A598-49C5-B92C-9E5138D170EC
        name: BACKUPREPOSITORY01
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
    BackupRepositoryInfo:
      type: object
      properties:
        parentRepositoryUid:
          type: string
          description: UID assigned to a scale-out backup repository which includes the backup repository as an extent.
          format: uuid
          nullable: true
          readOnly: true
        perVMBackupFiles:
          type: boolean
          description: Indicates whether the per-VM backup job option is enabled in the backup repository settings. VM backup files option in the repository settings is enabled. Displays if the per-VM backup job option is enabled or not in the backup repository settings.
          nullable: true
          readOnly: true
        capacity:
          type: integer
          description: 'Total disk space of backup repository, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        isCapacityAvailable:
          type: boolean
          description: Indicates whether information about total disk space is available.
          readOnly: true
        freeSpace:
          type: integer
          description: 'Free disk space of a backup repository, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        isFreeSpaceAvailable:
          type: boolean
          description: Indicates whether a backup repository has free space.
          readOnly: true
        usedSpace:
          type: integer
          description: 'Amount of used space on a backup repository, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        isUsedSpaceAvailable:
          type: boolean
          description: Indicates whether information about used space is available.
          readOnly: true
        backupSize:
          type: integer
          description: 'Total size of all restore points, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        isImmutabilityEnabled:
          type: boolean
          description: Indicates whether immutability is enabled.
          nullable: true
          readOnly: true
        immutabilityInterval:
          type: integer
          description: 'Duration of an immutability period, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        type:
          enum:
            - Unknown
            - Windows
            - Linux
            - Share
            - Cloud
            - ScaleOut
            - MicrosoftAzureBlobStorage
            - AmazonS3
            - AmazonS3Compatible
            - AmazonS3External
            - AzureExternal
            - DellEmcDataDomain
            - HpeStoreOnce
            - QuantumDxi
            - IbmCloudObjectStorage
            - NFS
            - ExaGrid
            - MicrosoftAzureArchive
            - MicrosoftAzureDataBox
            - GoogleCloud
            - Infinidat
            - Fujitsu
            - AmazonS3Glacier
            - S3Compatible
            - LinuxHardened
            - SanSnapshot
            - AmazonSnowball
            - GoogleArchiveTier
            - Wasabi
            - AzureArchiveTier
            - VeeamVault
            - ElevenEleven
          type: string
          description: Type of a backup repository.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupRepositoryType
        cloudRepositoryUid:
          type: string
          description: UID assigned to a backup repository if it is used as a cloud repository.
          format: uuid
          nullable: true
          readOnly: true
        path:
          type: string
          description: Path to the folder where backup files are stored.
          readOnly: true
        hostName:
          type: string
          description: Name of a computer that performs a role of a backup repository.
          readOnly: true
        hostUid:
          type: string
          description: UID assigned to a computer that performs a role of a backup repository.
          format: uuid
          nullable: true
          readOnly: true
        isOutOfDate:
          type: boolean
          description: Indicates whether a backup repository service is outdated.
          readOnly: true
        status:
          enum:
            - Unknown
            - Healthy
            - Warning
            - Error
          type: string
          description: Status of a backup repository.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupRepositoryStatus
        isCloud:
          type: boolean
          description: Indicates whether a backup repository is used as a cloud repository.
          readOnly: true
      nullable: true
    BackupWanAccelerator:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a WAN accelerator.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a WAN accelerator.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        version:
          type: string
          description: Version of a WAN accelerator service.
          readOnly: true
        hostUid:
          type: string
          description: UID assigned to a computer that performs a role of a WAN accelerator.
          format: uuid
          readOnly: true
        hostName:
          type: string
          description: Name of a computer that performs a role of a WAN accelerator.
          readOnly: true
        isOutOfDate:
          type: boolean
          description: Indicates whether a WAN accelerator service is outdated.
          readOnly: true
        status:
          enum:
            - Unknown
            - Healthy
            - Warning
            - Error
          type: string
          description: WAN accelerator status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupWanAcceleratorStatus
        isCloud:
          type: boolean
          description: Indicates whether a WAN accelerator is used in the Veeam Cloud Connect infrastructure.
          readOnly: true
      example:
        instanceUid: 7eced22b-5e67-45e1-bc00-37e399903bed
        name: BACKUPWAN01
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
    BackupServerAgentJob:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        totalJobsCount:
          type: integer
          description: Number of job sessions.
          format: int32
          readOnly: true
        successJobsCount:
          type: integer
          description: Number of successful job sessions.
          format: int32
          readOnly: true
        destination:
          type: string
          description: Location of backup files.
          readOnly: true
        source:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerAgentJobSource'
          description: Backup scope settings.
          nullable: true
          readOnly: true
        jobMode:
          enum:
            - Unknown
            - ManagedByBackupServer
            - ManagedByAgent
          type: string
          description: Status of the latest job session
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentJobMode
        osType:
          enum:
            - Unknown
            - Windows
            - Linux
            - Mac
          type: string
          description: Type of a protected computer operating system.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentJobOsType
        licenseType:
          enum:
            - Unknown
            - Server
            - Workstation
            - Limited
          type: string
          description: License type of a backup job.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentJobLicenseType
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerAgentJobSource:
      type: object
      properties:
        backupMode:
          enum:
            - Unknown
            - EntireComputer
            - Volume
            - File
          type: string
          description: Backup mode.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentJobBackupMode
        backupUserFolders:
          type: boolean
          description: Indicates whether a backup job protects individual folders.
          readOnly: true
        backupOperatingSystem:
          type: boolean
          description: Indicates whether agent operating system is included in a backup scope.
          readOnly: true
        fileSystemItems:
          type: object
          properties:
            volumes:
              type: array
              items:
                type: string
              description: 'Array of drive letters in the following format: `C:\`'
              readOnly: true
            filesAndFolders:
              type: array
              items:
                type: string
              description: Array of protected files and folders.
              readOnly: true
          description: Files and folders of an agent computer are included in a backup scope.
          nullable: true
          readOnly: true
    BackupServerAgentJobObject:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job object in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job object in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          nullable: true
          readOnly: true
        agentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          nullable: true
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        computer:
          type: string
          description: Computer name of a Veeam backup agent.
          nullable: true
          readOnly: true
        backupStatus:
          enum:
            - Unknown
            - None
            - Success
            - Warning
            - Failed
            - Running
          type: string
          description: Status of a job.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentJobObjectStatus
        lastRun:
          type: string
          description: Date and time when the latest job session started.
          format: date-time
          nullable: true
          readOnly: true
        lastEndTime:
          type: string
          description: Date and time when the latest job session ended.
          format: date-time
          nullable: true
          readOnly: true
        lastDuration:
          type: integer
          description: 'Duration of the latest job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        restorePointsCount:
          type: integer
          description: Number of restore points available in the backup chain.
          format: int32
          readOnly: true
        osType:
          enum:
            - Unknown
            - Windows
            - Linux
            - Mac
          type: string
          description: Type of a protected computer operating system.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerAgentJobOsType
        failureMessage:
          type: string
          description: "Message that is displayed in case a backup job fails.\n> Every line break is represented by the `\\r\\n` control characters.\n"
          nullable: true
          readOnly: true
    BackupServerJob:
      required:
        - status
        - isEnabled
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a job.
          readOnly: true
        description:
          type: string
          description: Description of a job.
          readOnly: true
        createdBy:
          type: string
          description: Name of a user that created a job.
          readOnly: true
        creationTime:
          type: string
          description: Date and time when a job was created.
          format: date-time
          nullable: true
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server location.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          nullable: true
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization that owns a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        mappedOrganizationUid:
          type: string
          description: UID assigned to an organization to whom the job is assigned.
          format: uuid
          nullable: true
          readOnly: true
        status:
          enum:
            - Unknown
            - None
            - Idle
            - Success
            - Warning
            - Failed
            - Running
            - Starting
            - Stopping
            - Enabling
            - Disabling
            - WaitingTape
            - WaitingRepository
          type: string
          description: "Status of the latest job session.\n> Can be changed to `Running` or `Stopping` using the PATCH operation.\n"
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerJobStatus
        type:
          enum:
            - Unknown
            - BackupVm
            - ReplicationVM
            - CopyVm
            - CopyFile
            - FileToTape
            - BackupToTape
            - BackupCopy
            - SimpleBackupCopy
            - SqlLogBackup
            - OracleLogBackup
            - SureBackup
            - AgentPolicy
            - AgentBackupJob
            - BackupFile
            - BackupFileCopy
            - AzureBackupJob
            - AwsBackupJob
            - AhvStorageSnapshotJob
            - CdpReplicationVM
            - GoogleBackupJob
            - PostgreSqlLogBackup
            - ObjectStorageBackup
            - ObjectStorageBackupCopy
            - SobrMaintenance
          type: string
          description: Type of a job.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerJobType
        lastRun:
          type: string
          description: Date and time when the latest job session started.
          format: date-time
          nullable: true
          readOnly: true
        lastEndTime:
          type: string
          description: Date and time when the latest job session ended.
          format: date-time
          nullable: true
          readOnly: true
        lastDuration:
          type: integer
          description: 'Duration of the latest job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        processingRate:
          type: number
          description: Rate at which VM data was processed during the latest job session.
          format: float
          nullable: true
          readOnly: true
        avgDuration:
          type: integer
          description: 'Average time a job session takes to complete, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        transferredData:
          type: integer
          description: 'Total amount of data that was transferred to target during the latest job session, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        backupChainSize:
          type: integer
          description: "Size of all backup files created by the backup job, in bytes.\n> Available only for VMware vSphere and Microsoft HyperV VMs.\n"
          format: int64
          nullable: true
          readOnly: true
        bottleneck:
          enum:
            - Unknown
            - Network
            - None
            - Proxy
            - Source
            - SourceWanAccelerator
            - Target
            - TargetWanAccelerator
          type: string
          description: Bottleneck in the process of transferring the data from source to target.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerJobBottleneckType
        isEnabled:
          type: boolean
          description: "Indicates whether a job schedule is enabled. \n> Can be changed using the PATCH operation.\n"
        scheduleType:
          enum:
            - Unknown
            - NotScheduled
            - Daily
            - Monthly
            - Periodically
            - Continuously
            - BackupWindow
            - Chained
          type: string
          description: Type of a schedule configured for a job.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerJobScheduleType
        failureMessage:
          type: string
          description: "Message that is displayed in case a backup job fails. \n> Every line break is represented by the `\\r\\n` control characters.\n"
          nullable: true
          readOnly: true
        targetType:
          enum:
            - Unknown
            - Local
            - Cloud
            - None
          type: string
          description: Type of a target backup location.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerJobTargetType
        destination:
          type: string
          description: Name of a target backup location.
          nullable: true
          readOnly: true
        retentionLimit:
          type: integer
          description: Number of retention policy units.
          format: int32
          nullable: true
          readOnly: true
        retentionLimitType:
          enum:
            - Unknown
            - Days
            - RestorePoints
            - None
          type: string
          description: Type of retention policy units.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: RetentionLimitType
        isGfsOptionEnabled:
          type: boolean
          description: Indicates whether the GFS retention is enabled.
          readOnly: true
        lastSessionTasks:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerJobSessionTask'
          description: "Latest job session tasks.\n> Available only for VM backup and replication jobs.\n"
          readOnly: true
      example:
        instanceUid: EDEB5975-B409-49B5-8ECE-FFFECB13494F
        name: Web server Backup to Cloud
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        status: Success
        type: BackupVm
        lastRun: '2016-11-01T10:35:28.0000000-07:00'
        endTime: '2016-11-01T10:40:56.0000000-07:00'
        duration: 328
        processingRate: 17
        avgDuration: 328
        transferredData: 1052
        bottleneck: Source
        isEnabled: true
        scheduleType: Periodically
        retentionLimit: 14
        retentionLimitType: RestorePoints
        isGfsOptionEnabled: true
    BackupServerJobSessionTask:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job session task.
          format: uuid
          readOnly: true
        objectUid:
          type: string
          description: UID assigned to an object included in a job.
          format: uuid
          nullable: true
          readOnly: true
        objectName:
          type: string
          description: Name of an object included in a job.
          nullable: true
          readOnly: true
        totalObjects:
          type: integer
          description: Number of objects included in a job.
          format: int64
          nullable: true
          readOnly: true
        processedObjects:
          type: integer
          description: Number of objects processed by a job session.
          format: int64
          nullable: true
          readOnly: true
        readDataSize:
          type: integer
          description: Size of object data that a job processes.
          format: int64
          nullable: true
          readOnly: true
        transferredDataSize:
          type: integer
          description: Size of processed object data.
          format: int64
          nullable: true
          readOnly: true
        startTime:
          type: string
          description: Start date and time of a job session task.
          format: date-time
          nullable: true
          readOnly: true
        endTime:
          type: string
          description: End date and time of a job session task.
          format: date-time
          nullable: true
          readOnly: true
        duration:
          type: integer
          description: 'Duration of a job session task, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        failureMessages:
          type: array
          items:
            type: string
          description: Messages containing information on job session task errors.
          nullable: true
          readOnly: true
        status:
          enum:
            - Unknown
            - Success
            - Warning
            - Failed
            - Running
            - Pending
          type: string
          description: Status of a job session task.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BBackupServerJobSessionTaskStatus
    EmbeddedForBackupServerJobChildren:
      type: object
      properties:
        backupServerJob:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerJob'
          description: Resource representation of a job.
          nullable: true
          readOnly: true
      description: Resource representation of the related Veeam Backup & Replication server job entity.
      nullable: true
      readOnly: true
    BackupServerFileShareJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        targetRepositoryUid:
          type: string
          description: UID assigned to a target backup repository.
          format: uuid
          readOnly: true
        archiveRepositoryUid:
          type: string
          description: UID assigned to an archive repository.
          format: uuid
          nullable: true
          readOnly: true
        retention:
          type: integer
          description: Duration of file retention.
          format: int32
          readOnly: true
        retentionUnit:
          enum:
            - Minutes
            - Hours
            - Days
            - Months
            - Years
          type: string
          description: Measurement units of file retention duration.
          readOnly: true
          x-ms-enum:
            name: TimeMeasureUnit
        isArchiveRetentionEnabled:
          type: boolean
          description: Indicates whether long-term file retention is enabled.
          readOnly: true
        archiveRetention:
          type: integer
          description: Duration of long-term file retention.
          format: int32
          readOnly: true
        archiveRetentionUnit:
          enum:
            - Minutes
            - Hours
            - Days
            - Months
            - Years
          type: string
          description: Measurement units of long-term file retention duration.
          readOnly: true
          x-ms-enum:
            name: TimeMeasureUnit
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerFileShareJobObject:
      properties:
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        fileShareUid:
          type: string
          description: UID assigned to a file share server.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a file share.
          readOnly: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerFileJobObjectSource'
          description: Processed files and folders.
          readOnly: true
        lastSession:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerFileShareJobObjectLastSession'
          description: Information about the latest job session.
          readOnly: true
    BackupServerFileShareCopyJobObject:
      properties:
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        fileShareUid:
          type: string
          description: UID assigned to a file share server.
          format: uuid
          readOnly: true
        path:
          type: string
          description: Path to a location of protected data.
          readOnly: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerFileJobObjectSource'
          description: Processed files and folders.
          readOnly: true
        lastSession:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerJobObjectLastSession'
          description: Information about the latest job session.
          readOnly: true
    BackupServerFileJobObjectSource:
      properties:
        path:
          type: string
          description: Path to a location of protected data.
          readOnly: true
        type:
          enum:
            - Unknown
            - File
            - Directory
          type: string
          description: Type of protected object.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerFileJobObjectType
        inclusionMasks:
          type: array
          items:
            type: string
          description: Names and name masks of files that must be included into a backup scope.
          readOnly: true
        exclusionMasks:
          type: array
          items:
            type: string
          description: Names and name masks of files that must be excluded from a backup scope.
          readOnly: true
    BackupServerFileTapeJobObject:
      properties:
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        hostName:
          type: string
          description: 'Host name of a server, on which protected files and folders reside.'
          readOnly: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerFileTapeJobObjectSource'
          description: Array of protected files and folders.
          readOnly: true
        lastSession:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerJobObjectLastSession'
          description: Resource representation of the latest job session.
          readOnly: true
    BackupServerFileTapeJobObjectSource:
      properties:
        path:
          type: string
          description: Path to a location where protected files and folders reside.
          readOnly: true
        type:
          enum:
            - Unknown
            - File
            - Directory
          type: string
          description: Type of a protected unit.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerFileJobObjectType
    BackupServerFileShareJobObjectLastSession:
      properties:
        backupStatus:
          enum:
            - Unknown
            - Running
            - Success
            - Warning
            - Failed
          type: string
          description: Status of a job.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerJobObjectLastSessionBackupStatus
        sourceFilesCount:
          type: integer
          description: Total number of files in all sources.
          format: int64
          nullable: true
          readOnly: true
        changedFilesCount:
          type: integer
          description: Number of processed files.
          format: int64
          nullable: true
          readOnly: true
        skippedFilesCount:
          type: integer
          description: Number of skipped files.
          format: int64
          nullable: true
          readOnly: true
        backedUpFilesCount:
          type: integer
          description: Number of backed up files.
          format: int64
          nullable: true
          readOnly: true
        transferredSize:
          type: integer
          description: 'Total size of backed up file share data, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        sourceSize:
          type: integer
          description: 'Total size of all source files, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        duration:
          type: integer
          description: 'Time taken to complete the latest job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        messages:
          type: array
          items:
            type: string
          description: Message that is displayed after a job session finishes.
          readOnly: true
    BackupServerJobObjectLastSession:
      properties:
        backupStatus:
          enum:
            - Unknown
            - Running
            - Success
            - Warning
            - Failed
          type: string
          description: Status of the latest job session.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerJobObjectLastSessionBackupStatus
        totalBackedSize:
          type: integer
          description: 'Size of backup files, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        sourceSize:
          type: integer
          description: 'Size of processed data, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        startTime:
          type: string
          description: Date and time when the latest job session started.
          format: date-time
          nullable: true
          readOnly: true
        endTime:
          type: string
          description: Date and time when the latest job session finished.
          format: date-time
          nullable: true
          readOnly: true
        duration:
          type: integer
          description: 'Time taken to complete the latest job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        messages:
          type: array
          items:
            type: string
          description: Array of job session messages.
          readOnly: true
    BackupServerBackupCopyJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        targetRepositoryUid:
          type: string
          description: UID assigned to a target repository.
          format: uuid
          readOnly: true
        targetWanAcceleratorUid:
          type: string
          description: UID assigned to a target WAN accelerator.
          format: uuid
          nullable: true
          readOnly: true
        sourceWanAcceleratorUid:
          type: string
          description: UID assigned to a source WAN accelerator.
          format: uuid
          nullable: true
          readOnly: true
        weeklyRestorePointsToKeep:
          type: integer
          description: Number of weeks during which the weekly backup must be stored on the target repository.
          format: int32
          readOnly: true
        monthlyRestorePointsToKeep:
          type: integer
          description: Number of months during which the monthly backup must be stored on the target repository.
          format: int32
          readOnly: true
        yearlyRestorePointsToKeep:
          type: integer
          description: Number of years during which the yearly backup must be stored on the target repository.
          format: int32
          readOnly: true
        retentionPolicyType:
          enum:
            - Unknown
            - None
            - Simple
            - GFS
          type: string
          description: Type of a retention policy of a backup copy job.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerBackupCopyJobRetentionPolicyType
        isRpoOptionsEnabled:
          type: boolean
          description: Indicates whether a warning is enabled in case backup copy job fails to complete within the specified RPO interval.
          readOnly: true
        rpoOptionsValue:
          type: integer
          description: Desired RPO interval value.
          format: int32
          readOnly: true
        rpoOptionsUnit:
          enum:
            - Minutes
            - Hours
            - Days
            - Months
            - Years
          type: string
          description: Measurement units of a desired RPO interval value.
          readOnly: true
          x-ms-enum:
            name: TimeMeasureUnit
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerSimpleBackupCopyJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        targetRepositoryUid:
          type: string
          description: UID assigned to a target backup repository.
          format: uuid
          readOnly: true
        targetWanAcceleratorUid:
          type: string
          description: UID assigned to a target WAN accelerator.
          format: uuid
          nullable: true
          readOnly: true
        sourceWanAcceleratorUid:
          type: string
          description: UID assigned to a source WAN accelerator.
          format: uuid
          nullable: true
          readOnly: true
        weeklyRestorePointsToKeep:
          type: integer
          description: Number of weeks during which the weekly backup must be stored on the target repository.
          format: int32
          readOnly: true
        monthlyRestorePointsToKeep:
          type: integer
          description: Number of months during which the monthly backup must be stored on the target repository.
          format: int32
          readOnly: true
        yearlyRestorePointsToKeep:
          type: integer
          description: Number of years during which the yearly backup must be stored on the target repository.
          format: int32
          readOnly: true
        retentionPolicyType:
          enum:
            - Unknown
            - None
            - Simple
            - GFS
          type: string
          description: Type of a retention policy of a backup copy job.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerBackupCopyJobRetentionPolicyType
        isRpoOptionsEnabled:
          type: boolean
          description: Indicates whether a warning is enabled in case backup copy job fails to complete within the specified RPO interval.
          readOnly: true
        rpoOptionsValue:
          type: integer
          description: Desired RPO interval value.
          format: int32
          readOnly: true
        rpoOptionsUnit:
          enum:
            - Minutes
            - Hours
            - Days
            - Months
            - Years
          type: string
          description: Measurement units of a desired RPO interval value.
          readOnly: true
          x-ms-enum:
            name: TimeMeasureUnit
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerFileShareCopyJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        sourceFileShareJobUid:
          type: string
          description: UID assigned to a source file share job in Veeam Backup & Replication
          format: uuid
          readOnly: true
        sourceFileShareJobUniqueUid:
          type: string
          description: UID assigned to a source file share job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        targetRepositoryUid:
          type: string
          description: UID assigned to a target backup repository.
          format: uuid
          readOnly: true
        retention:
          type: integer
          description: Duration of backup file retention.
          format: int32
          readOnly: true
        retentionUnit:
          enum:
            - Minutes
            - Hours
            - Days
            - Months
            - Years
          type: string
          description: Measurement units of backup file retention duration.
          readOnly: true
          x-ms-enum:
            name: TimeMeasureUnit
        sourceSize:
          type: integer
          description: 'Size of a job source, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerObjectStorageBackupCopyJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        sourceObjectStorageBackupJobUid:
          type: string
          description: UID assigned to a source object storage backup job.
          format: uuid
          readOnly: true
        targetRepositoryUid:
          type: string
          description: UID assigned to a target backup repository.
          format: uuid
          readOnly: true
        retention:
          type: integer
          description: Duration of backup file retention.
          format: int32
          readOnly: true
        retentionUnit:
          enum:
            - Minutes
            - Hours
            - Days
            - Months
            - Years
          type: string
          description: Measurement units of backup file retention duration.
          readOnly: true
          x-ms-enum:
            name: TimeMeasureUnit
        sourceSize:
          type: integer
          description: 'Size of a job source, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerObjectStorageBackupJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        targetRepositoryUid:
          type: string
          description: UID assigned to a target backup repository.
          format: uuid
          readOnly: true
        archiveRepositoryUid:
          type: string
          description: UID assigned to an archive repository.
          format: uuid
          nullable: true
          readOnly: true
        retention:
          type: integer
          description: Duration of file retention.
          format: int32
          readOnly: true
        retentionUnit:
          enum:
            - Minutes
            - Hours
            - Days
            - Months
            - Years
          type: string
          description: Measurement units of file retention duration.
          readOnly: true
          x-ms-enum:
            name: TimeMeasureUnit
        isArchiveRetentionEnabled:
          type: boolean
          description: Indicates whether long-term file retention is enabled.
          readOnly: true
        archiveRetention:
          type: integer
          description: Duration of long-term file retention.
          format: int32
          readOnly: true
        archiveRetentionUnit:
          enum:
            - Minutes
            - Hours
            - Days
            - Months
            - Years
          type: string
          description: Measurement units of long-term file retention duration.
          readOnly: true
          x-ms-enum:
            name: TimeMeasureUnit
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerObjectStorageBackupJobObject:
      properties:
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        objectStorageUid:
          type: string
          description: UID assigned to an object storage.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of an object storage.
          readOnly: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerFileJobObjectSource'
          description: Processed files and folders.
          readOnly: true
        lastSession:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerObjectStorageBackupJobObjectLastSession'
          description: Information about the latest job session.
          readOnly: true
    BackupServerObjectStorageBackupCopyJobObject:
      properties:
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        objectStorageUid:
          type: string
          description: UID assigned to an object storage.
          format: uuid
          readOnly: true
        path:
          type: string
          description: Path to a location of protected data.
          readOnly: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerFileJobObjectSource'
          description: Processed files and folders.
          readOnly: true
        lastSession:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerJobObjectLastSession'
          description: Information about the latest job session.
          readOnly: true
    BackupServerObjectStorageBackupJobObjectLastSession:
      properties:
        backupStatus:
          enum:
            - Unknown
            - Running
            - Success
            - Warning
            - Failed
          type: string
          description: Status of a job.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerJobObjectLastSessionBackupStatus
        sourceFilesCount:
          type: integer
          description: Number of source files.
          format: int64
          nullable: true
          readOnly: true
        changedFilesCount:
          type: integer
          description: Number of changed files.
          format: int64
          nullable: true
          readOnly: true
        skippedFilesCount:
          type: integer
          description: Number of skipped files.
          format: int64
          nullable: true
          readOnly: true
        backedUpFilesCount:
          type: integer
          description: Number of backed up files.
          format: int64
          nullable: true
          readOnly: true
        transferredSize:
          type: integer
          description: 'Total size of processed object storage backup data, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        sourceSize:
          type: integer
          description: 'Total size of all source files, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        duration:
          type: integer
          description: 'Duration of the latest job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        messages:
          type: array
          items:
            type: string
          description: Message that is displayed after a job session finishes.
          readOnly: true
    BackupServerFileCopyJob:
      required:
        - instanceUid
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        targetHostUid:
          type: string
          description: UID assigned to a target host.
          format: uuid
          nullable: true
          readOnly: true
        targetPath:
          type: string
          description: Path to a location on a target repository where copied files reside.
          nullable: true
          readOnly: true
        sourceSize:
          type: integer
          description: 'Size of a job source, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerVmCopyJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        targetRepositoryUid:
          type: string
          description: UID assigned to a target repository.
          format: uuid
          readOnly: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerBackupTapeJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        fullMediaPoolUid:
          type: string
          description: UID assigned to a media pool for full backups.
          format: uuid
          readOnly: true
        incrementalMediaPoolUid:
          type: string
          description: UID assigned to a media pool for full backups.
          format: uuid
          readOnly: true
        isGfsEnabled:
          type: boolean
          description: Indicates whether a job runs by GFS scheme.
          readOnly: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerJobLinkedJobObject:
      properties:
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        linkedJobUid:
          type: string
          description: UID assigned to a linked backup job.
          format: uuid
          readOnly: true
    BackupServerJobLinkedRepositoryObject:
      properties:
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        linkedRepositoryUid:
          type: string
          description: UID assigned to a linked job backup repository.
          format: uuid
          readOnly: true
    BackupServerFileTapeJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        fullMediaPoolUid:
          type: string
          description: UID assigned to a media pool for full backups.
          format: uuid
          readOnly: true
        incrementalMediaPoolUid:
          type: string
          description: UID assigned to a media pool for increment backups.
          format: uuid
          readOnly: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerBackupVmJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        subtype:
          enum:
            - Unknown
            - VSphere
            - Vcd
            - HyperV
            - NutanixAhv
            - OVirtKvm
            - ProxmoxVe
            - ScaleComputing
          type: string
          description: VM platform.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerBackupVmJobHypervisorType
        targetRepositoryUid:
          type: string
          description: UID assigned to a target repository.
          format: uuid
          readOnly: true
        protectedVmCount:
          type: integer
          description: Number of VMs included in a job.
          format: int32
          readOnly: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerCdpReplicationJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        rpo:
          type: integer
          description: RPO value.
          format: int32
          readOnly: true
        rpoUnit:
          enum:
            - Unknown
            - Hours
            - Minutes
            - Seconds
            - Days
          type: string
          description: RPO measurement units.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerCdpReplicationRetentionUnit
        shortTermRetention:
          type: integer
          description: Short-term retention value.
          format: int32
          readOnly: true
        shortTermRetentionUnit:
          enum:
            - Unknown
            - Hours
            - Minutes
            - Seconds
            - Days
          type: string
          description: Short-term retention measurement units.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerCdpReplicationRetentionUnit
        longTermRetention:
          type: integer
          description: Long-term retention value.
          format: int32
          readOnly: true
        longTermRetentionUnit:
          enum:
            - Unknown
            - Hours
            - Minutes
            - Seconds
            - Days
          type: string
          description: Long-term retention measurement units.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerCdpReplicationRetentionUnit
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
        keepRestorePointsInDays:
          type: integer
          description: Number of days for which long-term retention points must be retained.
          format: int32
          readOnly: true
        sourceProxyAutoDetect:
          type: boolean
          description: Indicates whether Veeam Backup & Replication must select a source proxy automatically.
          readOnly: true
        targetProxyAutoDetect:
          type: boolean
          description: Indicates whether Veeam Backup & Replication must select a target proxy automatically.
          readOnly: true
        isApplicationAwareEnabled:
          type: boolean
          description: Indicates whether the application-aware processing is enabled.
          readOnly: true
        lastPeriod:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerCdpReplicationJobLastPeriod'
          description: Information on data collected during the period between the creation of two long-term restore points.
          nullable: true
          readOnly: true
        lastDay:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerCdpReplicationJobLastDay'
          description: Information on data collected during the last 24-hour period.
          nullable: true
          readOnly: true
    BackupServerCdpReplicationJobObject:
      type: object
      properties:
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        instanceUid:
          type: string
          description: UID assigned to a VM.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a VM.
          readOnly: true
        status:
          enum:
            - Unknown
            - Success
            - Failed
            - Warning
            - InProgress
            - Pending
          type: string
          description: Task session status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerCdpReplicationJobObjectStatus
        failureMessage:
          type: string
          description: Message that is displayed in case a task session fails.
          readOnly: true
        lastSessionEndTime:
          type: string
          description: Date and time when the latest session finished.
          format: date
          nullable: true
          readOnly: true
        sla:
          type: integer
          description: Percentage of sessions completed within the configured RPO.
          format: int32
          readOnly: true
        bottleneck:
          enum:
            - Unknown
            - NotDefined
            - None
            - Source
            - Proxy
            - Network
            - Target
            - Throttling
            - SourceWan
            - TargetWan
            - SourceNetwork
            - SourceProxy
            - TargetProxy
            - TargetNetwork
            - TargetDisk
          type: string
          description: Bottleneck in the data transmission process.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerCdpReplicationJobBottleneckType
        maxDelaySec:
          type: integer
          description: 'Difference between the configured RPO and time required to transfer and save data, in seconds.'
          format: int64
          readOnly: true
        avgDurationSec:
          type: integer
          description: 'Average duration of a syncronization session, in seconds.'
          format: int64
          nullable: true
          readOnly: true
        maxDurationSec:
          type: integer
          description: 'Maximum duration of a syncronization session, in seconds.'
          format: int64
          nullable: true
          readOnly: true
        intervalSec:
          type: integer
          description: 'Duration of a synchronization session configured in the policy, in seconds.'
          format: int32
          readOnly: true
        successfulSessionsCount:
          type: integer
          description: Number of task sessions completed with the `Success` status.
          format: int32
          readOnly: true
        failedSessionsCount:
          type: integer
          description: Number of task sessions completed with the `Failed` status.
          format: int32
          readOnly: true
        warningsCount:
          type: integer
          description: Number of task sessions completed with the `Warning` status.
          format: int32
          readOnly: true
        avgTransferredDataKb:
          type: integer
          description: 'Avarage amount of data processed during the synchronization session, in kilobytes.'
          format: int64
          nullable: true
          readOnly: true
        maxTransferredDataKb:
          type: integer
          description: 'Maximum amount of data processed during the synchronization session, in kilobytes.'
          format: int64
          nullable: true
          readOnly: true
        totalTransferredDataKb:
          type: integer
          description: 'Total size of data processed during the synchronization session, in kilobytes.'
          format: int64
          nullable: true
          readOnly: true
    BackupServerCdpReplicationJobLastPeriod:
      properties:
        successCount:
          type: integer
          description: Number of task sessions completed with the `Success` status.
          format: int32
          readOnly: true
        warningCount:
          type: integer
          description: Number of task sessions completed with the `Warning` status.
          format: int32
          readOnly: true
        errorsCount:
          type: integer
          description: Number of task sessions completed with the `Error` status.
          format: int32
          readOnly: true
        averageData:
          type: integer
          description: 'Avarage amount of data processed during the synchronization session, in kilobytes.'
          format: int64
          nullable: true
          readOnly: true
        maximumData:
          type: integer
          description: 'Maximum amount of data processed during the synchronization session, in kilobytes.'
          format: int64
          nullable: true
          readOnly: true
        totalData:
          type: integer
          description: 'Total size of data processed during the synchronization session, in kilobytes.'
          format: int64
          nullable: true
          readOnly: true
        averageDuration:
          type: integer
          description: 'Average duration of a syncronization session, in seconds.'
          format: int64
          nullable: true
          readOnly: true
        maximumDuration:
          type: integer
          description: 'Maximum duration of a syncronization session, in seconds.'
          format: int64
          nullable: true
          readOnly: true
        syncInterval:
          type: integer
          description: 'Duration of a synchronization session configured in the policy, in seconds.'
          format: int64
          nullable: true
          readOnly: true
        sla:
          type: integer
          description: Percentage of sessions completed within the configured RPO.
          format: int32
          nullable: true
          readOnly: true
        maxDelay:
          type: integer
          description: 'Difference between the configured RPO and time required to transfer and save data, in seconds.'
          format: int64
          nullable: true
          readOnly: true
        bottleneck:
          enum:
            - Unknown
            - NotDefined
            - None
            - Source
            - Proxy
            - Network
            - Target
            - Throttling
            - SourceWan
            - TargetWan
            - SourceNetwork
            - SourceProxy
            - TargetProxy
            - TargetNetwork
            - TargetDisk
          type: string
          description: Bottleneck in the data transmission process.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerCdpReplicationJobBottleneckType
    BackupServerCdpReplicationJobLastDay:
      properties:
        successCount:
          type: integer
          description: Number of task sessions that have completed with the `Success` status.
          format: int32
          readOnly: true
        warningCount:
          type: integer
          description: Number of task sessions that have completed with the `Warning` status.
          format: int32
          readOnly: true
        errorsCount:
          type: integer
          description: Number of task sessions that have completed with the `Error` status.
          format: int32
          readOnly: true
        totalSize:
          type: integer
          description: 'Total size of the processed data, in kilobytes.'
          format: int64
          nullable: true
          readOnly: true
        readData:
          type: integer
          description: 'Amount of data read from the datastore prior to applying compression and deduplication, in kilobytes.'
          format: int64
          nullable: true
          readOnly: true
        transferredData:
          type: integer
          description: 'Amount of data transferred from the source proxy to the target proxy, in kilobytes.'
          format: int64
          nullable: true
          readOnly: true
        sla:
          type: integer
          description: Percentage of sessions completed within the configured RPO.
          format: int32
          nullable: true
          readOnly: true
        maxDelay:
          type: integer
          description: Difference between the configured RPO and time required to transfer and save data.
          format: int64
          nullable: true
          readOnly: true
        bottleneck:
          enum:
            - Unknown
            - NotDefined
            - None
            - Source
            - Proxy
            - Network
            - Target
            - Throttling
            - SourceWan
            - TargetWan
            - SourceNetwork
            - SourceProxy
            - TargetProxy
            - TargetNetwork
            - TargetDisk
          type: string
          description: Bottleneck in the data transmission process.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerCdpReplicationJobBottleneckType
    BackupServerReplicationVmJob:
      properties:
        instanceUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        protectedVmCount:
          type: integer
          description: Number of VMs included in a job.
          format: int32
          readOnly: true
        isCloudJob:
          type: boolean
          description: Indicates whether VM replicas are created on a cloud host.
          readOnly: true
        cloudHostUid:
          type: string
          description: UID assigned to a cloud host.
          format: uuid
          nullable: true
          readOnly: true
        targetHostUid:
          type: string
          description: UID assigned to a target host for VM replicas.
          format: uuid
          readOnly: true
        sourceWanAcceleratorUid:
          type: string
          description: UID assigned to a source WAN accelerator.
          format: uuid
          nullable: true
          readOnly: true
        targetWanAcceleratorUid:
          type: string
          description: UID assigned to a target WAN accelerator.
          format: uuid
          nullable: true
          readOnly: true
        throughWanAccelerators:
          type: boolean
          description: Indicates whether WAN acceleration is enabled.
          readOnly: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForBackupServerJobChildren'
    BackupServerVmJobObject:
      type: object
      properties:
        jobUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        uniqueJobUid:
          type: string
          description: UID assigned to a job in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        instanceUid:
          type: string
          description: UID assigned to a protected VM.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a VM.
          readOnly: true
        platform:
          enum:
            - Unknown
            - vSphere
            - HyperV
            - Vcd
          type: string
          description: VM platform.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupServerVmJobObjectPlatform
        hierarchyRef:
          type: string
          description: Reference ID of a VM.
          readOnly: true
        isExcluded:
          type: boolean
          description: Indicates whether the VM is excluded from a job.
          readOnly: true
        lastSession:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerJobObjectLastSession'
          description: Information about the latest job session.
          nullable: true
          readOnly: true
    VcdServer:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a VMware Cloud Director server.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a VMware Cloud Director server.
          readOnly: true
      example:
        instanceUid: EDEB5975-B409-49B5-8ECE-FFFECB13494F
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        name: Organization XOrg
    VcdOrganization:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization.
          format: uuid
          readOnly: true
        urn:
          type: string
          description: URN of a VMware Cloud Director organization. That identifier must be used on working with Vcd job configuration.
          readOnly: true
        name:
          type: string
          description: Name of a VMware Cloud Director organization.
          readOnly: true
        vcdServerUid:
          type: string
          description: UID assigned to a VMware Cloud Director server.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        hostedBackupServer:
          type: boolean
          description: Indicates whether an organization VMware Cloud Director server is connected to a hosted Veeam Backup & Replication server.
          readOnly: true
        canBeMappedAsHostedResource:
          type: boolean
          description: "Indicates whether a VMware Cloud Director organization can be mapped to a company as a hosted resource.\n> `false` value indicates that a VMware Cloud Director organization is not connected to a hosted Veeam Backup & Replication server or is already mapped to a company. \n"
          readOnly: true
    VcdOrganizationDataCenter:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to an organization VDC.
          format: uuid
          readOnly: true
        urn:
          type: string
          description: URN of an organization VDC. That identifier must be used on working with Vcd job configuration.
          readOnly: true
        vcdOrganizationUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization.
          format: uuid
          readOnly: true
        vcdOrganizationName:
          type: string
          description: Name of a VMware Cloud Director organization.
          readOnly: true
        vcdServerUid:
          type: string
          description: UID assigned to a VMware Cloud Director server.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of an organization VDC.
          readOnly: true
    VcdOrganizationUser:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization user.
          readOnly: true
        vcdOrganizationUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a VMware Cloud Director organization user.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
    SubscriptionPlan:
      required:
        - name
        - currency
        - taxType
        - taxPercent
        - discountPercent
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a subscription plan.
          format: uuid
          readOnly: true
        name:
          maxLength: 100
          minLength: 1
          type: string
          description: Name of a subscription plan.
        organizationUid:
          type: string
          description: Name of an organization whose user created a subscription plan.
          format: uuid
          nullable: true
          readOnly: true
        type:
          enum:
            - Unknown
            - Predefined
            - Provider
            - Reseller
          type: string
          description: Type of subscription plan.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: SubscriptionPlanType
        description:
          maxLength: 2048
          minLength: 0
          type: string
          description: Description of a subscription plan.
          nullable: true
        currency:
          type: string
          description: Currency chosen for a subscription plan.
        taxType:
          enum:
            - Unknown
            - VAT
            - GST
            - SalesTax
          type: string
          description: Tax type specified for a subscription plan.
          x-extensible-enum: true
          x-ms-enum:
            name: SubscriptionPlanTaxType
        taxPercent:
          maximum: 100
          minimum: 0
          type: number
          description: 'Tax amount, in percent.'
          format: double
        discountPercent:
          maximum: 100
          minimum: 0
          type: number
          description: 'Discount amount, in percent.'
          format: double
        managedBackup:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanManagedBackup'
          description: Charge rates for managed backup services.
          x-veeam-create-by-default: true
        publicCloud:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanPublicCloud'
          description: Charge rates for public cloud protection services.
          x-veeam-create-by-default: true
        vb365:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanVb365'
          description: Charge rates for managed Veeam Backup for Microsoft 365 services.
          x-veeam-create-by-default: true
        cloudReplication:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanCloudReplication'
          description: Charge rates for resources consumed by cloud VM replicas.
          x-veeam-create-by-default: true
        fileShareBackup:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanFileShareBackup'
          description: Charge rates for managed file share backup services.
          x-veeam-create-by-default: true
        cloudBackup:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanCloudBackup'
          description: Charge rates for storing backups in cloud repositories.
          x-veeam-create-by-default: true
        licenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanLicenses'
          description: Charge rates for consumed license units.
          x-veeam-create-by-default: true
        externalPlugins:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionPlanExternalPlugin'
          description: Array of charges for usage of services provided with external plugin functionality.
          x-veeam-empty-array-by-default: true
    SubscriptionPlanExternalPlugin:
      type: object
      properties:
        sourceUid:
          type: string
          description: UID assigned to an external plugin service.
          format: uuid
          readOnly: true
        charges:
          type: array
          items:
            $ref: '#/components/schemas/SubscriptionPlanExternalCharge'
          description: Array of charge rates.
          x-veeam-empty-array-by-default: true
    SubscriptionPlanExternalCharge:
      type: object
      properties:
        chargeUid:
          type: string
          description: UID assigned to a charge rate.
          format: uuid
          readOnly: true
        measureType:
          $ref: '#/components/schemas/MeasureUnitType'
        price:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate.
          format: double
          nullable: true
    MeasureUnitType:
      enum:
        - Unknown
        - None
        - Bytes
        - KB
        - MB
        - GB
        - TB
        - PB
        - Seconds
        - Minutes
        - Hours
        - Days
        - Weeks
        - Months
        - Units
      type: string
      description: Measurement units of provided services.
      nullable: true
      x-extensible-enum: true
      x-ms-enum:
        name: MeasureUnitType
    MeasureCategory:
      enum:
        - Unknown
        - None
        - Size
        - Time
        - Units
      type: string
      description: Measurement unit category.
      nullable: true
      x-extensible-enum: true
      x-ms-enum:
        name: MeasureCategory
    SubscriptionPlanLicenses:
      type: object
      properties:
        vspcLicenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanVspcLicenses'
          description: Charge rates for consumed Veeam Service Provider Console license units.
          x-veeam-create-by-default: true
        backupAndReplicationStandardEditionLicenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanBackupAndReplicationLicenses'
          description: Charge rates for consumed Veeam Backup & Replication Standard edition license units.
          x-veeam-create-by-default: true
        backupAndReplicationEnterpriseEditionLicenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanBackupAndReplicationLicenses'
          description: Charge rates for consumed Veeam Backup & Replication Enterprise edition license units.
          x-veeam-create-by-default: true
        backupAndReplicationEnterprisePlusEditionLicenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanBackupAndReplicationLicenses'
          description: Charge rates for consumed Veeam Backup & Replication Enterprise Plus edition license units.
          x-veeam-create-by-default: true
        vdpFoundationPackageLicenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanDataPlatformLicenses'
          description: Charge rates for consumed Veeam Data Platform Foundation package license units.
          x-veeam-create-by-default: true
        vdpAdvancedPackageLicenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanDataPlatformLicenses'
          description: Charge rates for consumed Veeam Data Platform Advanced package license units.
          x-veeam-create-by-default: true
        vdpPremiumPackageLicenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanDataPlatformLicenses'
          description: Charge rates for consumed Veeam Data Platform Premium package license units.
          x-veeam-create-by-default: true
        cloudConnectLicenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanCloudConnectLicenses'
          description: Charge rates for consumed Veeam Cloud Connect license units.
          x-veeam-create-by-default: true
        vb365Licenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanVB365Licenses'
          description: Charge rates for consumed Veeam Backup for Microsoft 365 license units.
          x-veeam-create-by-default: true
        veeamOneLicenses:
          type: object
          allOf:
            - $ref: '#/components/schemas/SubscriptionPlanVeeamOneLicenses'
          description: Charge rates for consumed Veeam One license units.
          x-veeam-create-by-default: true
    SubscriptionPlanVeeamOneLicenses:
      type: object
      properties:
        monitoredObjectPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed object monitored in Veeam ONE.
          format: double
          default: 0
    SubscriptionPlanVB365Licenses:
      type: object
      properties:
        userPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed Microsoft 365 user.
          format: double
          default: 0
    SubscriptionPlanCloudConnectLicenses:
      type: object
      properties:
        vmBackupPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed VM backup managed in Veeam Cloud Connect.
          format: double
          default: 0
        vmReplicaPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed VM replica managed in Veeam Cloud Connect.
          format: double
          default: 0
        workstationBackupPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed workstation backup managed in Veeam Cloud Connect.
          format: double
          default: 0
        serverBackupPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed server backup managed in Veeam Cloud Connect.
          format: double
          default: 0
    SubscriptionPlanVspcLicenses:
      type: object
      properties:
        workstationPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed workstation managed in Veeam Service Provider Console.
          format: double
          default: 0
        serverPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed server managed in Veeam Service Provider Console.
          format: double
          default: 0
    SubscriptionPlanBackupAndReplicationLicenses:
      type: object
      properties:
        vmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed VM protected by Veeam Backup & Replication.
          format: double
          default: 0
        workstationPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed workstation protected by Veeam Backup & Replication.
          format: double
          default: 0
        serverPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed server protected by Veeam Backup & Replication.
          format: double
          default: 0
        applicationPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed application protected by Veeam Backup & Replication.
          format: double
          default: 0
        microsoftEntraIdPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed Microsoft Entra ID protected by Veeam Backup & Replication.
          format: double
          default: 0
        fileSharePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed file share protected by Veeam Backup & Replication.
          format: double
          default: 0
        objectStoragePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed object storage protected by Veeam Backup & Replication.
          format: double
          default: 0
        cloudVmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed cloud VM protected by Veeam Backup & Replication.
          format: double
          default: 0
        cloudFileSharePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed cloud file share protected by Veeam Backup & Replication.
          format: double
          default: 0
        cloudDatabasePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed cloud database protected by Veeam Backup & Replication.
          format: double
          default: 0
    SubscriptionPlanDataPlatformLicenses:
      type: object
      properties:
        vmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed VM protected by Veeam Backup & Replication.
          format: double
          default: 0
        workstationPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed workstation protected by Veeam Backup & Replication.
          format: double
          default: 0
        serverPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed server protected by Veeam Backup & Replication.
          format: double
          default: 0
        applicationPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed application protected by Veeam Backup & Replication.
          format: double
          default: 0
        microsoftEntraIdPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed Microsoft Entra ID protected by Veeam Backup & Replication.
          format: double
          default: 0
        fileSharePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed file share protected by Veeam Backup & Replication.
          format: double
          default: 0
        objectStoragePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed object storage protected by Veeam Backup & Replication.
          format: double
          default: 0
        cloudVmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed cloud VM protected by Veeam Backup & Replication.
          format: double
          default: 0
        cloudFileSharePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed cloud file share protected by Veeam Backup & Replication.
          format: double
          default: 0
        cloudDatabasePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Monthly charge rate for a licensed cloud database protected by Veeam Backup & Replication.
          format: double
          default: 0
    SubscriptionPlanManagedBackup:
      type: object
      properties:
        managedServicePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Flat charge rate for provided management services, per month.'
          format: double
          default: 0
        monitoredServicePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Flat charge rate for provided monitoring services, per month.'
          format: double
          default: 0
        remoteManagedVmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for a managed remote VM, per month.'
          format: double
          default: 0
        remoteManagedCdpVmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for a managed remote CDP VM, per month.'
          format: double
          default: 0
        remoteManagedWorkstationPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for a managed remote workstation agent, per month.'
          format: double
          default: 0
        remoteManagedServerAgentPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for a managed remote server agent, per month.'
          format: double
          default: 0
        remoteFreeManagedVms:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of remote VMs that are managed for free.
          format: int32
          default: 0
        remoteFreeManagedCdpVms:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of remote CDP VMs that are managed for free.
          format: int32
          default: 0
        remoteFreeManagedWorkstations:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of remote workstations that are managed for free.
          format: int32
          default: 0
        remoteFreeManagedServerAgents:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of remote server agents that are managed for free.
          format: int32
          default: 0
        remoteWindowsServerOsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Extra charge rate for remote Microsoft Windows servers.
          format: double
          default: 0
        remoteWindowsClientOsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Extra charge rate for remote Microsoft Windows workstations.
          format: double
          default: 0
        remoteLinuxOsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Extra charge rate for remote Linux computers.
          format: double
          default: 0
        remoteMacOsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Extra charge rate for remote Mac OS computers.
          format: double
          default: 0
        remoteBackupUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of backup repository space consumed by all remote non-cloud backups.
          format: double
          default: 0
        remoteBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of backup repository space consumed by all remote non-cloud backups.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteFreeBackupUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of backup repository space that can be consumed by all remote non-cloud backups for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        remoteFreeBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of backup repository space that can be consumed by all remote non-cloud backups for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteRepositorySpaceUsageAlgorithm:
          enum:
            - Allocated
            - Consumed
            - Granular
          type: string
          description: Type of charge rate for repository storage space.
          default: Consumed
          x-ms-enum:
            name: SubscriptionPlanSpaceUsageAlgorithm
        remoteRepositoryAllocatedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of storage space allocated to a remote Veeam Backup & Replication server.
          format: double
          default: 0
        remoteRepositoryAllocatedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of storage space allocated to a remote Veeam Backup & Replication server.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteRoundUpBackupUsedSpace:
          type: boolean
          description: Indicates whether cost of storage used by remoste services must be rounded up to a full data block cost when the consumed storage space does not match data block size.
          default: false
        remoteBackupUsedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a block of consumed storage space allocated to a remote Veeam Backup & Replication server.
          format: int32
          default: 1
        hostedManagedVmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for a managed hosted VM, per month.'
          format: double
          default: 0
        hostedManagedCdpVmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for a managed hosted CDP VM, per month.'
          format: double
          default: 0
        hostedManagedWorkstationPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for a managed hosted workstation agent, per month.'
          format: double
          default: 0
        hostedManagedServerAgentPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for a managed hosted server agent, per month.'
          format: double
          default: 0
        hostedFreeManagedVms:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of hosted VMs that are managed for free.
          format: int32
          default: 0
        hostedFreeManagedCdpVms:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of hosted CDP VMs that are managed for free.
          format: int32
          default: 0
        hostedFreeManagedWorkstations:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of hosted workstations that are managed for free.
          format: int32
          default: 0
        hostedFreeManagedServerAgents:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of hosted server agents that are managed for free.
          format: int32
          default: 0
        hostedWindowsServerOsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Extra charge rate for hosted Microsoft Windows servers.
          format: double
          default: 0
        hostedWindowsClientOsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Extra charge rate for hosted Microsoft Windows workstations.
          format: double
          default: 0
        hostedLinuxOsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Extra charge rate for hosted Linux computers.
          format: double
          default: 0
        hostedMacOsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Extra charge rate for hosted Mac OS computers.
          format: double
          default: 0
        hostedBackupUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of backup repository space consumed by all hosted non-cloud backups.
          format: double
          default: 0
        hostedBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of backup repository space consumed by all hosted non-cloud backups.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedFreeBackupUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of backup repository space that can be consumed by all non-cloud backups for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        hostedFreeBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of backup repository space that can be consumed by all hosted non-cloud backups for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedRepositorySpaceUsageAlgorithm:
          enum:
            - Allocated
            - Consumed
            - Granular
          type: string
          description: Type of charge rate for repository storage space.
          default: Consumed
          x-ms-enum:
            name: SubscriptionPlanSpaceUsageAlgorithm
        hostedRepositoryAllocatedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of repository storage space allocated to a hosted Veeam Backup & Replication server.
          format: double
          default: 0
        hostedRepositoryAllocatedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of repository storage space allocated to a hosted Veeam Backup & Replication server.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedRoundUpBackupUsedSpace:
          type: boolean
          description: Indicates whether cost of storage used by hosted services must be rounded up to a full data block cost when the consumed storage space does not match data block size.
          default: false
        hostedBackupUsedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a block of repository storage space consumed by a hosted Veeam Backup & Replication server.
          format: int32
          default: 1
    SubscriptionPlanFileShareBackup:
      type: object
      properties:
        fileShareRemoteBackupUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of backup repository space consumed by file share backups.
          format: double
          default: 0
        fileShareRemoteBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of backup repository space consumed by file share backups.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        freeFileShareRemoteBackupUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of backup repository space that can be consumed by file share backups for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        freeFileShareRemoteBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of backup repository space that can be consumed by file share backups for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        fileShareRemoteArchiveUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of archive repository space consumed by file share backups.
          format: double
          default: 0
        fileShareRemoteArchiveUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of archive repository space consumed by file share backups.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        freeFileShareRemoteArchiveUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of archive repository space that can be consumed by file share backups for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        freeFileShareRemoteArchiveUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of archive repository space that can be consumed by file share backups for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        sourceRemoteAmountOfDataPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of source data.
          format: double
          default: 0
        sourceRemoteAmountOfDataUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of source data.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        freeSourceRemoteAmountOfData:
          minimum: 0
          type: integer
          description: "Amount of source data that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        freeSourceRemoteAmountOfDataUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of source data that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        fileShareHostedBackupUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of backup repository space consumed by file share backups.
          format: double
          default: 0
        fileShareHostedBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of backup repository space consumed by file share backups.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        freeFileShareHostedBackupUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of backup repository space that can be consumed by file share backups for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        freeFileShareHostedBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of backup repository space that can be consumed by file share backups for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        fileShareHostedArchiveUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of archive repository space consumed by file share backups.
          format: double
          default: 0
        fileShareHostedArchiveUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of archive repository space consumed by file share backups.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        freeFileShareHostedArchiveUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of archive repository space that can be consumed by file share backups for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        freeFileShareHostedArchiveUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of archive repository space that can be consumed by file share backups for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        sourceHostedAmountOfDataPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of source data.
          format: double
          default: 0
        sourceHostedAmountOfDataUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of source data.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        freeSourceHostedAmountOfData:
          minimum: 0
          type: integer
          description: "Amount of source data that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        freeSourceHostedAmountOfDataUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of source data that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
    SubscriptionPlanPublicCloud:
      type: object
      properties:
        remoteCloudVmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a managed remote public cloud VM.
          format: double
          default: 0
        remoteFreeCloudVms:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of remote public cloud VMs that are managed for free.
          format: int32
          default: 0
        remoteCloudFileSharePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a managed remote public cloud file share.
          format: double
          default: 0
        remoteFreeCloudFileShares:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of remote public cloud file shares that are managed for free.
          format: int32
          default: 0
        remoteCloudDatabasePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a managed remote public cloud database.
          format: double
          default: 0
        remoteFreeCloudDatabases:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of remote public cloud databases that are managed for free.
          format: int32
          default: 0
        remoteCloudNetworkPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a managed remote public cloud network.
          format: double
          default: 0
        remoteBackupUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of consumed space on remote public cloud repository.
          format: double
          default: 0
        remoteBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed space on remote public cloud repository.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteFreeBackupUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of consumed space on remote public cloud repository that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        remoteFreeBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed space on remote public cloud repository that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteArchiveUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of consumed space on remote archive public cloud repository.
          format: double
          default: 0
        remoteArchiveUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed space on remote archive public cloud repository.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteFreeArchiveUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of consumed space on remote archive public cloud repository that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        remoteFreeArchiveUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed space on remote archive public cloud repository that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedCloudVmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a managed hosted public cloud VM.
          format: double
          default: 0
        hostedFreeCloudVms:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of hosted public cloud VMs that are managed for free.
          format: int32
          default: 0
        hostedCloudFileSharePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a managed hosted public cloud file share.
          format: double
          default: 0
        hostedFreeCloudFileShares:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of hosted public cloud file shares that are managed for free.
          format: int32
          default: 0
        hostedCloudDatabasePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a managed hosted public cloud database.
          format: double
          default: 0
        hostedFreeCloudDatabases:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of hosted public cloud databases that are managed for free.
          format: int32
          default: 0
        hostedCloudNetworkPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a managed hosted public cloud network.
          format: double
          default: 0
        hostedBackupUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of consumed space on a hosted public cloud repository.
          format: double
          default: 0
        hostedBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed space on a hosted public cloud repository.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedFreeBackupUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of consumed space on a hosted public cloud repository that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        hostedFreeBackupUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed space on hosted public cloud repository that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedArchiveUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of consumed space on a hosted public cloud archive repository.
          format: double
          default: 0
        hostedArchiveUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed space on a hosted public cloud archive repository.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedFreeArchiveUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of consumed space on a hosted public cloud archive repository that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        hostedFreeArchiveUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed space on a hosted public cloud archive repository that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
    SubscriptionPlanVb365:
      type: object
      properties:
        remoteSubscriptionUserPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a protected remote Microsoft 365 subscription user.
          format: double
          default: 0
        remoteFreeSubscriptionUsers:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of remote Microsoft 365 subscription users that are managed for free.
          format: int32
          default: 0
        remoteEducationalUserPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a protected remote Microsoft 365 educational subscription user.
          format: double
          default: 0
        remoteFreeEducationalUsers:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of remote Microsoft 365 educational subscription users that are managed for free.
          format: int32
          default: 0
        remoteRoundUpUsedSpace:
          type: boolean
          description: Indicates whether cost of storage used by remote services must be rounded up to a full data block cost when the consumed storage space does not match data block size.
          default: false
        remoteStandardStorageUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a block of stored Microsoft 365 backup data.
          format: double
          default: 0
        remoteStandardStorageUsedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a stored Microsoft 365 backup data block.
          format: int32
          default: 1
        remoteStandardStorageUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of stored Microsoft 365 backup data block size.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteFreeStandardStorageUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of disk space consumed by remote Microsoft 365 backups that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        remoteFreeStandardStorageUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of disk space consumed by remote Microsoft 365 backups that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteArchiveStorageUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a block of Microsoft 365 backup copy data stored in a remote archive repository.
          format: double
          default: 0
        remoteArchiveStorageUsedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a data block of Microsoft 365 backup copies stored in a hosted archive repository.
          format: int32
          default: 1
        remoteArchiveStorageUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of Microsoft 365 backup copy data blocks.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteFreeArchiveStorageUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of remote archive repository disk space consumed by Microsoft 365 backup copies that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        remoteFreeArchiveStorageUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of remote archive repository disk space consumed by Microsoft 365 backup copies that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        remoteRepositorySpaceUsageAlgorithm:
          enum:
            - Allocated
            - Consumed
            - Granular
          type: string
          description: Type of remote repository storage space usage.
          default: Consumed
          x-ms-enum:
            name: SubscriptionPlanSpaceUsageAlgorithm
        remoteRepositoryAllocatedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of allocated storage space on a remote repository.
          format: double
          default: 0
        remoteRepositoryAllocatedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of allocated storage space on a remote repository.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedSubscriptionUserPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: ' Charge rate for a protected hosted Microsoft 365 subscription user.'
          format: double
          default: 0
        hostedFreeSubscriptionUsers:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of hosted Microsoft 365 subscription user that are managed for free.
          format: int32
          default: 0
        hostedEducationalUserPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a protected hosted Microsoft 365 educational subscription user.
          format: double
          default: 0
        hostedFreeEducationalUsers:
          maximum: 1000000
          minimum: 0
          type: integer
          description: Number of hosted Microsoft 365 educational subscription users that are managed for free.
          format: int32
          default: 0
        hostedRoundUpUsedSpace:
          type: boolean
          description: Indicates whether cost of storage used by hosted services must be rounded up to a full data block cost when the consumed storage space does not match data block size.
          default: false
        hostedStandardStorageUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a block of stored hosted Microsoft 365 backup data.
          format: double
          default: 0
        hostedStandardStorageUsedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a stored hosted Microsoft 365 backup data block.
          format: int32
          default: 1
        hostedStandardStorageUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of stored hosted Microsoft 365 backup data block size.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedFreeStandardStorageUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of disk space consumed by hosted Microsoft 365 backups that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        hostedFreeStandardStorageUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of disk space consumed by hosted Microsoft 365 backups that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedArchiveStorageUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a block of Microsoft 365 backup copy data stored in a hosted archive repository.
          format: double
          default: 0
        hostedArchiveStorageUsedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a data block of Microsoft 365 backup copies stored in a hosted archive repository.
          format: int32
          default: 1
        hostedArchiveStorageUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of Microsoft 365 backup copy data stored in a hosted archive repository.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedFreeArchiveStorageUsedSpace:
          minimum: 0
          type: integer
          description: "Amount of hosted archive repository disk space consumed by Microsoft 365 backup copies that is processed for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        hostedFreeArchiveStorageUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of hosted archive repository disk space consumed by Microsoft 365 backup copies that is processed for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        hostedRepositorySpaceUsageAlgorithm:
          enum:
            - Allocated
            - Consumed
            - Granular
          type: string
          description: Type of charge rate for storage space on a hosted repository.
          default: Consumed
          x-ms-enum:
            name: SubscriptionPlanSpaceUsageAlgorithm
        hostedRepositoryAllocatedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of allocated storage space on a hosted repository.
          format: double
          default: 0
        hostedRepositoryAllocatedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of allocated storage space on a hosted repository.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
    SubscriptionPlanCloudReplication:
      type: object
      properties:
        replicatedVmPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for one VM replica registered on a cloud host, per month.'
          format: double
          default: 0
        cloudStorageConsumedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of cloud storage space consumed by VM replica files.
          format: double
          default: 0
        cloudStorageConsumedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of cloud storage space consumed by VM replica files.
          default: TB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        freeCloudStorageConsumedSpace:
          minimum: 0
          type: integer
          description: "Amount of cloud storage space that can be consumed by VM replicas for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        freeCloudStorageConsumedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of cloud storage space that can be consumed by VM replicas for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        computeResourcesPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a CPU and memory resources usage by a VM on a cloud host.
          format: double
          default: 0
        computeResourcesUnits:
          enum:
            - Minutes
            - Hours
            - Days
            - Weeks
            - Months
          type: string
          description: Measurement units of time period of CPU and memory resources usage by a VM on a cloud host
          default: Hours
          x-ms-enum:
            name: SubscriptionPlanTimeMeasure
        freeComputeResources:
          maximum: 9999
          minimum: 0
          type: integer
          description: Amount of time during which VM replicas can consume compute resources on a cloud host for free.
          format: int64
          default: 0
        freeComputeResourcesUnits:
          enum:
            - Minutes
            - Hours
            - Days
            - Weeks
            - Months
          type: string
          description: Measurement units of time during which VM replicas can consume compute resources on a cloud host for free.
          default: Minutes
          x-ms-enum:
            name: SubscriptionPlanTimeMeasure
        replicationDataTransferOutPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of VM replica data downloaded from cloud storage.
          format: double
          default: 0
        replicationDataTransferOutUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of VM replica data downloaded from cloud storage.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
    SubscriptionPlanCloudBackup:
      type: object
      properties:
        roundUpUsedSpace:
          type: boolean
          description: Indicates whether storage usage cost must be rounded up to a full data block cost when the consumed storage space does not match data block size.
          default: false
        vmCloudBackupsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for storing one VM in backup on a cloud repository, per month.'
          format: double
          default: 0
        serverCloudBackupsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for storing backup data of one server computer on a cloud repository, per month.'
          format: double
          default: 0
        workstationCloudBackupsPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: 'Charge rate for storing backup data for one workstation computer on a cloud repository, per month.'
          format: double
          default: 0
        cloudRepositorySpaceUsageAlgorithm:
          enum:
            - Allocated
            - Consumed
            - Granular
          type: string
          description: Type of charge rate for storage space on a cloud repository.
          default: Consumed
          x-ms-enum:
            name: SubscriptionPlanSpaceUsageAlgorithm
        cloudRepositoryAllocatedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of allocated storage space on a cloud repository.
          format: double
          default: 0
        cloudRepositoryAllocatedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of allocated storage space on a cloud repository.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        cloudRepositoryConsumedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a block of consumed storage space on a cloud repository.
          format: double
          default: 0
        cloudRepositoryConsumedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a block of consumed storage space on a cloud repository.
          format: int32
          default: 1
        cloudRepositoryConsumedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed storage space on a cloud repository.
          default: TB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        freeCloudRepositoryConsumedSpace:
          minimum: 0
          type: integer
          description: "Amount of storage space that can be consumed by backup files for free.\n> Maximum value is `1048576` for GB and `1024` for TB.\n"
          format: int32
          nullable: true
        freeCloudRepositoryConsumedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of storage space that can be consumed by backup files for free.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        backupDataTransferOutPrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for one GB or TB of data downloaded from a cloud repository
          format: double
          default: 0
        backupDataTransferOutUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of data downloaded from a cloud repository.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        insiderProtectionUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for cloud repository space that is consumed by deleted backup files.
          format: double
          default: 0
        insiderProtectionUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of cloud repository space that is consumed by deleted backup files.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        performanceTierUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a block of consumed performance tier space.
          format: double
          default: 0
        performanceTierUsedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a consumed performance tier space block.
          format: int32
          default: 1
        performanceTierUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of blocks of consumed performance tier space.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        capacityTierUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a block of consumed capacity tier space.
          format: double
          default: 0
        capacityTierUsedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a consumed capacity tier space block.
          format: int32
          default: 1
        capacityTierUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed capacity tier space.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
        archiveTierUsedSpacePrice:
          maximum: 1000000
          minimum: 0
          type: number
          description: Charge rate for a block of consumed archive tier space.
          format: double
          default: 0
        archiveTierUsedSpaceChunkSize:
          maximum: 1000000
          minimum: 1
          type: integer
          description: Size of a consumed archive tier space block.
          format: int32
          default: 1
        archiveTierUsedSpaceUnits:
          enum:
            - GB
            - TB
          type: string
          description: Measurement units of consumed archive tier space.
          default: GB
          x-ms-enum:
            name: SubscriptionPlanSpaceMeasure
    Certificate:
      required:
        - issuedTo
        - issuedBy
        - expirationDate
        - friendlyName
        - thumbprint
        - serialNumber
      type: object
      properties:
        issuedTo:
          type: string
          description: Subject of a certificate.
        issuedBy:
          type: string
          description: Certificate issuer.
        friendlyName:
          type: string
          description: Certificate friendly name.
        thumbprint:
          type: string
          description: Thumbprint.
        serialNumber:
          type: string
          description: Certificate serial number.
        expirationDate:
          type: string
          description: Certificate expiration date.
          format: date-time
    InstallCertificate:
      required:
        - thumbprint
      type: object
      properties:
        thumbprint:
          type: string
          description: Certificate thumbprint in the Certificate Store.
    BackupServerLicense:
      required:
        - autoUpdateEnabled
      type: object
      properties:
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        autoUpdateEnabled:
          type: boolean
          description: Indicates whether license updates automatically.
        edition:
          type: string
          description: License edition.
          nullable: true
          readOnly: true
        monitoring:
          type: boolean
          description: Monitoring status.
          nullable: true
          readOnly: true
        packages:
          type: array
          items:
            enum:
              - Unknown
              - None
              - Starter
              - Essentials
              - Backup
              - ONE
              - Suite
              - Orchestrator
              - Foundation
              - Advanced
              - Premium
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: VeeamLicensePackage
          description: Product packages.
          readOnly: true
        company:
          type: string
          description: Name of an organization to which a license is issued.
          readOnly: true
        email:
          type: string
          description: Email address of an organization to which a license is issued.
          readOnly: true
        contactPerson:
          type: string
          description: '[Legacy] Name of a contact person in an organization to which the license is issued.'
          readOnly: true
        expirationDate:
          type: string
          description: License expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        supportExpirationDate:
          type: string
          description: Support expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        licenseIds:
          type: array
          items:
            type: string
            format: uuid
          description: License IDs.
          readOnly: true
        supportIds:
          type: array
          items:
            type: string
          description: License IDs required to contact Veeam Support.
          readOnly: true
        sectionTypes:
          type: array
          items:
            enum:
              - Unknown
              - Socket
              - Instance
              - All
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: LicenseSectionType
          description: Type of licensed units.
          readOnly: true
        status:
          enum:
            - Unknown
            - Valid
            - Warning
            - Error
            - Expired
            - Unlicensed
          type: string
          description: Current status of the license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseStatus
        cloudConnect:
          enum:
            - Unknown
            - No
            - Yes
            - Enterprise
          type: string
          description: Indicates whether Veeam Cloud Connect is included in a license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseCloudConnect
        sockets:
          type: number
          description: Number of licensed sockets.
          format: double
          nullable: true
          readOnly: true
        usedSockets:
          type: number
          description: Number of used sockets.
          format: double
          nullable: true
          readOnly: true
        capacity:
          type: number
          description: Available protected capacity for NAS backup.
          format: double
          nullable: true
          readOnly: true
        usedCapacity:
          type: number
          description: Consumed capacity for NAS backup.
          format: double
          nullable: true
          readOnly: true
        units:
          type: number
          description: Number of available license units.
          format: double
          readOnly: true
        usedUnits:
          type: number
          description: Number of used license units.
          format: double
          readOnly: true
        unitType:
          enum:
            - Unknown
            - Instances
            - Points
          type: string
          description: Type of license units.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseUnitsType
        type:
          enum:
            - Unknown
            - NotInstalled
            - Community
            - Rental
            - Subscription
            - Evaluation
            - NFR
            - Perpetual
          type: string
          description: Type of the license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseType
      example:
        backupServerUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        contactPerson: John Smith
        edition: Enterprise Plus
        company: Veeam
        email: John.Smith@veeam.com
        units: 1000
        unitType: Instances
        usedUnits: 100
        status: Valid
        cloudConnect: Yes
        autoUpdateEnabled: true
        packages:
          - Suite
        type: Rental
        supportIds:
          - '987412365'
        licenseIds:
          - 514c45eb-9543-4799-8003-1e59385b774c
        expirationDate: '2018-10-24T14:00:00.0000000-07:00'
        supportExpirationDate: '2018-10-24T14:00:00.0000000-07:00'
    SiteLicense:
      required:
        - autoUpdateEnabled
      type: object
      properties:
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        autoUpdateEnabled:
          type: boolean
          description: Indicates whether a license updates automatically.
        edition:
          type: string
          description: License edition.
          nullable: true
          readOnly: true
        monitoring:
          type: boolean
          description: Indicates if monitoring is enabled for a Veeam Cloud Connect server.
          nullable: true
          readOnly: true
        packages:
          type: array
          items:
            enum:
              - Unknown
              - None
              - Starter
              - Essentials
              - Backup
              - ONE
              - Suite
              - Orchestrator
              - Foundation
              - Advanced
              - Premium
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: VeeamLicensePackage
          description: Product packages.
          readOnly: true
        company:
          type: string
          description: Name of an organization to which a license is issued.
          readOnly: true
        email:
          type: string
          description: Email address of an organization to which a license is issued.
          readOnly: true
        contactPerson:
          type: string
          description: '[Legacy] Name of a contact person in an organization to which a license is issued.'
          readOnly: true
        expirationDate:
          type: string
          description: License expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        supportExpirationDate:
          type: string
          description: Support expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        licenseIds:
          type: array
          items:
            type: string
            format: uuid
          description: License IDs.
          readOnly: true
        supportIds:
          type: array
          items:
            type: string
          description: License IDs required to contact Veeam Support.
          readOnly: true
        sectionTypes:
          type: array
          items:
            enum:
              - Unknown
              - Socket
              - Instance
              - All
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: LicenseSectionType
          description: Types of licensed units.
          readOnly: true
        status:
          enum:
            - Unknown
            - Valid
            - Warning
            - Error
            - Expired
            - Unlicensed
          type: string
          description: Current status of a license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseStatus
        cloudConnect:
          enum:
            - Unknown
            - No
            - Yes
            - Enterprise
          type: string
          description: Indicates whether a license includes Veeam Cloud Connect.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseCloudConnect
        units:
          type: number
          description: Number of available license units.
          format: double
          readOnly: true
        usedUnits:
          type: number
          description: Number of used license units.
          format: double
          readOnly: true
        unitType:
          enum:
            - Unknown
            - Instances
            - Points
          type: string
          description: Type of license units.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseUnitsType
        type:
          enum:
            - Unknown
            - NotInstalled
            - Community
            - Rental
            - Subscription
            - Evaluation
            - NFR
            - Perpetual
          type: string
          description: Type of a license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseType
      example:
        siteUid: DF997BD3-4AE9-4841-8152-8FF5CC703EAB
        contactPerson: John Smith
        edition: Enterprise Plus
        company: Veeam
        email: John.Smith@veeam.com
        units: 1000
        unitType: Instances
        usedUnits: 100
        status: Valid
        cloudConnect: Yes
        autoUpdateEnabled: true
        packages:
          - Suite
        type: Rental
        supportIds:
          - '987412365'
        licenseIds:
          - 514c45eb-9543-4799-8003-1e59385b774c
        expirationDate: '2018-10-24T14:00:00.0000000-07:00'
        supportExpirationDate: '2018-10-24T14:00:00.0000000-07:00'
    ConsoleLicense:
      type: object
      properties:
        licenseId:
          type: string
          description: License ID.
          readOnly: true
        edition:
          type: string
          description: License edition.
          readOnly: true
        package:
          enum:
            - Unknown
            - None
            - Starter
            - Essentials
            - Backup
            - ONE
            - Suite
            - Orchestrator
            - Foundation
            - Advanced
            - Premium
          type: string
          description: Product packages.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ConsoleLicensePackage
        licenseeCompany:
          type: string
          description: Name of an organization to which a license is issued.
          readOnly: true
        licenseeEmail:
          type: string
          description: Email address of a contact person in an organization.
          readOnly: true
        licenseeAdministratorEmail:
          type: string
          description: Email address of a license administrator in a company.
          readOnly: true
        contactPerson:
          type: string
          description: '[Legacy] Name of a contact person in an organization to which the license is issued.'
          readOnly: true
        expirationDate:
          type: string
          description: License expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        supportExpirationDate:
          type: string
          description: Support expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        supportId:
          type: string
          description: Support ID required for contacting Veeam Support.
          readOnly: true
        status:
          enum:
            - Unknown
            - Valid
            - Warning
            - Error
            - Expired
          type: string
          description: Current status of the license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ConsoleLicenseStatus
        statusMessage:
          type: string
          description: Description of a license status.
          readOnly: true
        cloudConnect:
          enum:
            - Unknown
            - No
            - Yes
            - Enterprise
          type: string
          description: Indicates whether a license includes Veeam Cloud Connect.
          readOnly: true
          x-ms-enum:
            name: ConsoleLicenseCloudConnect
          x-extensible-enum: true
        instances:
          type: number
          description: Total number of available instances.
          format: double
          readOnly: true
        type:
          enum:
            - Unknown
            - NotInstalled
            - Community
            - Rental
            - Subscription
            - Evaluation
            - NFR
            - Perpetual
            - Full
            - Promo
          type: string
          description: Type of a license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ConsoleLicenseType
        lastUpdateDate:
          type: string
          description: Date and time when license was last updated.
          format: date-time
          nullable: true
          readOnly: true
        lastUpdateMessage:
          type: string
          description: Message to the last license update.
          readOnly: true
        lastUpdateStatus:
          enum:
            - Unknown
            - Success
            - Warning
            - Error
          type: string
          description: Status of the last license update.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ConsoleLicenseUpdateStatus
      example:
        licenseId: 514c45eb-9543-4799-8003-1e59385b774c
        contactPerson: John Smith
        edition: Enterprise Plus
        package: Suite
        licenseeCompany: Veeam
        licenseeEmail: John.Smith@veeam.com
        licenseeAdministratorEmail: Adam.Jang@veeam.com
        instances: 1000
        status: Valid
        type: Rental
        cloudConnect: Yes
        supportId: '987412365'
        expirationDate: '2018-10-24T14:00:00.0000000-07:00'
        supportExpirationDate: '2018-10-24T14:00:00.0000000-07:00'
        lastUpdateDate: '2019-10-24T14:00:00.0000000-07:00'
        lastUpdateMessage: ''
        lastUpdateState: Unknown
    BackupPolicy:
      required:
        - name
        - operationMode
        - accessMode
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup policy.
          format: uuid
          readOnly: true
        id:
          type: integer
          description: System ID assigned to a backup policy.
          format: int32
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization to whose agents a backup policy is assigned.
          format: uuid
          readOnly: true
        name:
          maxLength: 128
          minLength: 1
          type: string
          description: 'Backup policy name. Pattern is ''^[^$()%]+$'' for Windows policy and ''^[^~"#%&*:<>?!/\\{|}''`$]+$'' for Linux and Mac policies.'
        description:
          maxLength: 1024
          type: string
          description: Backup policy description.
          nullable: true
        configId:
          type: string
          description: System ID assigned to a backup policy configuration.
          format: uuid
          readOnly: true
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationModeReadonly'
        type:
          $ref: '#/components/schemas/BackupPolicyTypeReadonly'
        accessMode:
          $ref: '#/components/schemas/BackupPolicyAccessMode'
        systemType:
          enum:
            - Unknown
            - Windows
            - Linux
            - Mac
          type: string
          description: Type of guest OS on a managed computer.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupPolicySystemType
        createdBy:
          type: string
          description: 'Name of a company, reseller or service provider that created a backup policy.'
          readOnly: true
        modifiedDate:
          type: string
          description: Date and time when settings of a backup policy were last modified.
          format: date-time
          readOnly: true
        companies:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to companies to whose Veeam backup agents a policy is assigned.
          readOnly: true
        agents:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to management agents installed alongside Veeam backup agents with assigned policy.
          readOnly: true
        locations:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to locations to which management agents with assigned policy belong.
          readOnly: true
      example:
        instanceUid: D80427DD-3F62-4AF3-A206-98ABC24C87E5
        organizationUid: A41427DD-3F62-4AF3-A206-98ABC24C87E5
        name: Backup Policy X
        configId: CC221975-B409-49B5-8ECE-FFFECB13494F
        description: Backup Policy X
        mode: Server
        operationMode: Server
        type: Provider
        accessMode: Public
    BackupPolicyTypeReadonly:
      enum:
        - Unknown
        - Predefined
        - Provider
        - Reseller
        - Client
      type: string
      description: Backup policy type.
      readOnly: true
      x-extensible-enum: true
    BackupJobOperationModeReadonly:
      enum:
        - Unknown
        - Workstation
        - Server
      type: string
      description: Backup job operation mode.
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: BackupJobOperationMode
    BackupPolicyAccessMode:
      enum:
        - Private
        - Public
      type: string
      description: Backup policy access mode.
      x-ms-enum:
        name: BackupPolicyAccessMode
    BackupPolicyToAssign:
      type: object
      properties:
        companyUid:
          type: string
          description: UID assigned to an organization to whose agents a backup policy is assigned.
          format: uuid
          readOnly: true
        backupPolicies:
          type: array
          items:
            $ref: '#/components/schemas/BackupPolicy'
          description: Array of backup policies available to assign.
          readOnly: true
    WindowsCustomJobConfiguration:
      required:
        - name
        - operationMode
        - accessMode
        - jobConfiguration
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^$()%]+$'
          type: string
          description: Job name.
        description:
          maxLength: 1024
          type: string
          description: Job description.
          nullable: true
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationMode'
        cloudRepositoryConnectionSettings:
          $ref: '#/components/schemas/CloudRepositoryConnectionSettings'
        jobConfiguration:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsBackupJobConfiguration'
          description: Job configuration.
    CloudRepositoryConnectionSettings:
      required:
        - backupResourceUid
        - username
      type: object
      properties:
        backupResourceUid:
          type: string
          description: UID assigned to a cloud repository.'
          format: uuid
        username:
          maxLength: 128
          minLength: 1
          type: string
          description: User name.
        password:
          maxLength: 128
          minLength: 1
          type: string
          description: Password.
          format: password
          nullable: true
      description: Settings required to connect a cloud repository that is used as a target location for backups.
      nullable: true
    WindowsBackupPolicyInput:
      required:
        - name
        - operationMode
        - accessMode
        - jobConfiguration
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^$()%]+$'
          type: string
          description: Backup policy name.
        description:
          maxLength: 1024
          type: string
          description: Backup policy description.
          nullable: true
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationMode'
        accessMode:
          $ref: '#/components/schemas/BackupPolicyAccessMode'
        createSubtenants:
          type: boolean
          description: "Defines whether a subtenant must be created for each Veeam Agent for Microsoft Windows. \n> Available if a cloud repository is selected as backup destination.\n"
          default: true
        createSubFolders:
          type: boolean
          description: "Defines whether a subfolder must be created for each Veeam Agent for Microsoft Windows on the shared folder.\n> Available if a shared folder is selected as backup destination.\n"
          default: false
        unlimitedSubtenantQuota:
          type: boolean
          description: "Defines whether a subtenant can consume unlimited amount of space on a repository.\n> Available if a cloud repository is selected as backup destination.\n"
          default: false
        repositoryQuotaGb:
          type: integer
          description: "Maximum amount of space that a subtenant can consume on a repository.\n> If a subtenant can consume unlimited amount of space, the value of this property is ignored. <br>\n> Available if a cloud repository is selected as backup destination.\n"
          format: int32
          default: 100
          nullable: true
        jobConfiguration:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsBackupJobConfiguration'
          description: Job configuration.
    WindowsBackupPolicy:
      required:
        - name
        - operationMode
        - jobConfiguration
        - accessMode
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup policy.
          format: uuid
          readOnly: true
        id:
          type: integer
          description: System ID assigned to a backup policy.
          format: int32
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization to whose Veeam backup agents a backup policy is assigned.
          format: uuid
          readOnly: true
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^$()%]+$'
          type: string
          description: Name of a backup policy.
        description:
          maxLength: 1024
          type: string
          description: Description of a backup policy.
          nullable: true
        createSubtenants:
          type: boolean
          description: Indicates whether a subtenant must be created for each Veeam backup agent.
          default: true
        createSubFolders:
          type: boolean
          description: Indicates whether a subfolder must be created for each Veeam backup agent on the shared folder.
          default: false
        unlimitedSubtenantQuota:
          type: boolean
          description: Indicates whether a subtenant can consume unlimited amount of space on a repository.
          default: false
        repositoryQuotaGb:
          type: integer
          description: "Maximum amount of space that a subtenant can consume on a repository. \n> If a subtenant can consume unlimited amount of space, the value of this property is ignored.\n"
          format: int32
          default: 100
          nullable: true
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationMode'
        jobConfiguration:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsBackupJobConfiguration'
          description: Job configuration.
        type:
          $ref: '#/components/schemas/BackupPolicyTypeReadonly'
        accessMode:
          $ref: '#/components/schemas/BackupPolicyAccessMode'
        createdBy:
          type: string
          description: Name of an organization that created a backup policy.
          readOnly: true
        modifiedDate:
          type: string
          description: Date and time when settings of a backup policy were last modified.
          format: date-time
          readOnly: true
        companies:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to companies to whose Veeam backup agents a policy is assigned.
          readOnly: true
        agents:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to management agents installed alongside Veeam backup agents with assigned policy.
          readOnly: true
        locations:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to locations to which management agents with assigned policy belong.
          readOnly: true
    WindowsBackupJobConfiguration:
      required:
        - backupSource
        - backupTarget
      type: object
      properties:
        backupSource:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsBackupSource'
          description: Data included in the backup scope.
        backupTarget:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsBackupTarget'
          description: Location of the backup files.
        serverModeSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsServerModeJobSettings'
          description: Settings required for the Server operation mode.
          nullable: true
          x-veeam-create-by-default: true
        workstationModeSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsWorkstationModeJobSettings'
          description: Settings required for the Workstation operation mode.
          nullable: true
          x-veeam-create-by-default: true
        advancedSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsAdvancedJobSettings'
          description: Advanced job settings.
          x-veeam-create-by-default: true
        gfsRetentionSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsGfsRetentionSettings'
          description: "GFS retention policy settings for the backup job.\n> The null value indicates that GFS retention is disabled. <br>\n> Available only to Veeam Agent for Microsoft Windows starting from version 5.0.'\n"
          nullable: true
    WindowsAdvancedJobSettings:
      type: object
      properties:
        backupStorage:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsBackupStorage'
          description: Storage settings for a backup jobs.
          x-veeam-create-by-default: true
        scheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsAdvancedScheduleSettings'
          description: Scheduling settings for a backup chain created with a backup job.
          nullable: true
        maintenanceSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsMaintenanceJobSettings'
          description: Maintenance settings for a backup chain created with the backup job.
          nullable: true
    WindowsMaintenanceJobSettings:
      type: object
      properties:
        backupHealthCheckSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MonthlyOrWeeklyScheduleSettings'
          description: "Scheduling settings for periodic health checks of the latest restore points.\n> The `null` value indicates that health checks are disabled.\n"
          nullable: true
        fullBackupFileMaintenanceSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsFullBackupFileMaintenanceSettings'
          description: "Full backup file maintenance settings\n> The `null` value indicates that maintenance of full backup files is disabled.\n"
          nullable: true
          x-veeam-create-by-default: true
        fullHealthCheck:
          type: boolean
          description: Indicates whether a full health check is enabled for an object storage.
          default: false
    WindowsFullBackupFileMaintenanceSettings:
      type: object
      properties:
        enableDeletedFilesRetention:
          type: boolean
          description: '[For Veeam backup repository and cloud repository targets] Defines whether the deleted backup files must be removed after a specific time period.'
          default: false
        removeDeletedItemsDataAfter:
          maximum: 999
          minimum: 1
          type: integer
          description: '[For Veeam backup repository and cloud repository targets] Number of days for which the deleted backup files are stored.'
          format: int32
          default: 30
        defragmentAndCompactFullBackupFileSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MonthlyOrWeeklyScheduleSettings'
          description: "Settings for periodic compacting of full backup files\n> The `null` value indicates that compacting is disabled.\n"
          nullable: true
    WindowsAdvancedScheduleSettings:
      type: object
      properties:
        syntheticFullOnDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: "Week days on which creation of synthetic full backups is scheduled\n> The `null` value indicates that periodic creation of synthetic full backups is disabled.\n"
          nullable: true
        activeFullSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MonthlyOrWeeklyScheduleWithDaySettings'
          description: "Scheduling settings for periodically created active full backups.\n> The `null` value indicates that periodic creation of active full backups is disabled.\n"
          nullable: true
    MonthlyOrWeeklyScheduleSettings:
      type: object
      properties:
        monthlySettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsMonthlyScheduleCalendarSettings'
          description: "Scheduling settings for monthly full backup creation.\n> If the `weeklyOnDays` property is also provided, monthly schedule is ignored.'\n"
          nullable: true
        weeklyOnDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: "Scheduling settings for weekly full backup creation.\n> If the `monthlySettings` property is also provided, it is ignored.\n"
          nullable: true
    MonthlyOrWeeklyScheduleWithDaySettings:
      type: object
      properties:
        monthlySettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsMonthlyScheduleCalendarWithDaySettings'
          description: "Scheduling settings for monthly full backup creation.\n> If the `weeklyOnDays` property is also provided, monthly schedule is ignored.\n"
          nullable: true
        weeklyOnDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: "Scheduling settings for weekly full backup creation.\n> If the `monthlySettings` property is also provided, it is ignored.\n"
          nullable: true
    WindowsServerJobScheduleSettings:
      type: object
      properties:
        scheduleType:
          enum:
            - NotScheduled
            - Daily
            - Monthly
            - Periodically
            - Continuously
          type: string
          description: Type of periodicity.
          default: Daily
          x-ms-enum:
            name: WindowsServerJobScheduleType
        dailyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsDailyScheduleSettings'
          description: Scheduling settings required for a daily running job.
          nullable: true
          x-veeam-create-by-default: true
        monthlyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsMonthlyScheduleSettings'
          description: Scheduling settings required for a monthly running job.
          nullable: true
        periodicalScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsPeriodicalScheduleSettings'
          description: Scheduling settings required to run a job repeatedly throughout a day.
          nullable: true
        continuousScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsContinuousScheduleSettings'
          description: "Scheduling settings for a continuously running job.\n> The `null` value indicates that a job can be run at any time.\n"
          nullable: true
          x-veeam-create-by-default: true
        retrySettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsServerJobRetrySettings'
          description: Automatic retry settings.
          x-veeam-create-by-default: true
        backupWindow:
          type: array
          items:
            $ref: '#/components/schemas/JobScheduleWindowDay'
          description: "Time interval within which a job must complete.\n> The `null` value indicates that a job can be run at any time.\n"
          nullable: true
    WindowsServerJobRetrySettings:
      type: object
      properties:
        enabled:
          type: boolean
          description: Indicates whether Veeam Agent for Microsoft Windows must attempt to run the backup job again if the job fails.
          default: true
        retryTimes:
          maximum: 777
          minimum: 1
          type: integer
          description: Number of attempts to run a job.
          format: int32
          default: 3
        waitTimeoutMinutes:
          maximum: 999
          minimum: 0
          type: integer
          description: Time interval between attempts to run a job.
          format: int32
          default: 10
    WindowsContinuousScheduleSettings:
      properties:
        backupWindowSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsPeriodicallyScheduleWindowSettings'
          description: Permitted time window for a continuously running job.
          nullable: true
          x-veeam-create-by-default: true
    WindowsPeriodicalScheduleSettings:
      required:
        - intervalInMinutes
      type: object
      properties:
        intervalInMinutes:
          maximum: 1440
          minimum: 1
          type: integer
          description: 'Time interval for a periodically running job, in minutes.'
        backupWindowSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsPeriodicallyScheduleWindowSettings'
          description: Permitted time window for a periodically running job.
          nullable: true
          x-veeam-create-by-default: true
    WindowsPeriodicallyScheduleWindowSettings:
      type: object
      properties:
        scheduleWindow:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/JobScheduleWindowDay'
          description: "Permitted time window for a job.\n> By default includes all days and all hours.\n"
          nullable: true
        shiftForMinutes:
          maximum: 59
          minimum: 0
          type: integer
          description: 'Exact time of the job start within an hour, in minutes.'
          format: int32
          default: 0
    JobScheduleWindowDay:
      required:
        - day
        - hours
      type: object
      properties:
        day:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Days when job runs are permitted.
          x-ms-enum:
            name: DaysOfWeek
        hours:
          uniqueItems: true
          type: array
          items:
            maximum: 23
            minimum: 0
            type: integer
            format: int32
          description: "Hours when job runs are permitted.\n> Empty array indicates that job runs are denied during the whole day. \n"
    WindowsMonthlyScheduleCalendarWithDaySettings:
      required:
        - monthlyMode
        - months
      type: object
      properties:
        monthlyMode:
          enum:
            - Unknown
            - Day
            - DayOfWeek
            - LastDayOfMonth
          type: string
          description: Schedule type.
          default: Day
          x-ms-enum:
            name: WindowsMonthlyScheduleCalendarWithDaySettingsMonthlyMode
          x-veeam-expandable: true
        weekDayNumber:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
          description: "Counting number of the week day.\n> Required for the `DaysOfWeek` schedule type.\n"
          default: First
          nullable: true
          x-ms-enum:
            name: WeekDayNumberType
        dayOfWeek:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: "Name of the week day.\n> Required for the `DaysOfWeek` schedule type.\n"
          default: Sunday
          nullable: true
          x-ms-enum:
            name: DaysOfWeek
        day:
          maximum: 31
          minimum: 1
          type: integer
          description: "Day of the month. \n> Required for the `Day` schedule type.\n"
          format: int32
          default: 1
          nullable: true
        months:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Jan
              - Feb
              - Mar
              - Apr
              - May
              - Jun
              - Jul
              - Aug
              - Sep
              - Oct
              - Nov
              - Dec
              - All
            type: string
            x-ms-enum:
              name: MonthsWithAll
          description: Month.
    WindowsMonthlyScheduleCalendarSettings:
      required:
        - weekDayNumber
      type: object
      properties:
        weekDayNumber:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
          description: Counting number of the week day.
          x-ms-enum:
            name: WeekDayNumberType
        dayOfWeek:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Name of the week day.
          default: Sunday
          x-ms-enum:
            name: DaysOfWeek
        months:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Jan
              - Feb
              - Mar
              - Apr
              - May
              - Jun
              - Jul
              - Aug
              - Sep
              - Oct
              - Nov
              - Dec
              - All
            type: string
            x-ms-enum:
              name: MonthsWithAll
          description: Month.
          default:
            - All
    WindowsMonthlyScheduleSettings:
      required:
        - calendarSettings
      type: object
      properties:
        time:
          type: string
          description: Timestamp of a job start.
          format: time-of-day
          default: '10:00'
        calendarSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsMonthlyScheduleCalendarWithDaySettings'
          description: Job calendar settings.
    WindowsDailyScheduleSettings:
      type: object
      properties:
        time:
          type: string
          description: 'Time when a job must start, in the `hh:mm` format.'
          format: time-of-day
          default: '0:30'
        dailyMode:
          enum:
            - Everyday
            - WeekDays
            - SpecificDays
          type: string
          description: Type of daily schedule.
          default: Everyday
          x-ms-enum:
            name: WindowsDailyScheduleDaysMode
        specificDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            minItems: 1
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: "Array of the week days on which a job must start.\n> Required for the `SpecificDays` type of daily schedule.\n"
          nullable: true
    WindowsServerModeJobSettings:
      type: object
      properties:
        retentionSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsServerJobRetentionSettings'
          description: Retention settings.
          x-veeam-create-by-default: true
        scheduleSetting:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsServerJobScheduleSettings'
          description: Scheduling settings.
          x-veeam-create-by-default: true
        indexingSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsIndexingSettings'
          description: Guest OS indexing settings.
          nullable: true
        applicationAwareProcessingSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsApplicationAwareProcessingSettings'
          description: Application-aware processing settings.
          x-veeam-create-by-default: true
    WindowsApplicationAwareProcessingSettings:
      type: object
      properties:
        enabled:
          type: boolean
          description: Indicates whether the application-aware processing is enabled.
          default: false
        transactionLogProcessingMode:
          enum:
            - ProcessTransactionLogsWithJob
            - PerformCopyOnly
          type: string
          description: Application-aware processing type.
          default: ProcessTransactionLogsWithJob
          x-ms-enum:
            name: WindowsPolicyTransactionLogProcessingMode
        sqlServerTransactionLogHandlingSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsSqlServerTransactionLogHandlingSettings'
          description: Transaction log handling settings for Microsoft SQL Server.
          nullable: true
        oracleTransactionLogHandlingSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsOracleTransactionLogHandlingSettings'
          description: Archived log handling settings for Oracle database.
          nullable: true
        sharePointAccountSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/SharePointAccountSettings'
          description: Microsoft SharePoint account settings.
          nullable: true
        scriptSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsJobScriptSettings'
          description: Execution settings for pre-freeze and post-thaw scripts.
          nullable: true
    WindowsJobScriptSettings:
      type: object
      properties:
        mode:
          enum:
            - Disabled
            - IgnoreErrors
            - FailJobOnError
          type: string
          description: Script processing mode.
          default: Disabled
          x-ms-enum:
            name: WindwosJobScriptMode
        preFreezeScript:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsJobScript'
          description: Path to a pre-freeze script file.
          nullable: true
        postThawScript:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsJobScript'
          description: Path to a post-thaw script file.
          nullable: true
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsJobScriptExecutionAccount'
          description: Credentials of a user account with permissions to run scripts.
          nullable: true
    WindowsJobScript:
      required:
        - fileName
      type: object
      properties:
        fileName:
          maxLength: 256
          minLength: 1
          type: string
          description: 'Script file name. Must match the following pattern: ''^[^\\/:*?"<>|]+\.(exe|bat|cmd)$''.'
        content:
          minLength: 1
          type: string
          description: Script content in the Base64 format. The property is required and write-only.
          format: byte
          nullable: true
          writeOnly: true
    WindowsJobScriptExecutionAccount:
      required:
        - username
      type: object
      properties:
        username:
          maxLength: 255
          minLength: 1
          type: string
          description: User name.
        password:
          maxLength: 32767
          type: string
          description: "Password.\n> Required only during job initial configuration. <br>\n> For resource modification, the `null` value can be used instead of the previously provided password.\n"
          format: password
          nullable: true
    SharePointAccountSettings:
      required:
        - username
      type: object
      properties:
        username:
          maxLength: 255
          minLength: 1
          type: string
          description: User name.
        password:
          maxLength: 32767
          type: string
          description: Password.
          format: password
          nullable: true
    WindowsOracleTransactionLogHandlingSettings:
      properties:
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsOracleAccountSettings'
          description: Credentials of a user account that Veeam Agent for Microsoft Windows must use to connect to the Oracle database.
          nullable: true
        archivedLogsRetentionMode:
          enum:
            - DoNotDeleteArchivedLogs
            - DeleteLogsOlderThanHours
            - DeleteLogsOverGb
          type: string
          description: Archived log processing mode.
          default: DoNotDeleteArchivedLogs
          x-ms-enum:
            name: WindowsPolicyOracleArchivedLogsRetentionMode
        backupLifeTimeHours:
          maximum: 60
          minimum: 1
          type: integer
          description: "Amount of time after which archived logs must be deleted, in hours. \n> Required for the `DeleteLogsOlderThanHours` archived log processing mode.\n"
          format: int32
          default: 24
        backupSizeThresholdGb:
          maximum: 999
          minimum: 1
          type: integer
          description: "Maximum threshold for archived log file size, in GB.\n> If an archived log file exceeds the limitation, it is deleted. <br>\n> Required for the `DeleteLogsOverGb` archived log processing mode.\n"
          format: int32
          default: 10
        backupLogsPeriodically:
          type: boolean
          description: Indicates whether Veeam Agent for Microsoft Windows must back up archive logs.
          default: false
        periodicallyBackupSetting:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsPolicyPeriodicallyLogBackupSettings'
          description: Archive log backup settings.
          nullable: true
          x-veeam-create-by-default: true
    WindowsPolicyPeriodicallyLogBackupSettings:
      properties:
        backupLogsEveryMin:
          maximum: 480
          minimum: 5
          type: integer
          description: 'Frequency for archived logs backup, in minutes.'
          format: int32
          default: 15
        backupRetentionMode:
          enum:
            - UntilBackupIsDeleted
            - KeepLastDays
          type: string
          description: Type of a retention policy for archived logs.
          default: UntilBackupIsDeleted
          x-ms-enum:
            name: WindowsPolicyMsSqlPeriodicallyLogBackupRetentionMode
        keepBackupsOnlyLastDays:
          maximum: 60
          minimum: 1
          type: integer
          description: Number of days for which archived logs are kept.
          format: int32
          default: 15
    WindowsOracleAccountSettings:
      required:
        - username
      type: object
      properties:
        accountType:
          enum:
            - Oracle
            - Windows
          type: string
          description: Type of the account used to access Oracle database.
          default: Windows
          x-ms-enum:
            name: OracleAccountType
        username:
          maxLength: 255
          minLength: 1
          type: string
          description: User name.
        password:
          maxLength: 32767
          type: string
          description: Password.
          format: password
          nullable: true
    WindowsSqlServerTransactionLogHandlingSettings:
      type: object
      properties:
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsMsSqlAccountSettings'
          description: Credentials of a user account that Veeam Agent for Microsoft Windows must use to connect to the Microsoft SQL Server.
          nullable: true
        logsProcessingMode:
          enum:
            - TruncateLogs
            - DoNotTruncateLogs
            - BackupLogsPeriodically
          type: string
          description: Transaction log processing mode.
          default: TruncateLogs
          x-ms-enum:
            name: WindowsPolicyMsSqlLogProcessingMode
        periodicallyBackupSetting:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsPolicyPeriodicallyLogBackupSettings'
          description: Settings for periodic transaction log backup.
          nullable: true
          x-veeam-create-by-default: true
    WindowsMsSqlAccountSettings:
      required:
        - username
      type: object
      properties:
        username:
          maxLength: 255
          minLength: 1
          type: string
          description: User name.
        password:
          maxLength: 32767
          type: string
          description: Password.
          format: password
          nullable: true
    WindowsWorkstationJobPeriodicalScheduleSettings:
      type: object
      properties:
        dailyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsDailyScheduleSettings'
          description: Scheduling settings required for a daily running job.
          nullable: true
          x-veeam-create-by-default: true
        shutdownAction:
          enum:
            - SkipBackup
            - BackupOncePoweredOn
          type: string
          description: Action that Veeam Agent for Microsoft Windows must perform in case your computer is powered off at the time when the scheduled backup job must start.
          default: SkipBackup
          x-ms-enum:
            name: WindowsWorkstationJobShutdownAction
        finalizingAction:
          enum:
            - KeepRunning
            - Sleep
            - Shutdown
            - Hibernate
          type: string
          description: Finalizing action that must be performed after the backup job completes successfully.
          default: KeepRunning
          x-ms-enum:
            name: WindowsWorkstationJobFinalizingAction
    WindowsWorkstationJobEventTriggerSettings:
      type: object
      properties:
        backupOnLock:
          type: boolean
          description: Indicates whether a scheduled backup job must start when the user locks the computer.
          default: false
        backupOnLogOff:
          type: boolean
          description: Indicates whether a scheduled backup job must start when the user working with the computer performs a logout operation.
          default: false
        backupOnTargetConnection:
          type: boolean
          description: Indicates whether a scheduled backup job must start when the backup storage becomes available.
          default: false
        ejectTargetOnBackupComplete:
          type: boolean
          description: "Indicates whether Veeam Agent for Microsoft Windows must unmount the storage device after the backup job completes successfully.\n> Cannot be enabled if the `backupOnTargetConnection` property has the `false` value.\n"
          default: false
        backupNotOften:
          maximum: 99
          minimum: 1
          type: integer
          description: 'Minutely, hourly or daily interval between the backup job sessions.'
          format: int32
          default: 2
        notOftenTimeUnit:
          enum:
            - Minutes
            - Hours
            - Days
          type: string
          description: Measurement units of interval between the backup job sessions.
          default: Hours
          x-ms-enum:
            name: MinutesHoursDays
    WindowsWorkstationJobScheduleSettings:
      type: object
      properties:
        periodicalScheduleEnabled:
          type: boolean
          description: Indicates whether backup must be performed periodically.
          default: true
        periodicalScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsWorkstationJobPeriodicalScheduleSettings'
          description: Scheduling settings for daily backup job launch.
          nullable: true
          x-veeam-create-by-default: true
        eventTriggerSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsWorkstationJobEventTriggerSettings'
          description: Settings for events that trigger the backup job launch.
          x-veeam-create-by-default: true
    WindowsWorkstationModeJobSettings:
      type: object
      properties:
        scheduleSetting:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsWorkstationJobScheduleSettings'
          description: Scheduling settings for a backup job.
          x-veeam-create-by-default: true
        retentionSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsWorkstationJobRetentionSettings'
          description: Retention policy settings for a backup job.
          x-veeam-create-by-default: true
    WindowsIndexingSettings:
      required:
        - indexingType
      type: object
      properties:
        indexingType:
          enum:
            - None
            - Everything
            - SpecifiedFolders
            - ExceptSpecifiedFolders
          type: string
          description: Indexing mode.
          x-ms-enum:
            name: WindowsIndexingType
        includedFolders:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            maxLength: 32767
            minLength: 1
            pattern: '^[^<>]+$'
            type: string
          description: "Array of paths to the indexed folders.\n> Required for the `SpecifiedFolders` indexing mode.\n"
          nullable: true
        excludedFolders:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            maxLength: 32767
            minLength: 1
            pattern: '^[^<>]+$'
            type: string
          description: "Array of paths to folders that are excluded from the indexing scope.\n> Required for the `ExceptSpecifiedFolders` indexing mode.\n"
          nullable: true
    WindowsBackupStorage:
      type: object
      properties:
        compressionLevel:
          enum:
            - Unknown
            - NoCompression
            - Dedupe
            - Optimal
            - High
            - Extreme
          type: string
          description: Compression level for the backup.
          default: Optimal
          x-ms-enum:
            name: WindowsJobCompressionLevel
          x-extensible-enum: true
        storageOptimization:
          enum:
            - Unknown
            - LocalPb4MB
            - Local1MB
            - Lan512KB
            - Wan256KB
            - LocalLegacy8Mb
          type: string
          description: Type of a backup target.
          default: Local1MB
          x-ms-enum:
            name: WindowsJobStorageOptimization
          x-extensible-enum: true
        encryptionEnabled:
          type: boolean
          description: "Indicates whether encryption is enabled.\n> Encryption cannot be enabled for backup files stored on the Veeam backup repository.\n"
          default: false
        password:
          maxLength: 256
          minLength: 1
          type: string
          description: "Password used for encryption. \n> Required if encryption is enabled.\n"
          format: password
          nullable: true
        passwordHint:
          maxLength: 32767
          type: string
          description: "Hint for the password.\n> Must not consist of the password itself.\n"
          nullable: true
    WindowsBackupTarget:
      required:
        - targetType
      type: object
      properties:
        targetType:
          enum:
            - Unknown
            - LocalFolder
            - SharedFolder
            - BackupRepository
            - CloudRepository
            - OneDrive
            - ObjectStorage
          type: string
          description: "Target location for the created backup.\n> To store entire computer backups on the `LocalFolder` target location, you must use an external drive.\n> The `OneDrive` and `ObjectStorage` target locations cannot be assigned using REST API.\n"
          x-ms-enum:
            name: WindowsBackupTargetType
        localPath:
          maxLength: 4096
          minLength: 1
          pattern: '^(([a-zA-Z]:)|(%.+%))(\\(?!(aux|con|nul|prn|com[1-9]|lpt[1-9])(\\|$))([^<>:"/\\|?*]+))+\\?$'
          type: string
          description: "Path to the folder where backup files must be stored.\n> Required for the `LocalFolder` target location. \n"
          nullable: true
        sharedFolder:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsSharedFolderTarget'
          description: "Shared folder settings.\n> Required for the `SharedFolder` target location.\n"
          nullable: true
        backupRepository:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsBackupRepositoryTarget'
          description: "Veeam Backup & Replication repository settings.\n> Required for the `BackupRepository` target location.\n"
          nullable: true
        cloudRepository:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsCloudRepositoryTarget'
          description: "Cloud repository settings.\n> Optional for the `CloudRepository` target location.\n"
          nullable: true
    DiscoveryRuleScheduleSettings:
      required:
        - scheduleType
      type: object
      properties:
        scheduleType:
          enum:
            - NotScheduled
            - Daily
            - Monthly
            - Periodically
            - Continuously
          type: string
          description: Schedule type
          default: NotScheduled
          x-ms-enum:
            name: DiscoveryRuleScheduleType
        timeZone:
          type: object
          allOf:
            - $ref: '#/components/schemas/TimeZone'
          description: Time zone settings.
          nullable: true
        dailyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleDailyScheduleSettings'
          description: Scheduling settings required to run discovery daily.
          nullable: true
        monthlyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleMonthlyScheduleSettings'
          description: Scheduling settings required to run discovery monthly.
          nullable: true
        periodicalScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRulePeriodicalScheduleSettings'
          description: Scheduling settings required to run discovery repeatedly throughout a day.
          nullable: true
    DiscoveryRuleDailyScheduleSettings:
      type: object
      properties:
        time:
          type: string
          description: 'Time of the day when discovery must run, in the `hh:mm` format.'
          format: time-of-day
          default: '0:30'
        specificDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            minItems: 1
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: "Array of week days on which discovery must be performed.\n> Required for the `SpecificDay` schedule type.\n"
          nullable: true
    DiscoveryRuleMonthlyScheduleSettings:
      required:
        - time
        - calendarSettings
      type: object
      properties:
        time:
          type: string
          description: 'Time of the day when discovery must run, in the `hh:mm` format.'
          format: time-of-day
        calendarSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleMonthlyScheduleCalendarWithDaySettings'
          description: Discovery calendar settings.
    DiscoveryRuleMonthlyScheduleCalendarWithDaySettings:
      required:
        - monthlyMode
        - months
      type: object
      properties:
        monthlyMode:
          enum:
            - Unknown
            - Day
            - DayOfWeek
            - LastDayOfMonth
          type: string
          description: Type of schedule for monthly discovery.
          default: Day
          x-ms-enum:
            name: DiscoveryRuleMonthlyScheduleCalendarWithDaySettingsMonthlyMode
          x-veeam-expandable: true
        weekDayNumber:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
          description: "Counting number of the week day.\n> Required for the `DayOfWeek` schedule type.\n"
          nullable: true
          x-ms-enum:
            name: WeekDayNumberType
        dayOfWeek:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: "Week day.\n> Required for the `DayOfWeek` schedule type.\n"
          nullable: true
          x-ms-enum:
            name: DaysOfWeek
        day:
          maximum: 31
          minimum: 1
          type: integer
          description: "Day of the month.\n> Required for the `Day` schedule type.\n"
          format: int32
          nullable: true
        months:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Jan
              - Feb
              - Mar
              - Apr
              - May
              - Jun
              - Jul
              - Aug
              - Sep
              - Oct
              - Nov
              - Dec
              - All
            type: string
            x-ms-enum:
              name: MonthsWithAll
          description: Month.
    DiscoveryRulePeriodicalScheduleSettings:
      required:
        - interval
      type: object
      properties:
        intervalInMinutes:
          maximum: 43200
          minimum: 1
          type: integer
          description: 'Time interval for a periodically running discovery, in minutes. Discovery starts at the beginning of an hour after the specified time interval.'
          default: 60
    TimeZone:
      required:
        - timeZoneId
      type: object
      properties:
        timeZoneId:
          type: string
          description: ID assigned to a time zone.
        displayName:
          type: string
          description: Time zone name.
          nullable: true
          readOnly: true
        utcOffset:
          maximum: 720
          minimum: -720
          type: integer
          description: 'UTC offset, in minutes.'
          format: int32
          nullable: true
          readOnly: true
    WindowsGfsRetentionSettings:
      type: object
      properties:
        weekly:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsGfsWeeklyRetentionSettings'
          description: "GFS retention policy settings for weekly full backups.\nThe `null` value indicates that long-term retention is disabled for weekly full backups.\n"
          nullable: true
        monthly:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsGfsMonthlyRetentionSettings'
          description: "GFS retention policy settings for monthly full backups.\n> The `null` value indicates that long-term retention is disabled for monthly full backups.\n"
          nullable: true
        yearly:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsGfsYearlyRetentionSettings'
          description: "GFS retention policy settings for yearly full backups.\n> The `null` value indicates that long-term retention is disabled for yearly full backups.\n"
          nullable: true
    WindowsGfsWeeklyRetentionSettings:
      required:
        - keepWeeklyBackupsForWeeks
      type: object
      properties:
        keepWeeklyBackupsForWeeks:
          maximum: 9999
          minimum: 1
          type: integer
          description: Number of weeks during which restore points must not be modified or deleted.
          format: int32
          default: 1
        useFullBackupFrom:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Week day when Veeam Backup & Replication must assign the weekly GFS flag to a full restore point.
          default: Sunday
          x-ms-enum:
            name: DaysOfWeek
    WindowsGfsMonthlyRetentionSettings:
      required:
        - keepMonthlyBackupsForMonths
      type: object
      properties:
        keepMonthlyBackupsForMonths:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of months during which restore points must not be modified or deleted.
          format: int32
          default: 1
        useWeeklyFullBackupForTheFollowingWeekOfMonth:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
          description: Week when Veeam Backup & Replication must assign the monthly GFS flag to a full restore point.
          default: First
          x-ms-enum:
            name: WeekOfMonth
    WindowsGfsYearlyRetentionSettings:
      required:
        - keepYearlyBackupsForYears
      type: object
      properties:
        keepYearlyBackupsForYears:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of years during which restore points must not be modified or deleted.
          format: int32
          default: 1
        useMonthlyFullBackupForTheFollowingMonth:
          enum:
            - Jan
            - Feb
            - Mar
            - Apr
            - May
            - Jun
            - Jul
            - Aug
            - Sep
            - Oct
            - Nov
            - Dec
          type: string
          description: Month when Veeam Backup & Replication must assign the yearly GFS flag to a full restore point.
          default: Jan
          x-ms-enum:
            name: Month
    WindowsSharedFolderTarget:
      required:
        - path
      type: object
      properties:
        path:
          minLength: 1
          pattern: '^(\\\\[^/\\\]\[":;|<>+=,?* _]+\\[^/\\\]\[":;|<>+=,?*]+)((?:\\[^\\/:*?"<>|]+)*\\?)$'
          type: string
          description: UNC name of the network shared folder in which you want to store backup files. The UNC name must start with two back slashes (\\).
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsPolicyTargetCredentials'
          description: "Credentials of a user account that has access permissions on the shared folder.\n> If no user credentials are specified, backup job uses the Microsoft Entra ID computer account or account configured in Veeam Agent for Microsoft Windows. In this case, policy creation and modification are not available.\n"
          nullable: true
        backupCacheSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupCacheSettings'
          description: "Local backup cache settings.\n> The `null` value indicates that local backup cache is disabled.\n"
          nullable: true
    WindowsPolicyTargetCredentials:
      required:
        - username
      type: object
      properties:
        username:
          maxLength: 255
          minLength: 1
          type: string
          description: User name.
        password:
          maxLength: 32767
          type: string
          description: Password.
          format: password
          nullable: true
    WindowsBackupServerConnectionOptions:
      required:
        - address
        - remoteRepositoryName
      type: object
      properties:
        address:
          maxLength: 32767
          minLength: 1
          pattern: '(^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\_\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-\_]*[A-Za-z0-9])$)|($(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])^)|(^(?:(?:[0-9a-fA-F:]){1,4}(?:(?::(?:[0-9a-fA-F]){1,4}|:)){2,7})+$)'
          type: string
          description: DNS name or IP address of a Veeam Backup & Replication server that manages the target backup repository.
        port:
          maximum: 65535
          minimum: 1
          type: integer
          description: Port over which Veeam Agent for Microsoft Windows must communicate with the backup repository.
          format: int32
          default: 10001
        remoteRepositoryName:
          maxLength: 125
          minLength: 1
          type: string
          description: Name of a backup repository.
    WindowsBackupRepositoryTarget:
      required:
        - backupServer
      type: object
      properties:
        backupServer:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsBackupServerConnectionOptions'
          description: Veeam Backup & Replication server connection settings.
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsPolicyTargetCredentials'
          description: "Credentials of a user account that has access to the backup repository. \n> If no user credentials are specified, backup job uses the Microsoft Entra ID computer account.\n"
          nullable: true
        backupCacheSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupCacheSettings'
          description: "Local backup cache settings.\n> The `null` value indicates that local backup cache is disabled.\n"
          nullable: true
    WindowsCloudRepositoryTarget:
      type: object
      properties:
        backupCacheSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupCacheSettings'
          description: "Local backup cache settings.\n> The `null` value indicates that local backup cache is disabled.\n"
          nullable: true
    BackupCacheSettings:
      required:
        - location
      type: object
      properties:
        location:
          maxLength: 233
          minLength: 1
          pattern: '^[a-zA-Z]:(\\(?!(aux|con|nul|prn|com[1-9]|lpt[1-9])(\\|$))([^<>:"/\\|?*]+))+\\?$'
          type: string
          description: Path to the folder in which backup cache files must be stored.
        maximumSizeGb:
          maximum: 67107840
          minimum: 1
          type: integer
          description: 'Maximum size of the backup cache, in GB.'
          format: int32
          default: 10
    WindowsBackupSource:
      required:
        - backupMode
      type: object
      properties:
        backupMode:
          enum:
            - Unknown
            - EntireComputer
            - Volume
            - FilesFolders
          type: string
          description: Backup mode.
          x-extensible-enum: true
          x-ms-enum:
            name: WindowsBackupAgentJobBackupMode
        computerLevelOptions:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsComputerLevelBackupSource'
          description: Settings for entire computer backup.
          nullable: true
        volumeLevelOptions:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsVolumeLevelBackupSource'
          description: Settings required for the `Volume` backup mode.
          nullable: true
        fileLevelOptions:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsFileLevelBackupSource'
          description: Settings required for the `FilesFolders` backup mode.
          nullable: true
    WindowsComputerLevelBackupSource:
      required:
        - includeUsbDrives
      type: object
      properties:
        includeUsbDrives:
          type: boolean
          description: "Indicates whether external USB drives must be included in the backup.\n> USB flash drives are not supported.\n"
    WindowsVolumeLevelBackupSource:
      required:
        - volumes
      type: object
      properties:
        mode:
          enum:
            - Unknown
            - InclusionMode
            - ExclusionMode
          type: string
          description: Filter type.
          default: InclusionMode
          x-extensible-enum: true
          x-ms-enum:
            name: WindowsVolumeLevelBackupSourceMode
        backupOperatingSystem:
          type: boolean
          description: "Indicates whether agent operating system is included in a backup scope.\n>Available only if the `InclusionMode` filter type is selected.\n"
          default: false
        inclusions:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            minLength: 1
            pattern: '^[a-zA-Z]:\\?$'
            type: string
          description: "Array of drive letters of volumes that must be included in the backup scope.\n> Drive letters must be specified in the following format: `C:\\`.\n"
          nullable: true
        exclusions:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            minLength: 1
            pattern: '^[a-zA-Z]:\\?$'
            type: string
          description: "Array of drive letters of volumes that must be excluded from the backup scope.\n> Drive letters must be specified in the following format: `C:\\`.\n"
          nullable: true
    WindowsFileLevelBackupSource:
      type: object
      properties:
        includeDirectories:
          uniqueItems: true
          type: array
          items:
            minLength: 1
            pattern: '(^(([a-zA-Z]:\\)|(%.+%\\?))$)|(^(([a-zA-Z]:)|(%.+%))(\\(?!(aux|con|nul|prn|com[1-9]|lpt[1-9])(\\|$))([^<>:"/\\|?*]+))+\\?$)'
            type: string
          description: "Array of paths to folders containing the files that must be protected.\n> Can be skipped, if the `osfilesIncluded` or `personalFilesIncluded` property has the `true` value.'\n"
          nullable: true
        excludeDirectories:
          uniqueItems: true
          type: array
          items:
            minLength: 1
            pattern: '(^(([a-zA-Z]:\\)|(%.+%\\?))$)|(^(([a-zA-Z]:)|(%.+%))(\\(?!(aux|con|nul|prn|com[1-9]|lpt[1-9])(\\|$))([^<>:"/\\|?*]+))+\\?$)'
            type: string
          description: "Array of paths to folders containing the files that must not be protected.\n> Can be skipped, if the `osfilesIncluded` or `personalFilesIncluded` property has the `true` value.'\n"
          nullable: true
        inclusionMasks:
          uniqueItems: true
          type: array
          items:
            maxLength: 32767
            minLength: 1
            pattern: '^[^\/\\]+$'
            type: string
          description: Array of file names and/or masks for file types that must be protected.
          nullable: true
        exclusionMasks:
          uniqueItems: true
          type: array
          items:
            maxLength: 32767
            minLength: 1
            pattern: '^[^\/\\]+$'
            type: string
          description: Array of file names and/or masks for file types that must not be protected.
          nullable: true
        osfilesIncluded:
          type: boolean
          description: "Indicates whether the job must protect the OS data.\n> The `true` value automatically applies the `true` value to the `personalFilesIncluded` property.\n"
          default: false
        excludeOneDriveFolders:
          type: boolean
          description: Indicates whether the OneDrive folders must be excluded from the backup scope.
          default: false
        personalFilesIncluded:
          type: boolean
          description: "Indicates whether the job must protect the user profile folder including all user settings and data.\n> Has the `true` value if the `osfilesIncluded` property has the `true` value.'\n"
          default: false
        personalFilesAdvancedSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsPersonalFilesBackupAdvancedSettings'
          description: Advanced settings for personal files included in the backup scope.
          nullable: true
    WindowsPersonalFilesBackupAdvancedSettings:
      required:
        - inclusions
      type: object
      properties:
        inclusions:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Unknown
              - Desktop
              - Documents
              - Pictures
              - Video
              - Music
              - Favorites
              - Downloads
              - ApplicationData
              - OtherFilesAndFolders
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: WindowsPersonalFilesInclusions
          description: Profile folders that must be included in the backup scope.
        excludeNetworkAccount:
          type: boolean
          description: Indicates whether roaming user profiles must be excluded from the backup scope.
          default: false
    WindowsWorkstationJobRetentionSettings:
      type: object
      properties:
        retentionDays:
          maximum: 730
          minimum: 1
          type: integer
          description: Number of days for which backup files must be stored in the target location. Days without backups are not included.
          format: int32
          default: 7
    WindowsServerJobRetentionSettings:
      type: object
      properties:
        retentionMode:
          enum:
            - Unknown
            - Days
            - RestorePoints
          type: string
          description: "Retention policy type.\n> The `Days` type is available only for Veeam Agent for Microsoft Windows version 5.0 or later. For earlier versions the `RestorePoints` type is used.'\n"
          default: RestorePoints
          x-extensible-enum: true
          x-ms-enum:
            name: ServerRetentionMode
        retentionCount:
          maximum: 730
          minimum: 1
          type: integer
          description: Retention policy counter value.
          format: int32
          default: 7
    LinuxBackupPolicy:
      required:
        - jobConfiguration
        - operationMode
        - name
        - accessMode
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup policy.
          format: uuid
          readOnly: true
        id:
          type: integer
          description: System ID assigned to a backup policy.
          format: int32
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization to whose agents a backup policy is assigned.
          format: uuid
          readOnly: true
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^~"#%&*:<>?!/\\{|}''`$]+$'
          type: string
          description: Name of a backup policy.
        description:
          maxLength: 1024
          type: string
          description: Description of a backup policy.
          nullable: true
        createSubtenants:
          type: boolean
          description: Indicates whether a subtenant must be created for each Veeam backup agent.
          default: true
        unlimitedSubtenantQuota:
          type: boolean
          description: Indicates whether a subtenant can consume unlimited amount of space on a repository.
          default: false
        repositoryQuotaGB:
          type: integer
          description: "Maximum amount of space that a subtenant can consume on a repository.\n> If a subtenant can consume unlimited amount of space, the value of this property is ignored.'\n"
          format: int32
          default: 100
          nullable: true
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationMode'
        jobConfiguration:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBackupJobConfiguration'
          description: Job configuration.
        type:
          $ref: '#/components/schemas/BackupPolicyTypeReadonly'
        accessMode:
          $ref: '#/components/schemas/BackupPolicyAccessMode'
        createdBy:
          type: string
          description: Name of an organization that created a backup policy.
          readOnly: true
        modifiedDate:
          type: string
          description: Date and time when settings of a backup policy were last modified.
          format: date-time
          readOnly: true
        companies:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to companies to whose Veeam backup agents a policy is assigned.
          readOnly: true
        agents:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to management agents installed alongside Veeam backup agents with assigned policy.
          readOnly: true
        locations:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to locations to which management agents with assigned policy belong.
          readOnly: true
    LinuxBackupPolicyInput:
      required:
        - name
        - mode
        - accessMode
        - operationMode
        - jobConfiguration
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^~"#%&*:<>?!/\\{|}''`$]+$'
          type: string
          description: Backup policy name.
        description:
          maxLength: 1024
          type: string
          description: Backup policy description.
          default: ''
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationMode'
        accessMode:
          $ref: '#/components/schemas/BackupPolicyAccessMode'
        createSubtenants:
          type: boolean
          description: "Defines whether a subtenant must be created for each Veeam Agent for Linux.\n> Available if a cloud repository is selected as backup destination.\n"
          default: true
        unlimitedSubtenantQuota:
          type: boolean
          description: "Defines whether a subtenant can consume unlimited amount of space on a repository.\n> Available if a cloud repository is selected as backup destination.\n"
          default: false
        repositoryQuotaGB:
          type: integer
          description: "Maximum amount of space that a subtenant can consume on a repository.\n> If a subtenant can consume unlimited amount of space, the value of this property is ignored. <br>\n> Available if a cloud repository is selected as backup destination.\n"
          format: int32
          default: 100
          nullable: true
        jobConfiguration:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBackupJobConfiguration'
          description: Job configuration.
    LinuxBackupJobConfiguration:
      required:
        - backupSource
        - backupTarget
      type: object
      properties:
        backupSource:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBackupSource'
          description: Data included in the backup scope.
        backupTarget:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBackupTarget'
          description: Location of the backup files.
        backupStorage:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBackupStorage'
          description: Backup storage settings.
          x-veeam-create-by-default: true
        indexingSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxIndexingSettings'
          description: Guest OS indexing settings.
          nullable: true
        scriptSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxJobScriptSettings'
          description: Execution settings for job and snapshot scripts.
          nullable: true
        retentionSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxJobRetentionSettings'
          description: Retention policy settings for a backup job.
          x-veeam-create-by-default: true
        scheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxJobScheduleSettings'
          description: Scheduling settings for a backup job.
          x-veeam-create-by-default: true
        applicationAwareProcessingSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxJobApplicationAwareProcessingSettings'
          description: Application-aware processing settings.
          nullable: true
        gfsRetentionSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxGfsRetentionSettings'
          description: "GFS retention policy settings for the backup job.\n> The null value indicates that GFS retention is disabled. <br>\n> Available only to Veeam Agent for Linux starting from version 6.0.'\n"
          nullable: true
    LinuxGfsRetentionSettings:
      type: object
      properties:
        weekly:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxGfsWeeklyRetentionSettings'
          description: "GFS retention policy settings for weekly full backups.\nThe `null` value indicates that long-term retention is disabled for weekly full backups.\n"
          nullable: true
        monthly:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxGfsMonthlyRetentionSettings'
          description: "GFS retention policy settings for monthly full backups.\n> The `null` value indicates that long-term retention is disabled for monthly full backups.\n"
          nullable: true
        yearly:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxGfsYearlyRetentionSettings'
          description: "GFS retention policy settings for yearly full backups.\n> The `null` value indicates that long-term retention is disabled for yearly full backups.\n"
          nullable: true
    LinuxGfsWeeklyRetentionSettings:
      required:
        - keepWeeklyBackupsForWeeks
      type: object
      properties:
        keepWeeklyBackupsForWeeks:
          maximum: 9999
          minimum: 1
          type: integer
          description: Number of weeks during which restore points must not be modified or deleted.
          format: int32
          default: 1
        useFullBackupFrom:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Week day when Veeam Backup & Replication must assign the weekly GFS flag to a full restore point.
          default: Sunday
          x-ms-enum:
            name: DaysOfWeek
    LinuxGfsMonthlyRetentionSettings:
      required:
        - keepMonthlyBackupsForMonths
      type: object
      properties:
        keepMonthlyBackupsForMonths:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of months during which restore points must not be modified or deleted.
          format: int32
          default: 1
        useWeeklyFullBackupForTheFollowingWeekOfMonth:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
          description: Week when Veeam Backup & Replication must assign the monthly GFS flag to a full restore point.
          default: First
          x-ms-enum:
            name: LinuxGfsMonthlyWeeks
    LinuxGfsYearlyRetentionSettings:
      required:
        - keepYearlyBackupsForYears
      type: object
      properties:
        keepYearlyBackupsForYears:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of years during which restore points must not be modified or deleted.
          format: int32
          default: 1
        useMonthlyFullBackupForTheFollowingMonth:
          enum:
            - Jan
            - Feb
            - Mar
            - Apr
            - May
            - Jun
            - Jul
            - Aug
            - Sep
            - Oct
            - Nov
            - Dec
          type: string
          description: Month when Veeam Backup & Replication must assign the yearly GFS flag to a full restore point.
          default: Jan
          x-ms-enum:
            name: Month
    LinuxCustomJobConfiguration:
      required:
        - name
        - operationMode
        - accessMode
        - jobConfiguration
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^~"#%&*:<>?!/\\{|}''`$]+$'
          type: string
          description: Job name.
        description:
          maxLength: 1024
          type: string
          description: Job description.
          nullable: true
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationMode'
        cloudRepositoryConnectionSettings:
          $ref: '#/components/schemas/CloudRepositoryConnectionSettings'
        jobConfiguration:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBackupJobConfiguration'
          description: Job configuration.
    LinuxBackupSource:
      required:
        - backupMode
      type: object
      properties:
        backupMode:
          enum:
            - Unknown
            - EntireComputer
            - Volume
            - FilesFolders
          type: string
          description: Backup mode.
          x-extensible-enum: true
          x-ms-enum:
            name: LinuxBackupMode
        volumeLevelOptions:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxVolumeLevelBackupSource'
          description: Settings required for the `Volume` backup mode.
          nullable: true
        fileLevelOptions:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxFileLevelBackupSource'
          description: Settings required for the `FilesFolders` backup mode.
          nullable: true
    LinuxVolumeLevelBackupSource:
      required:
        - volumes
      type: object
      properties:
        volumes:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/LinuxBackupVolumeSourceSettings'
          description: Array of source directories.
    LinuxBackupVolumeSourceSettings:
      required:
        - volumeType
        - path
      type: object
      properties:
        volumeType:
          enum:
            - Device
            - MountPoint
            - LVM
            - BTRFS
          type: string
          description: Volume type.
          x-ms-enum:
            name: LinuxVolumeType
        path:
          type: string
          description: Path to a block device or mount point.
    LinuxFileLevelBackupSource:
      required:
        - directories
      type: object
      properties:
        directories:
          minItems: 1
          type: array
          items:
            pattern: '(^(\/[^/]+)+\/?$)|^\/$'
            type: string
          description: Array of paths to folders containing the files that must be protected.
          nullable: true
        inclusionMasks:
          uniqueItems: true
          type: array
          items:
            minLength: 1
            pattern: '^[^/\\]+$'
            type: string
          description: "Array of inclusion masks.\n> Use `*` to represent any amount of letters, and `?` to represent a single letter.\n"
          nullable: true
        exclusionMasks:
          uniqueItems: true
          type: array
          items:
            minLength: 1
            type: string
          description: "Array of exclusion masks.\n> Use `*` to represent any amount of letters, and `?` to represent a single letter. You can additionally specify path to a folder.\n"
          nullable: true
    LinuxBackupTarget:
      required:
        - targetType
      type: object
      properties:
        targetType:
          enum:
            - Unknown
            - LocalFolder
            - SharedFolder
            - BackupRepository
            - CloudRepository
            - ExternalRepository
          type: string
          description: Target location for the created backup.
          x-ms-enum:
            name: LinuxBackupTargetType
        localPath:
          maxLength: 4096
          pattern: '^(\/[^/]+)+\/?$'
          type: string
          description: "Path to the folder where backup files must be stored.\n> Required for the `LocalFolder` target location.\n"
          nullable: true
        sharedFolder:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxSharedFolderTarget'
          description: "Shared folder settings.\n> Required for the `SharedFolder` target location.\n"
          nullable: true
        backupRepository:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBackupServerSettings'
          description: "Veeam Backup & Replication repository settings.\n> Required for the `BackupRepository` target location.'\n"
          nullable: true
        enableDeletedFilesRetention:
          type: boolean
          description: Defines whether the deleted backup files must be removed after a specific time period.
          default: false
        removeDeletedItemsDataAfter:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of days for which the deleted backup files are stored.
          default: 30
    LinuxBackupHealthCheckScheduleSettings:
      type: object
      properties:
        monthlySettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBackupHealthCheckMonthlySchedule'
          description: "Scheduling settings for monthly full backup creation.\n> If the `weeklyOnDays` property is also provided, monthly schedule is ignored.\n"
          nullable: true
        weeklyOnDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: "Scheduling settings for weekly full backup creation.\n> If the `monthlySettings` property is also provided, it is ignored.\n"
          nullable: true
    LinuxBackupHealthCheckMonthlySchedule:
      required:
        - weekDayNumber
        - dayOfWeek
        - months
      type: object
      properties:
        weekDayNumber:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
          description: Counting number of the week day on which a job must start.
          x-ms-enum:
            name: WeekDayNumberType
        dayOfWeek:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Name of the week day on which a job must start.
          x-ms-enum:
            name: DaysOfWeek
        months:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Month'
          description: Array of months when a job must start.
    LinuxBackupStorage:
      type: object
      properties:
        compressionLevel:
          enum:
            - Unknown
            - NoCompression
            - Dedupe
            - Optimal
            - High
            - Extreme
          type: string
          description: Compression level for the backup.
          default: Optimal
          x-ms-enum:
            name: LinuxJobCompressionLevel
        blockSize:
          enum:
            - Unknown
            - LocalPb4MB
            - Local1MB
            - Lan512KB
            - Wan256KB
          type: string
          description: Type of data block size.
          default: Local1MB
          x-ms-enum:
            name: LinuxJobBlockSize
        encryptionEnabled:
          type: boolean
          description: "Indicates whether encryption is enabled.\n> Encryption cannot be enabled for backup files stored on the Veeam backup repository.\n"
          default: false
        password:
          maxLength: 255
          type: string
          description: "Password used for encryption.\n> Required if encryption is enabled.\n"
          format: password
          nullable: true
        passwordHint:
          maxLength: 255
          type: string
          description: "Hint for the password.\n> The hint must not consist of the password.\n"
          nullable: true
        isSnapshotRequired:
          type: boolean
          description: Indicates whether Veeam Agent for Linux must create a snapshot of a backed-up volume during backup.
          default: true
    LinuxIndexingSettings:
      type: object
      properties:
        indexingType:
          enum:
            - None
            - EveryFolders
            - SpecifiedFolders
            - ExceptSpecifiedFolders
          type: string
          description: Indexing mode.
          default: None
          x-ms-enum:
            name: LinuxIndexingType
        includedFolders:
          type: array
          items:
            minLength: 1
            pattern: '^[^<>]+$'
            type: string
          description: "Array of paths to the indexed folders.\n> Required for the `SpecifiedFolders` indexing mode.'\n"
          nullable: true
        excludedFolders:
          type: array
          items:
            minLength: 1
            pattern: '^[^<>]+$'
            type: string
          description: "Array of paths to folders that are excluded from the indexing scope.\n> Required for the `ExceptSpecifiedFolders` indexing mode.\n"
          nullable: true
    LinuxJobScriptSettings:
      type: object
      properties:
        enabled:
          type: boolean
          description: Indicates whether script processing is enabled.
          default: false
        preJobScript:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxJobScript'
          description: Path to a pre-job script.
          nullable: true
        postJobScript:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxJobScript'
          description: Path to a post-job script.
          nullable: true
        preFreezeScript:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxJobScript'
          description: Path to a pre-freeze script.
          nullable: true
        postThawScript:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxJobScript'
          description: Path to a post-thaw script.
          nullable: true
    LinuxJobScript:
      required:
        - fileName
      type: object
      properties:
        fileName:
          maxLength: 255
          minLength: 1
          type: string
          description: 'Script file name. Must match the following pattern: ''^[^/]+\.sh$''.'
        content:
          minLength: 1
          type: string
          description: Script content in the Base64 format. The property is write-only.
          format: byte
          nullable: true
          writeOnly: true
    LinuxJobRetentionSettings:
      type: object
      properties:
        restorePointsCount:
          maximum: 730
          minimum: 1
          type: integer
          description: Number of restore points that must be kept in the target location.
          format: int32
          default: 7
    LinuxJobScheduleSettings:
      type: object
      properties:
        scheduleType:
          enum:
            - Unknown
            - NotScheduled
            - Daily
            - Monthly
            - Periodically
          type: string
          description: Type of periodicity.
          default: NotScheduled
          x-extensible-enum: true
          x-ms-enum:
            name: LinuxScheduleType
        dailyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxDailyScheduleSettings'
          description: Scheduling settings required for a daily running job.
          nullable: true
          x-veeam-create-by-default: true
        monthlyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxMonthlyScheduleSettingsWithTime'
          description: Scheduling settings required for a monthly running job.
          nullable: true
        periodicallyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxPeriodicallyScheduleSettings'
          description: Scheduling settings required to run a job repeatedly throughout a day.
          nullable: true
        activeFullSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxActiveFullSettings'
          description: "Scheduling settings for periodically created active full backups.\n> The `null` value indicates that periodic creation of active full backups is disabled.'\n"
          nullable: true
        retrySettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxScheduleRetrySettings'
          description: Automatic retry settings.
          nullable: true
          x-veeam-create-by-default: true
        backupHealthCheckScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBackupHealthCheckScheduleSettings'
          description: "Backup files health check settings.\n> The `null` value indicates that health checks are disabled.\n"
          nullable: true
    LinuxDailyScheduleSettings:
      type: object
      properties:
        time:
          type: string
          description: 'Time of the day when a job must start, in the `hh:mm` format.'
          format: time-of-day
          default: '0:30'
        dailyMode:
          enum:
            - Everyday
            - SpecificDays
            - WeekDays
          type: string
          description: Type of the daily schedule.
          default: Everyday
          x-ms-enum:
            name: LinuxDailyScheduleDaysMode
        specificDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            minItems: 1
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: "Array of the week days on which a job must start.\n> Required for the `SpecificDays` type of the daily schedule.\n"
          nullable: true
    LinuxMonthlyScheduleSettingsWithTime:
      required:
        - monthlyMode
      type: object
      properties:
        time:
          type: string
          description: 'Time when a job must start, in the `hh:mm` format.'
          format: time-of-day
          default: '10:00'
        monthlyMode:
          $ref: '#/components/schemas/LinuxMonthlyScheduleSettingsMonthlyMode'
        weekDayNumber:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
            - Every
          type: string
          description: Counting number of the week day on which a job must start.
          nullable: true
          x-ms-enum:
            name: WeekDayNumber
        dayOfMonth:
          maximum: 31
          minimum: 1
          type: integer
          description: Numerical value of the day of the month on which a job must start.
          nullable: true
        dayOfWeek:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: "Name of the week day.\n> Required for all `WeekDayNumber` options of mouthly schedule except `Every`.\n"
          default: Sunday
          nullable: true
          x-ms-enum:
            name: DaysOfWeek
        months:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Month'
          description: Month.
          nullable: true
    LinuxMonthlyScheduleSettingsMonthlyMode:
      enum:
        - Unknown
        - Day
        - DayOfWeek
        - LastDayOfMonth
      type: string
      description: Monthly schedule type.
      default: Day
      x-ms-enum:
        name: LinuxMonthlyScheduleSettingsMonthlyMode
      x-veeam-expandable: true
    LinuxMonthlyScheduleSettings:
      required:
        - monthlyMode
      type: object
      properties:
        monthlyMode:
          $ref: '#/components/schemas/LinuxMonthlyScheduleSettingsMonthlyMode'
        weekDayNumber:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
            - Every
          type: string
          description: Counting number of the week day on which a job must start.
          nullable: true
          x-ms-enum:
            name: WeekDayNumber
        dayOfMonth:
          maximum: 31
          minimum: 1
          type: integer
          description: Numerical value of the day of the month on which a job must start.
          nullable: true
        dayOfWeek:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: "Name of the week day on which a job must start.\n> Required for all `weekDayNumber` property values except `Every`.\n"
          default: Sunday
          nullable: true
          x-ms-enum:
            name: DaysOfWeek
        months:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Month'
          description: Array of months when a job must start.
          nullable: true
    LinuxPeriodicallyScheduleSettings:
      type: object
      properties:
        intervalInMinutes:
          maximum: 1440
          minimum: 1
          type: integer
          description: 'Time interval for a periodically running job, in minutes.'
          default: 60
    LinuxActiveFullSettings:
      type: object
      properties:
        scheduleType:
          enum:
            - Unknown
            - NotScheduled
            - Monthly
            - Weekly
          type: string
          description: Type of periodicity.
          default: NotScheduled
          x-extensible-enum: true
          x-ms-enum:
            name: LinuxActiveFullSettingsScheduleType
        monthly:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxMonthlyScheduleSettings'
          nullable: true
        weeklyOnDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: Name of the week day.
          nullable: true
    LinuxScheduleRetrySettings:
      type: object
      properties:
        enabled:
          type: boolean
          description: Indicates whether Veeam Agent for Linux must attempt to run the backup job again if the job fails.
          default: false
        retryTimes:
          maximum: 777
          minimum: 1
          type: integer
          description: Number of attempts to run a job.
          format: int32
          default: 3
          nullable: true
        waitTimeoutMinutes:
          maximum: 999
          minimum: 1
          type: integer
          description: Time interval between attempts to run a job.
          format: int32
          default: 10
          nullable: true
    LinuxJobApplicationAwareProcessingSettings:
      type: object
      properties:
        oracleAapSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxOracleApplicationAwareProcessingSettings'
          description: Archived log handling settings for Oracle database.
          nullable: true
        mySqlAapSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxMySqlApplicationAwareProcessingSettings'
          description: MySQL database processing settings.
          nullable: true
        postgreSqlAapSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxPostgreSqlApplicationAwareProcessingSettings'
          description: PostgreSQL database processing settings.
          nullable: true
    LinuxOracleApplicationAwareProcessingSettings:
      type: object
      properties:
        processingType:
          enum:
            - DisableProcess
            - TryProcess
            - RequireSuccess
          type: string
          description: Processing type.
          default: DisableProcess
          x-ms-enum:
            name: LinuxAapProcessingType
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBaseCredentials'
          description: Credentials of a user account that Veeam Agent for Linux must use to connect to the Oracle database.
          nullable: true
        truncationConfig:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxOracleArchivedLogsTruncationConfig'
          description: Archived log processing settings.
          nullable: true
        useOracleCredentials:
          type: boolean
          description: Indicates whether the Oracle account credentials must be used.
          default: false
    LinuxOracleArchivedLogsTruncationConfig:
      type: object
      properties:
        truncationMode:
          enum:
            - TruncateDisabled
            - TruncateByAge
            - TruncateBySize
          type: string
          description: Archived log processing mode.
          default: TruncateDisabled
          x-ms-enum:
            name: LinuxOracleArchivedLogsTruncationMode
        sizeGB:
          maximum: 999
          minimum: 0
          type: integer
          description: "Maximum threshold for archived log file size, in GB. If an archived log file exceeds the limitation, it is deleted.\n> For the `TruncateBySize` archived log processing mode the property value must not be `0`.\n"
          format: int64
          default: 10
          nullable: true
        lifeTimeHours:
          maximum: 999
          minimum: 0
          type: integer
          description: "Amount of time after which archived logs must be deleted, in hours.\n> For the `TruncateByAge` archived log processing mode the property value must not be `0`.\n"
          format: int64
          default: 24
          nullable: true
    LinuxMySqlApplicationAwareProcessingSettings:
      type: object
      properties:
        processingType:
          enum:
            - DisableProcess
            - TryProcess
            - RequireSuccess
          type: string
          description: Transaction log processing mode.
          default: DisableProcess
          x-ms-enum:
            name: LinuxAapProcessingType
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBaseCredentials'
          description: Credentials of a user account that Veeam Agent for Linux must use to connect to the MySQL database.
          nullable: true
        authType:
          enum:
            - MySQLPassword
            - MySQLPasswordFile
          type: string
          description: Type of credentials format.
          default: MySQLPassword
          x-ms-enum:
            name: LinuxMySqlAuthType
        passwordFilePath:
          type: string
          description: Path to the password file.
          nullable: true
    LinuxPostgreSqlApplicationAwareProcessingSettings:
      type: object
      properties:
        processingType:
          enum:
            - DisableProcess
            - TryProcess
            - RequireSuccess
          type: string
          description: PostgreSQL database processing type.
          default: DisableProcess
          x-ms-enum:
            name: LinuxAapProcessingType
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxBaseCredentials'
          description: Credentials of a user account that Veeam Agent for Linux must use to connect to the PostgreSQL database.
          nullable: true
        authType:
          enum:
            - PSQLPassword
            - PSQLPasswordFile
            - PSQLPeer
          type: string
          description: Type of credentials format.
          default: PSQLPassword
          x-ms-enum:
            name: LinuxPostgreAuthType
    LinuxSharedFolderTarget:
      required:
        - targetType
        - path
      type: object
      properties:
        targetType:
          enum:
            - NFS
            - SMB
          type: string
          description: Type of a network shared folder.
          default: NFS
          x-ms-enum:
            name: LinuxSharedFolderTargetType
        path:
          pattern: '^([^/\\\][":;|<>+=,?* _]+\/[^/\\\][":;|<>+=,?*]+)((?:\/[^\\/:*?"<>|]+)*\/?)$'
          type: string
          description: Path to a network shared folder.'
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxCommonCredentials'
          description: Credentials of a user account that has access permissions on a shared folder.
          nullable: true
    LinuxBackupServerSettings:
      required:
        - connection
        - credentials
      type: object
      properties:
        connection:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxConnectionSettings'
          description: Settings required to connect a Linux computer to a Veeam Backup & Replication server.
        remoteRepositoryName:
          maxLength: 125
          minLength: 1
          type: string
          description: Name of a backup repository.
          nullable: true
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxCommonCredentials'
          description: Credentials of a user account that has access to a backup repository.
    LinuxConnectionSettings:
      required:
        - serverName
      type: object
      properties:
        serverName:
          maxLength: 4096
          minLength: 1
          pattern: '(^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\_\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-\_]*[A-Za-z0-9])$)|($(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])^)|(^(?:(?:[0-9a-fA-F:]){1,4}(?:(?::(?:[0-9a-fA-F]){1,4}|:)){2,7})+$)'
          type: string
          description: DNS name or IP address of a Veeam Backup & Replication server.
        serverPort:
          maximum: 65536
          minimum: 1
          type: integer
          description: Number of a port over which Veeam Agent for Linux must communicate with a Veeam Backup & Replication server.
          format: int32
          default: 10006
    LinuxBaseCredentials:
      required:
        - username
      type: object
      properties:
        username:
          maxLength: 256
          minLength: 1
          pattern: '^[^\/\\\[\]:;|=,+\*\?<>@"!#$%^&(){}]+(?<!\.)$'
          type: string
          description: User name.
        password:
          maxLength: 128
          type: string
          description: Password.
          format: password
          nullable: true
    LinuxCommonCredentials:
      required:
        - username
      type: object
      properties:
        username:
          maxLength: 256
          minLength: 1
          pattern: '^[^\/\[\]:;|=,+\*\?<>@"!#$%^&(){}]+(?<!\.)$'
          type: string
          description: User name.
        password:
          maxLength: 128
          type: string
          description: Password.
          format: password
          nullable: true
        domain:
          maxLength: 256
          type: string
          description: Domain.
          nullable: true
    MacBackupPolicy:
      required:
        - name
        - jobConfiguration
        - operationMode
        - accessMode
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup policy.
          format: uuid
          readOnly: true
        id:
          type: integer
          description: System ID assigned to a backup policy.
          format: int32
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization to whose agents a backup policy is assigned.
          format: uuid
          readOnly: true
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^~"#%&*:<>?!/\\{|}''`$]+$'
          type: string
          description: Name of a backup policy.
        description:
          maxLength: 1024
          type: string
          description: Description of a backup policy.
          nullable: true
        createSubtenants:
          type: boolean
          description: Indicates whether a subtenant must be created for each Veeam backup agent.
          default: true
        createSubFolders:
          type: boolean
          description: Indicates whether a subfolder must be created for each Veeam backup agent on the shared folder.
          default: false
        unlimitedSubtenantQuota:
          type: boolean
          description: Indicates whether a subtenant can consume unlimited amount of space on a repository.
          default: false
        repositoryQuotaGb:
          type: integer
          description: "Maximum amount of space that a subtenant can consume on a repository. \n> If a subtenant can consume unlimited amount of space, the value of this property is ignored.\n"
          format: int32
          default: 100
          nullable: true
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationMode'
        jobConfiguration:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacBackupJobConfiguration'
          description: Job configuration.
        accessMode:
          $ref: '#/components/schemas/BackupPolicyAccessMode'
        createdBy:
          type: string
          description: Name of an organization that created a backup policy.
          readOnly: true
        modifiedDate:
          type: string
          description: Date and time when settings of a backup policy were last modified.
          format: date-time
          readOnly: true
        companies:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to companies to whose Veeam backup agents a policy is assigned.
          readOnly: true
        agents:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to management agents installed alongside Veeam backup agents with assigned policy.
          readOnly: true
        locations:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to locations to which management agents with assigned policy belong.
          readOnly: true
    MacBackupPolicyInput:
      required:
        - name
        - mode
        - accessMode
        - operationMode
        - jobConfiguration
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^~"#%&*:<>?!/\\{|}''`$]+$'
          type: string
          description: Name of a backup policy.
        description:
          maxLength: 1024
          type: string
          description: Description of a backup policy.
          default: ''
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationMode'
        accessMode:
          $ref: '#/components/schemas/BackupPolicyAccessMode'
        createSubtenants:
          type: boolean
          description: "Defines whether a subtenant must be created for each Veeam Agent for Mac.\n> Available if a cloud repository is selected as backup destination.\n"
          default: true
        unlimitedSubtenantQuota:
          type: boolean
          description: "Defines whether a subtenant can consume unlimited amount of space on a repository.\n> Available if a cloud repository is selected as backup destination.\n"
          default: false
        repositoryQuotaGb:
          type: integer
          description: "Maximum amount of space that a subtenant can consume on a repository.\n> If a subtenant can consume unlimited amount of space, the value of this property is ignored.\n> Available if a cloud repository is selected as backup destination.\n"
          format: int32
          default: 100
          nullable: true
        jobConfiguration:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacBackupJobConfiguration'
          description: Job configuration.
    MacCustomJobConfiguration:
      required:
        - name
        - operationMode
        - accessMode
        - jobConfiguration
      type: object
      properties:
        name:
          minLength: 1
          pattern: '^[^~"#%&*:<>?!/\\{|}''`$]+$'
          type: string
          description: Name of a backup policy.
        description:
          maxLength: 1024
          type: string
          description: Description of a backup policy.
          nullable: true
        operationMode:
          $ref: '#/components/schemas/BackupJobOperationMode'
        cloudRepositoryConnectionSettings:
          $ref: '#/components/schemas/CloudRepositoryConnectionSettings'
        jobConfiguration:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacBackupJobConfiguration'
          description: Job configuration.
    MacBackupJobConfiguration:
      required:
        - backupSource
        - backupTarget
      type: object
      properties:
        backupSource:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacBackupSource'
          description: Data included in the backup scope.
        backupTarget:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacBackupTarget'
          description: Location of the backup files.
        backupStorage:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacBackupStorage'
          description: Backup storage settings.
          x-veeam-create-by-default: true
        retentionSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacJobRetentionSettings'
          description: Retention policy settings for a backup job.
          x-veeam-create-by-default: true
        scheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacJobScheduleSettings'
          description: Scheduling settings for a backup job.
          x-veeam-create-by-default: true
        gfsRetentionSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacGfsRetentionSettings'
          description: "GFS retention policy settings for a backup job.\n> The null value indicates that GFS retention is disabled.\n> Available only to Veeam Agent for Mac starting from version 6.0.'\n"
          nullable: true
    MacBackupSource:
      type: object
      properties:
        backupDirectlyFromLiveFileSystem:
          type: boolean
          description: Indicates whether backup is performed without creating snapshot. Required when backing up data stored in shared folders and file systems that are not supported by Veeam snapshot module.
          default: false
        includeUsbDrives:
          type: boolean
          description: "Indicates whether external USB drives are included in the backup.\n> USB flash drives are not supported.\n"
          default: false
        includeDirectories:
          minItems: 1
          type: array
          items:
            pattern: '(^(\/[^/]+)+\/?$)|^\/$'
            type: string
          description: ' Array of paths to folders containing the files that must be protected.'
          nullable: true
        inclusionMasks:
          uniqueItems: true
          type: array
          items:
            minLength: 1
            pattern: '^[^/\\]+$'
            type: string
          description: "Array of inclusion masks.\n> Use `*` to represent any amount of letters, and `?` to represent a single letter.\n"
          nullable: true
        excludeDirectories:
          minItems: 1
          type: array
          items:
            pattern: '(^(\/[^/]+)+\/?$)|^\/$'
            type: string
          description: Array of paths to folders containing the files that must be excluded from the backup.
          nullable: true
        exclusionMasks:
          uniqueItems: true
          type: array
          items:
            minLength: 1
            type: string
          description: "Array of exclusion masks.\n> Use `*` to represent any amount of letters, and `?` to represent a single letter. You can additionally specify path to a folder.\n"
          nullable: true
        personalFilesAdvancedSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacPersonalFilesBackupAdvancedSettings'
          description: Advanced settings for personal files included in the backup scope.
          nullable: true
    MacPersonalFilesBackupAdvancedSettings:
      required:
        - inclusions
      type: object
      properties:
        inclusions:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Unknown
              - Desktop
              - Documents
              - Pictures
              - Video
              - Music
              - Favorites
              - Downloads
              - ApplicationData
              - Library
              - OtherFilesAndFolders
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: MacPersonalFilesInclusions
          description: Profile folders that must be included in the backup scope.
        excludeNetworkAccount:
          type: boolean
          description: Exclude roaming user profiles from backup.
          default: false
    MacBackupTarget:
      required:
        - targetType
      type: object
      properties:
        targetType:
          enum:
            - Unknown
            - LocalFolder
            - SharedFolder
            - BackupRepository
            - CloudRepository
            - ExternalRepository
          type: string
          description: Type of a target location for the created backup.
          x-ms-enum:
            name: MacBackupTargetType
        localPath:
          maxLength: 4096
          pattern: '^(\/[^/]+)+\/?$'
          type: string
          description: "Path to the folder where backup files must be stored.\n> Required for the `LocalFolder` target location.\n"
          nullable: true
        sharedFolder:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacSharedFolderTarget'
          description: "Shared folder settings.\n> Required for the `SharedFolder` target location.\n"
          nullable: true
        backupRepository:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacBackupServerSettings'
          description: "Veeam Backup & Replication repository settings.\n> Required for the `BackupRepository` target location.'\n"
          nullable: true
        enableDeletedFilesRetention:
          type: boolean
          description: Defines whether the deleted backup files must be removed after a specific time period.
          default: false
        removeDeletedItemsDataAfter:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of days for which the deleted backup files are stored.
          default: 30
    MacSharedFolderTarget:
      required:
        - targetType
        - path
      type: object
      properties:
        path:
          pattern: '^([^/\\\][":;|<>+=,?* _]+\/[^/\\\][":;|<>+=,?*]+)((?:\/[^\\/:*?"<>|]+)*\/?)$'
          type: string
          description: Path to a network shared folder.
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacCommonCredentials'
          description: Credentials of a user account that has access permissions on a shared folder.
          nullable: true
    MacBackupServerSettings:
      required:
        - connection
        - credentials
      type: object
      properties:
        connection:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacConnectionSettings'
          description: Settings required to connect a Mac computer to a Veeam Backup & Replication server.
        remoteRepositoryName:
          maxLength: 125
          minLength: 1
          type: string
          description: Name of a remote backup repository.
          nullable: true
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacCommonCredentials'
          description: Credentials of a user account that has access to a Mac computer.
    MacConnectionSettings:
      required:
        - serverName
      type: object
      properties:
        serverName:
          maxLength: 4096
          minLength: 1
          pattern: '(^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\_\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-\_]*[A-Za-z0-9])$)|($(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])^)|(^(?:(?:[0-9a-fA-F:]){1,4}(?:(?::(?:[0-9a-fA-F]){1,4}|:)){2,7})+$)'
          type: string
          description: DNS name or IP address of a Veeam Backup & Replication server.
        serverPort:
          maximum: 65536
          minimum: 1
          type: integer
          description: Number of a port over which Veeam Agent for Linux must communicate with a Veeam Backup & Replication server.
          format: int32
          default: 10006
    MacCommonCredentials:
      required:
        - username
      type: object
      properties:
        username:
          maxLength: 256
          minLength: 1
          pattern: '^[^\/\[\]:;|=,+\*\?<>@"!#$%^&(){}]+(?<!\.)$'
          type: string
          description: User name.
        password:
          maxLength: 128
          type: string
          description: Password.
          format: password
          nullable: true
        domain:
          maxLength: 256
          type: string
          description: Domain.
          nullable: true
    MacBackupStorage:
      type: object
      properties:
        compressionLevel:
          enum:
            - Unknown
            - NoCompression
            - Dedupe
            - Optimal
            - High
            - Extreme
          type: string
          description: Compression level for the backup.
          default: Optimal
          x-ms-enum:
            name: MacJobCompressionLevel
        blockSize:
          enum:
            - Unknown
            - LocalPb4MB
            - Local1Mb
            - Lan512KB
            - Wan256KB
          type: string
          description: Type of data block size.
          default: Local1Mb
          x-ms-enum:
            name: MacJobBlockSize
        encryptionEnabled:
          type: boolean
          description: "Indicates whether encryption is enabled.\n> Encryption cannot be enabled for backup files stored on a Veeam backup repository.\n"
          default: false
        password:
          maxLength: 255
          type: string
          description: "Password used for encryption.\n> Required if encryption is enabled.\n"
          format: password
          nullable: true
        passwordHint:
          maxLength: 255
          type: string
          description: "Hint for a password.\n> The hint must not consist of the password.\n"
          nullable: true
    MacJobScheduleSettings:
      type: object
      properties:
        scheduleType:
          enum:
            - Unknown
            - NotScheduled
            - Daily
            - Monthly
            - Periodically
          type: string
          description: Type of job periodicity.
          default: NotScheduled
          x-extensible-enum: true
          x-ms-enum:
            name: MacScheduleType
        dailyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacDailyScheduleSettings'
          description: Scheduling settings required for a daily running job.
          nullable: true
          x-veeam-create-by-default: true
        monthlyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacMonthlyScheduleSettings'
          description: Scheduling settings required for a monthly running job.
          nullable: true
        periodicallyScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacPeriodicallyScheduleSettings'
          description: Scheduling settings required to run a job repeatedly throughout a day.
          nullable: true
        activeFullSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacActiveFullSettings'
          description: "Scheduling settings for periodically created active full backups.\n> The `null` value indicates that periodic creation of active full backups is disabled.'\n"
          nullable: true
        retrySettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacScheduleRetrySettings'
          description: Automatic retry settings.
          nullable: true
          x-veeam-create-by-default: true
        backupHealthCheckScheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacBackupHealthCheckScheduleSettings'
          description: "Scheduling settings for backup file health checks.\n> The `null` value indicates that health checks are disabled.\n"
          nullable: true
    MacBackupHealthCheckScheduleSettings:
      type: object
      properties:
        monthlySettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacBackupHealthCheckMonthlySchedule'
          description: "Scheduling settings for monthly full backup creation.\n> If the `weeklyOnDays` property is also provided, monthly schedule is ignored.'\n"
          nullable: true
        weeklyOnDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: "Scheduling settings for weekly full backup creation.\n> If the `monthlySettings` property is also provided, it is ignored.\n"
          nullable: true
    MacBackupHealthCheckMonthlySchedule:
      required:
        - weekDayNumber
        - dayOfWeek
        - months
      type: object
      properties:
        weekDayNumber:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
          description: Counting number of the week day on which a job must start.
          x-ms-enum:
            name: WeekDayNumberType
        dayOfWeek:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Name of the week day on which a job must start.
          x-ms-enum:
            name: DaysOfWeek
        months:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Month'
          description: Array of the months when a job must start.
    MacDailyScheduleSettings:
      type: object
      properties:
        time:
          type: string
          description: 'Time when a job must start, in the `hh:mm` format.'
          format: time-of-day
          default: '0:30'
        dailyMode:
          enum:
            - Everyday
            - SpecificDays
            - WeekDays
          type: string
          description: Type of the daily schedule.
          default: Everyday
          x-ms-enum:
            name: MacDailyScheduleDaysMode
        specificDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            minItems: 1
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: "Array of the week days on which a job must start.\n> Required for the `SpecificDays` type of the daily schedule.\n"
          nullable: true
    MacMonthlyScheduleSettings:
      required:
        - monthlyMode
      type: object
      properties:
        time:
          type: string
          description: 'Time when a job must start, in the `hh:mm` format.'
          format: time-of-day
          default: '10:00'
        monthlyMode:
          enum:
            - Unknown
            - Day
            - DayOfWeek
            - LastDayOfMonth
          type: string
          description: Type of the monthly schedule.
          default: Day
          x-ms-enum:
            name: MacMonthlyScheduleSettingsMonthlyMode
          x-veeam-expandable: true
        weekDayNumber:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
            - Every
          type: string
          description: Counting number of the week day on which a job must start.
          nullable: true
          x-ms-enum:
            name: WeekDayNumber
        dayOfMonth:
          maximum: 31
          minimum: 1
          type: integer
          description: Numerical value of the day of the month on which a job must start.
          nullable: true
        dayOfWeek:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Name of the week day on which a job must start. Required for all `WeekDayNumber` property values except `Every`.
          default: Sunday
          nullable: true
          x-ms-enum:
            name: DaysOfWeek
        months:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Month'
          description: Array of months when a job must start.
          nullable: true
    MacPeriodicallyScheduleSettings:
      type: object
      properties:
        intervalInMinutes:
          maximum: 1440
          minimum: 1
          type: integer
          description: 'Time interval for a periodically running job, in minutes.'
          default: 60
    MacActiveFullSettings:
      type: object
      properties:
        scheduleType:
          enum:
            - Unknown
            - NotScheduled
            - Monthly
            - Weekly
          type: string
          description: Type of periodicity.
          default: NotScheduled
          x-extensible-enum: true
          x-ms-enum:
            name: MacActiveFullSettingsScheduleType
        monthly:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacMonthlyScheduleSettings'
          description: Monthly schedule settings.
          nullable: true
        weeklyOnDays:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            enum:
              - Sunday
              - Monday
              - Tuesday
              - Wednesday
              - Thursday
              - Friday
              - Saturday
            type: string
            x-ms-enum:
              name: DaysOfWeek
          description: Array of the week days on which active full backups must be created.
          nullable: true
    MacScheduleRetrySettings:
      type: object
      properties:
        enabled:
          type: boolean
          description: Indicates whether Veeam Agent for Mac must attempt to run the backup job again if the job fails.
          default: false
        retryTimes:
          maximum: 777
          minimum: 1
          type: integer
          description: Number of attempts to run a job.
          format: int32
          default: 3
          nullable: true
        waitTimeoutMinutes:
          maximum: 999
          minimum: 1
          type: integer
          description: Time interval between attempts to run a job.
          format: int32
          default: 10
          nullable: true
    MacJobRetentionSettings:
      type: object
      properties:
        restorePointsCount:
          maximum: 730
          minimum: 1
          type: integer
          description: Number of restore points that must be kept in the target location.
          format: int32
          default: 7
    MacGfsRetentionSettings:
      type: object
      properties:
        weekly:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacGfsWeeklyRetentionSettings'
          description: "GFS retention policy settings for weekly full backups.\nThe `null` value indicates that long-term retention is disabled for weekly full backups.\n"
          nullable: true
        monthly:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacGfsMonthlyRetentionSettings'
          description: "GFS retention policy settings for monthly full backups.\nThe `null` value indicates that long-term retention is disabled for monthly full backups.\n"
          nullable: true
        yearly:
          type: object
          allOf:
            - $ref: '#/components/schemas/MacGfsYearlyRetentionSettings'
          description: "GFS retention policy settings for yearly full backups.\n> The `null` value indicates that long-term retention is disabled for yearly full backups.\n"
          nullable: true
    MacGfsWeeklyRetentionSettings:
      required:
        - keepWeeklyBackupsForWeeks
      type: object
      properties:
        keepWeeklyBackupsForWeeks:
          maximum: 9999
          minimum: 1
          type: integer
          description: Number of weeks during which restore points must not be modified or deleted.
          format: int32
          default: 1
        useFullBackupFrom:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Week day when Veeam Backup & Replication must assign the weekly GFS flag to a full restore point.
          default: Sunday
          x-ms-enum:
            name: DaysOfWeek
    MacGfsMonthlyRetentionSettings:
      required:
        - keepMonthlyBackupsForMonths
      type: object
      properties:
        keepMonthlyBackupsForMonths:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of months during which restore points must not be modified or deleted.
          format: int32
          default: 1
        useWeeklyFullBackupForTheFollowingWeekOfMonth:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
          description: Week of a month when Veeam Backup & Replication must assign the monthly GFS flag to a full restore point.
          default: First
          x-ms-enum:
            name: MacGfsMonthlyWeeks
    MacGfsYearlyRetentionSettings:
      required:
        - keepYearlyBackupsForYears
      type: object
      properties:
        keepYearlyBackupsForYears:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of years during which restore points must not be modified or deleted.
          format: int32
          default: 1
        useMonthlyFullBackupForTheFollowingMonth:
          enum:
            - Jan
            - Feb
            - Mar
            - Apr
            - May
            - Jun
            - Jul
            - Aug
            - Sep
            - Oct
            - Nov
            - Dec
          type: string
          description: Month when Veeam Backup & Replication must assign the yearly GFS flag to a full restore point.
          default: Jan
          x-ms-enum:
            name: Month
    BackupAgent:
      required:
        - guiMode
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        agentPlatform:
          enum:
            - Unknown
            - Windows
            - Linux
            - Mac
          type: string
          description: Name of a platform on which Veeam backup agent is deployed.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentPlatform
        status:
          enum:
            - Unknown
            - Active
            - NotRunning
          type: string
          description: Status of a Veeam backup agent.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentStatus
        managementAgentStatus:
          $ref: '#/components/schemas/ManagementAgentStatus'
        managementAgentUid:
          type: string
          description: UID assigned to a management agent that is deployed along with Veeam backup agent.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site on which an organization that owns Veeam backup agents is registered.
          format: uuid
          nullable: true
        organizationUid:
          type: string
          description: UID assigned to an organization to which Veeam backup agents belong.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a managed computer on which Veeam backup agent is deployed.
          readOnly: true
        operationMode:
          $ref: '#/components/schemas/BackupAgentOperationMode'
        guiMode:
          enum:
            - Unknown
            - ReadOnly
            - Full
          type: string
          description: Indicates the UI access mode for the Veeam backup agent.
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentGuiMode
        platform:
          enum:
            - Unknown
            - Physical
            - Cloud
            - Virtual
          type: string
          description: Computer platform on which Veeam backup agent is deployed.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentPlatformType
        version:
          type: string
          description: Version of Veeam backup agent deployed on a managed computer.
          readOnly: true
        versionStatus:
          enum:
            - Unknown
            - UpToDate
            - OutOfDate
          type: string
          description: Status of a backup agent version.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentVersionStatus
        activationTime:
          type: string
          description: Date and time when Veeam backup agent was activated.
          format: date-time
          nullable: true
          readOnly: true
        managementMode:
          enum:
            - Unknown
            - UnManaged
            - ManagedByVBR
            - ManagedByConsole
          type: string
          description: "Management mode of Veeam backup agent.\n> You can change management mode to `ManagedByConsole` or `UnManaged` using the PATCH endpoint.\n"
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentManagedMode
        installationType:
          enum:
            - Unknown
            - Full
            - Restricted
            - Broken
            - Installing
            - Uninstalling
          type: string
          description: Type of Veeam backup agent installation procedure.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentInstallationType
        totalJobsCount:
          type: integer
          description: Number of all jobs.
          format: int32
          readOnly: true
        runningJobsCount:
          type: integer
          description: Number of running jobs.
          format: int32
          readOnly: true
        successJobsCount:
          type: integer
          description: Number of successful jobs.
          format: int32
          readOnly: true
      example:
        managementAgentUid: BB111975-B409-49B5-8ECE-FFFECB13494F
        name: VAW AgentX
        operationMode: Server
        guiMode: ReadOnly
        platform: Cloud
    WindowsBackupAgent:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent that is deployed along with Veeam backup agent.
          format: uuid
          readOnly: true
        cbtDriverStatus:
          enum:
            - Unknown
            - NotInstalled
            - Installed
            - Error
            - Installing
            - Uninstalling
          type: string
          description: CBT driver status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentCbtDriverStatus
      example:
        instanceUid: 82b693e8-2d33-40f3-8991-a26e8bd86158
        managementAgentUid: 99ea35b0-d23f-41ab-8bb3-2e06555f039b
        cbtDriverStatus: NotInstalled
    BackupAgentOperationMode:
      enum:
        - Unknown
        - UnLicensed
        - Server
        - Workstation
      type: string
      description: Backup job operation mode.
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: BackupAgentOperationMode
    BackupAgentSettings:
      required:
        - disableScheduledBackups
        - disableControlPanelNotification
        - disableBackupOverMeteredConnection
        - disableScheduleWakeup
        - throttleBackupActivity
        - restrictVpnConnections
        - flrWithoutAdminPrivilegesAllowed
      type: object
      properties:
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        disableScheduledBackups:
          type: boolean
          description: Indicates whether a Veeam backup agent job schedule is disabled.
        disableControlPanelNotification:
          type: boolean
          description: Indicates whether Control Panel notifications.
        disableBackupOverMeteredConnection:
          type: boolean
          description: Indicates whether backup over metered connections is disabled.
          default: true
        disableScheduleWakeup:
          type: boolean
          description: Indicates whether a scheduled wake up timer is disabled.
        throttleBackupActivity:
          type: boolean
          description: Indicates whether Veeam backup agent throttles backup activities when system is busy.
          default: true
        restrictVpnConnections:
          type: boolean
          description: Indicates whether backup over VPN connections is disabled.
        limitBandwidthConsumption:
          type: boolean
          description: Indicates whether bandwidth consumption for backup jobs is limited.
          default: false
        bandwidthSpeedLimit:
          maximum: 9999
          minimum: 1
          type: integer
          description: Value of maximum speed for transferring backed-up data.
          format: int32
          nullable: true
        bandwidthSpeedLimitUnit:
          enum:
            - MbitPerSec
            - KbytePerSec
            - MbytePerSec
          type: string
          description: Measurement units of maximum speed for transferring backed-up data.
          nullable: true
          x-ms-enum:
            name: SpeedUnit
        flrWithoutAdminPrivilegesAllowed:
          type: boolean
          description: Indicates whether file-level restore is available to users that do not have administrative privileges.
    BackupAgentJob:
      required:
        - status
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam backup agent job.
          format: uuid
          readOnly: true
        originalUid:
          type: string
          description: UID assigned to a job on Veeam backup agent side.
          format: uuid
          nullable: true
          readOnly: true
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam backup agent job.
          nullable: true
          readOnly: true
        description:
          type: string
          description: Description of a Veeam backup agent job.
          nullable: true
          readOnly: true
        configUid:
          type: string
          description: UID assigned to a backup job configuration.
          format: uuid
          readOnly: true
        systemType:
          enum:
            - Unknown
            - Windows
            - Linux
            - Mac
          type: string
          description: Type of guest OS on a managed computer.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentJobSystemType
        backupPolicyUid:
          type: string
          description: UID of a backup policy assigned to a Veeam backup agent.
          format: uuid
          nullable: true
          readOnly: true
        backupPolicyName:
          type: string
          description: Name of a backup policy assigned to a Veeam backup agent.
          nullable: true
          readOnly: true
        backupPolicyAssignStatus:
          $ref: '#/components/schemas/BackupPolicyAssignStatus'
        backupPolicyFailureMessage:
          type: string
          description: "Message that is displayed in case a backup policy job fails.\n> Every line break is represented by the `\\r\\n` control characters.\n"
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/BackupAgentJobStatus'
        operationMode:
          $ref: '#/components/schemas/BackupAgentOperationMode'
        destination:
          type: string
          description: Location where backup files for a Veeam backup agent reside.
          nullable: true
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          nullable: true
          readOnly: true
        lastRun:
          type: string
          description: Date and time when the latest job session started.
          format: date-time
          nullable: true
          readOnly: true
        lastEndTime:
          type: string
          description: Date and time when the latest job session finished.
          format: date-time
          nullable: true
          readOnly: true
        lastDuration:
          type: integer
          description: 'Duration of the latest backup job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        nextRun:
          type: string
          description: Date and time of the next scheduled backup job session.
          format: date-time
          nullable: true
          readOnly: true
        avgDuration:
          type: integer
          description: 'Average duration of a backup job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        backupMode:
          $ref: '#/components/schemas/BackupAgentJobBackupMode'
        targetType:
          $ref: '#/components/schemas/BackupAgentJobTargetTypeDetailed'
        isEnabled:
          type: boolean
          description: "Indicates whether a job schedule is enabled.\n> Can be changed using the PATCH endpoint.\n"
          readOnly: true
        scheduleType:
          $ref: '#/components/schemas/BackupAgentJobScheduleType'
        scheduleDisplayName:
          type: string
          description: Name of a backup job schedule.
          readOnly: true
        lastModifiedDate:
          type: string
          description: Date and time when settings of a backup job were last modified.
          format: date-time
          nullable: true
          readOnly: true
        lastModifiedBy:
          type: string
          description: Name of a user who last modified job settings.
          nullable: true
          readOnly: true
        failureMessage:
          type: string
          description: Message that is displayed in case a backup job fails.
          nullable: true
          readOnly: true
        backedUpSize:
          type: integer
          description: 'Total size of all restore points, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        freeSpace:
          type: integer
          description: "Amount of free space available on the target repository.\n> If the job has never been run, the property value is `null`.\n"
          format: int64
          nullable: true
          readOnly: true
    BackupPolicyAssignStatus:
      enum:
        - Unknown
        - Assigned
        - Unassigned
        - Custom
        - Outdated
        - Applying
        - FailedToApply
        - Warning
        - Deleting
      type: string
      nullable: true
      readOnly: true
      x-extensible-enum: true
    BackupAgentJobTargetTypeDetailed:
      enum:
        - Unknown
        - LocalFolder
        - SharedFolder
        - BackupRepository
        - CloudRepository
      type: string
      description: Type of a location where backup files for a Veeam backup agent reside.
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: BackupAgentJobTargetTypeDetailed
    BackupAgentJobBackupMode:
      enum:
        - Unknown
        - EntireComputer
        - Volume
        - File
      type: string
      description: Type of backup operation mode.
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: BackupAgentJobBackupMode
    BackupAgentJobStatus:
      enum:
        - Unknown
        - None
        - Success
        - Warning
        - Failed
        - Starting
        - Running
        - Stopping
      type: string
      description: "Status of the latest job session.\n> Can be changed to `Running` or `Stopping` using the PATCH endpoint.\n"
      x-extensible-enum: true
      x-ms-enum:
        name: BackupAgentJobStatus
    BackupAgentJobScheduleType:
      enum:
        - Unknown
        - NotScheduled
        - Daily
        - Monthly
        - Periodically
        - Continuously
      type: string
      description: Type of schedule configured for the job.
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: BackupAgentJobScheduleType
    WindowsBackupAgentJob:
      required:
        - status
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Agent for Microsoft Windows job.
          format: uuid
          readOnly: true
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Agent for Microsoft Windows job.
          nullable: true
          readOnly: true
        description:
          type: string
          description: Description of a Veeam Agent for Microsoft Windows job.
          nullable: true
          readOnly: true
        configUid:
          type: string
          description: UID assigned to a backup job configuration.
          format: uuid
          readOnly: true
        backupPolicyUid:
          type: string
          description: UID of a backup policy assigned to a Veeam backup agent.
          format: uuid
          nullable: true
          readOnly: true
        backupPolicyName:
          type: string
          description: Name of a backup policy assigned to a Veeam backup agent.
          nullable: true
          readOnly: true
        backupPolicyAssignStatus:
          $ref: '#/components/schemas/BackupPolicyAssignStatus'
        backupPolicyFailureMessage:
          type: string
          description: Message that is displayed in case a backup policy job fails.
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/BackupAgentJobStatus'
        operationMode:
          $ref: '#/components/schemas/BackupAgentOperationMode'
        destination:
          type: string
          description: Location where backup files for a Veeam backup agent reside.
          nullable: true
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          nullable: true
          readOnly: true
        lastRun:
          type: string
          description: Date and time when the latest job session started.
          format: date-time
          nullable: true
          readOnly: true
        lastEndTime:
          type: string
          description: Date and time when the latest job session finished.
          format: date-time
          nullable: true
          readOnly: true
        lastDuration:
          type: integer
          description: 'Duration of the latest backup job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        nextRun:
          type: string
          description: Date and time of the next scheduled backup job session.
          format: date-time
          nullable: true
          readOnly: true
        avgDuration:
          type: integer
          description: 'Average duration of a backup job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        backupMode:
          $ref: '#/components/schemas/BackupAgentJobBackupMode'
        targetType:
          enum:
            - Unknown
            - Local
            - Cloud
          type: string
          description: Type of a location where backup files for a Veeam backup agent reside.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentJobTargetType
        isEnabled:
          type: boolean
          description: "Indicates whether a job schedule is enabled.\n> Can be changed using the PATCH endpoint.\n"
          readOnly: true
        scheduleType:
          $ref: '#/components/schemas/BackupAgentJobScheduleType'
        scheduleEvents:
          type: array
          items:
            enum:
              - Unknown
              - AtLock
              - AtLogoff
              - WhenBackupTargetIsConnected
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: BackupAgentJobScheduleEvent
          description: Events that trigger the backup job launch.
          readOnly: true
        lastModifiedDate:
          type: string
          description: Date and time when settings of the backup job were last modified.
          format: date-time
          nullable: true
          readOnly: true
        lastModifiedBy:
          type: string
          description: Name of the user who last modified job settings.
          nullable: true
          readOnly: true
        failureMessage:
          type: string
          description: Message that is displayed in case a backup job fails.
          nullable: true
          readOnly: true
        backedUpSize:
          type: integer
          description: 'Total size of all restore points, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        freeSpace:
          type: integer
          description: "Amount of free space available on the target repository.\n> If the job has never been run, the property value is `null`.\n"
          format: int64
          nullable: true
          readOnly: true
      example:
        backupAgentUid: CCEB5975-B409-49B5-8ECE-FFFECB13494F
        name: VAW job 2 Cloud
        configUid: AF097BD3-4AE9-4841-8152-8FF5CC703EAB
        status: Success
        operationMode: Server
        backupMode: File
        destination: \\share\backup\test
        restorePoints: 4
        lastRun: '2018-11-01T10:35:00.0000000+00:00'
        lastEndTime: '2018-11-01T10:45:00.0000000+00:00'
        lastDuration: 600
        nextRun: '2018-12-01T10:35:00.0000000+00:00'
        avgDuration: 575
        targetType: Local
        isEnabled: true
        schedulingType: Periodically
        failureMessage: ''
        lastModifiedDate: '2018-11-01T10:45:00.0000000+00:00'
        lastModifiedBy: someuser
        backedUpSize: 12550788
    LinuxBackupAgent:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent that is deployed along with Veeam backup agent.
          format: uuid
          readOnly: true
      example:
        instanceUid: 82b693e8-2d33-40f3-8991-a26e8bd86158
        managementAgentUid: 99ea35b0-d23f-41ab-8bb3-2e06555f039b
    LinuxBackupAgentJob:
      required:
        - status
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Agent for Linux job.
          format: uuid
          readOnly: true
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Agent for Linux job.
          nullable: true
          readOnly: true
        description:
          type: string
          description: Description of a Veeam Agent for Linux job.
          nullable: true
          readOnly: true
        configUid:
          type: string
          description: UID assigned to a backup job configuration.
          format: uuid
          readOnly: true
        backupPolicyUid:
          type: string
          description: UID of a backup policy assigned to a Veeam backup agent.
          format: uuid
          nullable: true
          readOnly: true
        backupPolicyName:
          type: string
          description: Name of a backup policy assigned to a Veeam backup agent.
          nullable: true
          readOnly: true
        backupPolicyAssignStatus:
          $ref: '#/components/schemas/BackupPolicyAssignStatus'
        backupPolicyFailureMessage:
          type: string
          description: "Message that is displayed in case a backup policy job fails.\n> Every line break is represented by the `\\r\\n` control characters.\n"
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/BackupAgentJobStatus'
        operationMode:
          $ref: '#/components/schemas/BackupAgentOperationMode'
        destination:
          type: string
          description: Location where backup files for a Veeam backup agent reside.
          nullable: true
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          nullable: true
          readOnly: true
        lastRun:
          type: string
          description: Date and time when the latest job session started.
          format: date-time
          nullable: true
          readOnly: true
        lastEndTime:
          type: string
          description: Date and time when the latest job session finished.
          format: date-time
          nullable: true
          readOnly: true
        lastDuration:
          type: integer
          description: 'Duration of the latest backup job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        nextRun:
          type: string
          description: Date and time of the next scheduled backup job session.
          format: date-time
          nullable: true
          readOnly: true
        avgDuration:
          type: integer
          description: 'Average duration of a backup job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        backupMode:
          $ref: '#/components/schemas/BackupAgentJobBackupMode'
        targetType:
          $ref: '#/components/schemas/BackupAgentJobTargetTypeDetailed'
        isEnabled:
          type: boolean
          description: "Indicates whether a job schedule is enabled.\n> Can be changed using the PATCH endpoint.\n"
          readOnly: true
        scheduleType:
          $ref: '#/components/schemas/BackupAgentJobScheduleType'
        lastModifiedDate:
          type: string
          description: Date and time when settings of the backup job were last modified.
          format: date-time
          nullable: true
          readOnly: true
        lastModifiedBy:
          type: string
          description: Name of the user who last modified job settings.
          nullable: true
          readOnly: true
        failureMessage:
          type: string
          description: Message that is displayed in case a backup job fails.
          nullable: true
          readOnly: true
        backedUpSize:
          type: integer
          description: 'Total size of all restore points, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        freeSpace:
          type: integer
          description: "Amount of free space available on the target repository.\n> If the job has never been run, the property value is `null`.\n"
          format: int64
          nullable: true
          readOnly: true
    MacBackupAgent:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent that is deployed along with Veeam Agent for Mac.
          format: uuid
          readOnly: true
      example:
        instanceUid: 82b693e8-2d33-40f3-8991-a26e8bd86158
        managementAgentUid: 99ea35b0-d23f-41ab-8bb3-2e06555f039b
    MacBackupAgentJob:
      required:
        - status
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Agent for Mac job.
          format: uuid
          readOnly: true
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Agent for Mac job.
          nullable: true
          readOnly: true
        description:
          type: string
          description: Description of a Veeam Agent for Mac job.
          nullable: true
          readOnly: true
        configUid:
          type: string
          description: UID assigned to a backup job configuration.
          format: uuid
          readOnly: true
        backupPolicyUid:
          type: string
          description: UID of a backup policy assigned to a Veeam backup agent.
          format: uuid
          nullable: true
          readOnly: true
        backupPolicyName:
          type: string
          description: Name of a backup policy assigned to a Veeam backup agent.
          nullable: true
          readOnly: true
        backupPolicyAssignStatus:
          $ref: '#/components/schemas/BackupPolicyAssignStatus'
        backupPolicyFailureMessage:
          type: string
          description: "Message that is displayed in case a backup policy job fails.\n> Every line break is represented by the `\\r\\n` control characters.\n"
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/BackupAgentJobStatus'
        operationMode:
          $ref: '#/components/schemas/BackupAgentOperationMode'
        destination:
          type: string
          description: Location where backup files for a Veeam backup agent reside.
          nullable: true
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          nullable: true
          readOnly: true
        lastRun:
          type: string
          description: Date and time when the latest backup job session started.
          format: date-time
          nullable: true
          readOnly: true
        lastEndTime:
          type: string
          description: Date and time when the latest backup job session finished.
          format: date-time
          nullable: true
          readOnly: true
        lastDuration:
          type: integer
          description: 'Duration of the latest backup job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        nextRun:
          type: string
          description: Date and time of the next scheduled backup job session.
          format: date-time
          nullable: true
          readOnly: true
        avgDuration:
          type: integer
          description: 'Average duration of a backup job session, in seconds.'
          format: int32
          nullable: true
          readOnly: true
        backupMode:
          $ref: '#/components/schemas/BackupAgentJobBackupMode'
        targetType:
          $ref: '#/components/schemas/BackupAgentJobTargetTypeDetailed'
        isEnabled:
          type: boolean
          description: "Indicates whether a job schedule is enabled.\n> Can be changed using the PATCH endpoint.\n"
          readOnly: true
        scheduleType:
          $ref: '#/components/schemas/BackupAgentJobScheduleType'
        lastModifiedDate:
          type: string
          description: Date and time when settings of a backup job were last modified.
          format: date-time
          nullable: true
          readOnly: true
        lastModifiedBy:
          type: string
          description: Name of the user who last modified job settings.
          nullable: true
          readOnly: true
        failureMessage:
          type: string
          description: Message that is displayed in case a backup job fails.
          nullable: true
          readOnly: true
        backedUpSize:
          type: integer
          description: 'Total size of all restore points, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        freeSpace:
          type: integer
          description: "Amount of free space available on the target repository.\n> If the job has never been run, the property value is `null`.\n"
          format: int64
          nullable: true
          readOnly: true
    TestSmtpSettingsResponse:
      required:
        - result
      type: object
      properties:
        smtpSettings:
          $ref: '#/components/schemas/SmtpSettings'
        serverCertificate:
          $ref: '#/components/schemas/SmtpServerCertificateInfo'
        result:
          enum:
            - Ok
            - ConnectionError
            - AuthenticationError
          type: string
        error:
          $ref: '#/components/schemas/ResponseError'
    SmtpSettings:
      required:
        - serverAddress
        - timeout
        - tlsMode
      type: object
      properties:
        serverAddress:
          type: string
          description: 'SMTP server URI containing protocol, host and port.'
        tlsMode:
          enum:
            - auto
            - none
            - sslOnConnect
            - startTls
            - startTlsWhenAvailable
          type: string
          description: Type of secure socket comminucation used to connect to an SMTP server.
          x-name: MailServerTlsMode
        timeout:
          type: string
          description: Connection timeout.
          format: time
        passwordCredential:
          required:
            - userName
          type: object
          properties:
            userName:
              type: string
              description: User name.
              nullable: true
            password:
              type: string
              description: Password.
              format: password
              nullable: true
            saslMechanism:
              type: string
              description: SASL mechanism that is used for authentication with the specified username and password.
              nullable: true
          description: Credentials required to access an SMTP server.
          nullable: true
        oAuth2Credential:
          type: object
          allOf:
            - $ref: '#/components/schemas/OAuth2Credential'
          description: Credentials for OAuth 2.0 authentication to an SMTP server.
          nullable: true
        exclusivelyAcceptedCertificateHash:
          type: string
          description: Server X509 certificate hex-encoded hash in the `<hash-algorithm>:<hash-hex>` format.
          nullable: true
      nullable: true
    SmtpServerCertificateInfo:
      required:
        - friendlyName
        - issuerName
        - notAfter
        - notBefore
        - serialNumber
        - subjectName
        - hash
        - signatureAlgorithm
        - isValid
      type: object
      properties:
        friendlyName:
          type: string
          description: Friendly name of a certificate.
        subjectName:
          type: string
          description: Name of a certificate subject.
        issuerName:
          type: string
          description: Name of a certificate issuer.
        notAfter:
          type: string
          description: Expiration date of a certificate.
          format: date
        notBefore:
          type: string
          description: Effective date of a certificate.
          format: date
        serialNumber:
          type: string
          description: Serial number of a certificate.
        signatureAlgorithm:
          type: string
          description: Signature algorithm of a certificate.
        hash:
          type: string
          description: Certificate hex-encoded hash in the `<hash-algorithm>:<hash-hex>` format.
        isValid:
          type: boolean
          description: Indicates whether a certificate is valid.
      description: Server X509 certificate information.
      nullable: true
    OAuth2Credential:
      required:
        - identityProviderSettings
        - userId
        - accessToken
        - accessTokenExpiration
        - clientSettings
        - refreshToken
      type: object
      properties:
        clientSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/OAuth2ClientSettings'
          description: OAuth 2.0 settings for mail server.
        userId:
          type: string
          description: User ID required to access the server.
          nullable: true
        accessToken:
          type: string
          description: Access token.
        accessTokenExpiration:
          type: string
          description: Date and time of the token expiration.
          format: date-time
        refreshToken:
          type: string
          description: Resfresh token.
    OAuth2ClientSettings:
      required:
        - kind
        - clientId
      type: object
      properties:
        kind:
          enum:
            - Google
            - Azure
            - AzureGovCloud
            - AzureChinaCloud
            - AzureGermany
          type: string
          description: Type of OAuth 2.0 identity provider.
          x-name: OAuth2ServiceKind
        clientId:
          type: string
          description: ID assigned to a client.
        clientSecret:
          type: string
          description: Client secret.
          nullable: true
        scope:
          type: string
          description: "Access token scope.\n> Leave empty to use default scope.\n"
          default: 
          nullable: true
        tenantId:
          type: string
          description: Tenant ID for Azure OAuth 2.0 service provider.
          nullable: true
    OAuth2SignInParameters:
      required:
        - location
        - navigationMode
      type: object
      properties:
        location:
          type: string
          description: Address to which the user should be redirected.
        navigationMode:
          enum:
            - redirect
          type: string
          description: Method of navigation to the specified location.
          x-name: NavigationMode
    TestEmailOptions:
      required:
        - from
        - to
      type: object
      properties:
        senderName:
          maxLength: 1024
          minLength: 1
          type: string
          description: Name of a sender.
          nullable: true
        from:
          maxLength: 1024
          minLength: 1
          type: string
          description: Email address from which test notification message is sent.
        to:
          maxLength: 1024
          minLength: 1
          type: string
          description: Email address to which test notification message is sent.
    NotificationBillingSettings:
      type: object
      properties:
        senderName:
          maxLength: 1024
          minLength: 1
          type: string
          description: Name of a sender.
          nullable: true
        from:
          maxLength: 1024
          minLength: 1
          type: string
          description: Email address from which notifications are sent.
          nullable: true
        subject:
          maxLength: 1024
          minLength: 1
          type: string
          description: Text that is displayed as a subject of notification.
          default: '%company%: %invoicePeriod%'
    NotificationDiscoverySettings:
      type: object
      properties:
        senderName:
          maxLength: 1024
          minLength: 1
          type: string
          description: Name of a sender.
          nullable: true
        from:
          maxLength: 1024
          minLength: 1
          type: string
          description: Email address from which notifications are sent.
          nullable: true
        to:
          maxLength: 1024
          minLength: 1
          type: string
          description: Email address at which notifications are sent.
          nullable: true
        subject:
          maxLength: 1024
          minLength: 1
          type: string
          description: Text that is displayed as a subject of notification.
          default: 'Company: "%company%", Location: "%location%", Rule: "%ruleName%", Status: "%ruleStatus%" '
        isDailyNotificationEnabled:
          type: boolean
          description: Indicates whether daily notifications are enabled.
          readOnly: true
        dailyTime:
          type: string
          description: Time at which daily notifications are sent.
          format: time-of-day
          nullable: true
    NotificationAlarmsSettings:
      type: object
      properties:
        senderName:
          maxLength: 1024
          minLength: 1
          type: string
          description: Name of a sender.
          nullable: true
        from:
          maxLength: 1024
          minLength: 1
          type: string
          description: Email address from which notifications must be sent.
          nullable: true
        to:
          maxLength: 1024
          minLength: 1
          type: string
          description: Email address at which notifications must be sent.
          nullable: true
        dailySubject:
          maxLength: 1024
          minLength: 1
          type: string
          description: Subject of notification message.
          default: 'Company: "%company%", Location: "%location%", Alarm: "%alarmName%", Status: "%alarmStatus%" '
        isDailyNotificationEnabled:
          type: boolean
          description: Indicates whether summary daily notifications is enabled.
          readOnly: true
        dailyTime:
          type: string
          description: Time of the day when summary daily notifications are sent.
          format: time-of-day
          default: '9:00'
        dailyStatusFilter:
          uniqueItems: true
          type: array
          items:
            enum:
              - Unknown
              - Resolved
              - Info
              - Warning
              - Error
              - Acknowledged
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: NotificationAlarmsSettingsDailyStatusFilter
          description: Array of statuses that alarms must have to be included into daily notifications.
          nullable: true
        dailySorting:
          enum:
            - Unknown
            - ByTime
            - ByStatus
            - ByObjectName
            - ByAlarmName
          type: string
          description: Type of sorting applied to the list of alarms included into daily notifications.
          default: ByTime
          x-extensible-enum: true
          x-ms-enum:
            name: NotificationAlarmsSettingsDailySorting
    NotificationLicenseSettings:
      type: object
      properties:
        senderName:
          maxLength: 1024
          minLength: 1
          type: string
          description: Name of a sender.
          nullable: true
        from:
          maxLength: 1024
          minLength: 1
          type: string
          description: Email address from which notifications must be sent.
          nullable: true
        to:
          maxLength: 1024
          minLength: 1
          type: string
          description: Email address at which notifications must be sent.
          nullable: true
        enabled:
          type: boolean
          description: Indicates whether notifications are enabled.
          nullable: true
    PolicySettings:
      type: object
      properties:
        mfaPolicyStatus:
          enum:
            - Unknown
            - Disabled
            - Enabled
            - EnabledByInheritance
          type: string
          description: Status of MFA configuration requirement for user.
          default: Disabled
          x-extensible-enum: true
          x-ms-enum:
            name: OrganizationMfaPolicyStatus
        enforceMfaPolicy:
          type: boolean
          description: Indicates whether MFA policy is applied to child organizations.
          nullable: true
    NotificationSettings:
      required:
        - billing
        - discovery
        - alarms
        - license
      type: object
      properties:
        smtp:
          type: object
          allOf:
            - $ref: '#/components/schemas/SmtpSettings'
          description: SMTP server settings.
          nullable: true
        billing:
          type: object
          allOf:
            - $ref: '#/components/schemas/NotificationBillingSettings'
          description: Billing notification settings.
        discovery:
          type: object
          allOf:
            - $ref: '#/components/schemas/NotificationDiscoverySettings'
          description: Settings for notifications about discovery results.
        alarms:
          type: object
          allOf:
            - $ref: '#/components/schemas/NotificationAlarmsSettings'
          description: Alarm notification settings.
        license:
          type: object
          allOf:
            - $ref: '#/components/schemas/NotificationLicenseSettings'
          description: License notification settings.
        level:
          enum:
            - Unknown
            - disabled
            - summary
            - all
          type: string
          description: Level of notifications.
          default: disabled
          x-extensible-enum: true
          x-ms-enum:
            name: NotificationSettingsLevel
        defaultSenderName:
          maxLength: 1024
          minLength: 1
          type: string
          description: Name of a sender.
          nullable: true
        defaultFrom:
          maxLength: 1024
          minLength: 1
          type: string
          description: Default email address from which notification messages must be sent.
          nullable: true
    BrandingSettings:
      required:
        - webUri
      type: object
      properties:
        portalColorTheme:
          enum:
            - Unknown
            - Blue
            - Green
            - Yellow
            - Turquoise
            - Red
            - Grey
            - Pink
          type: string
          description: Interface color scheme.
          default: Blue
          x-extensible-enum: true
          x-ms-enum:
            name: BrandingColorTheme
        managedOrganizationsBrandingPolicy:
          enum:
            - Unknown
            - AllowCustomization
            - ForceInheritance
          type: string
          description: Type of portal branding policy applied to managed organizations.
          default: AllowCustomization
          x-extensible-enum: true
          x-ms-enum:
            name: BrandingManagedOrganizationsBrandingPolicy
    LicenseSettings:
      required:
        - isAutoUpdateEnabled
      type: object
      properties:
        isAutoUpdateEnabled:
          type: boolean
          description: Indicates whether license auto update is enabled.
    BillingSettings:
      required:
        - includeDetails
      type: object
      properties:
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        includeDetails:
          type: boolean
          description: Indicates whether billing details are included.
    Invoice:
      required:
        - data
      type: object
      properties:
        name:
          type: string
          description: Name of an organization.
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        instanceUid:
          type: string
          description: UID assigned to an invoice.
          format: uuid
          readOnly: true
        amount:
          type: number
          description: Total cost of consumed backup services
          format: double
          nullable: true
          readOnly: true
        currencyCode:
          type: string
          description: Currency code.
          nullable: true
          readOnly: true
        subscriptionPlanUid:
          type: string
          description: UID assigned to a subscription plan.
          format: uuid
          nullable: true
          readOnly: true
        creationDate:
          type: string
          description: Date and time when an invoice was generated.
          format: date-time
          readOnly: true
        paidDate:
          type: string
          description: Date and time when an invoice was marked as paid.
          format: date-time
          nullable: true
          readOnly: true
        dueDate:
          type: string
          description: Date and time by which a payment must be made.
          format: date-time
          nullable: true
          readOnly: true
        status:
          enum:
            - Unknown
            - Unpaid
            - Paid
            - Overdue
          type: string
          description: Invoice status.
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: InvoiceStatus
        type:
          enum:
            - Unknown
            - Invoice
            - QuotaUsage
          type: string
          description: Type of an invoice.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: InvoiceType
        data:
          $ref: '#/components/schemas/InvoiceData'
    InvoicePeriod:
      type: object
      properties:
        fromDate:
          type: string
          description: Start date and time.
          format: date-time
          nullable: true
          readOnly: true
        toDate:
          type: string
          description: End date and time.
          format: date-time
          nullable: true
          readOnly: true
      description: Period for which information about services consumed by each company is included in an invoice.
      readOnly: true
    InvoiceData:
      required:
        - period
      type: object
      properties:
        period:
          $ref: '#/components/schemas/InvoicePeriod'
        charges:
          type: array
          items:
            $ref: '#/components/schemas/InvoiceCharge'
          description: Detailed information on all consumed services and their costs.
          nullable: true
          readOnly: true
        totalNet:
          type: number
          description: Final cost.
          format: double
          nullable: true
          readOnly: true
        totalGross:
          type: number
          description: Total cost before applying discounts and taxes.
          format: double
          nullable: true
          readOnly: true
        totalDiscount:
          type: number
          description: Discounted amount.
          format: double
          nullable: true
          readOnly: true
        totalTax:
          type: number
          description: Sales tax amount.
          format: double
          nullable: true
          readOnly: true
      description: Invoice details.
    InvoiceCharge:
      type: object
      properties:
        category:
          enum:
            - Unknown
            - ManagedServices
            - MonitoredServices
            - ManagedRemoteVm
            - ManagedRemoteServer
            - ManagedRemoteWorkstation
            - ManagedRemoteCdpVm
            - ManagedHostedVm
            - ManagedHostedServer
            - ManagedHostedWorkstation
            - ManagedHostedCdpVm
            - RemoteShortTermBackup
            - RemoteLongTermBackup
            - RemoteSourceAmountOfData
            - HostedShortTermBackup
            - HostedLongTermBackup
            - HostedSourceAmountOfData
            - ManagedRemoteCloudVm
            - ManagedHostedCloudVm
            - PublicCloudRemoteFileShare
            - PublicCloudRemoteDatabase
            - PublicCloudRemoteBackupSize
            - PublicCloudRemoteArchiveSize
            - PublicCloudHostedFileShare
            - PublicCloudHostedDatabase
            - PublicCloudHostedBackupSize
            - PublicCloudHostedArchiveSize
            - CloudVmBackup
            - CloudServerBackup
            - CloudWorkstationBackup
            - CloudBackupDataTransferOut
            - CloudRepositoryAllocatedSpace
            - CloudRepositoryConsumedSpace
            - CloudInsiderProtection
            - CloudPerformanceTierConsumedSpace
            - CloudCapacityTierConsumedSpace
            - CloudArchiveTierConsumedSpace
            - WindowsDesktopOSRemote
            - WindowsServerOSRemote
            - LinuxOSRemote
            - MacOSRemote
            - WindowsDesktopOSHosted
            - WindowsServerOSHosted
            - LinuxOSHosted
            - MacOSHosted
            - CloudVmReplica
            - CloudVmCdpReplica
            - CloudVmReplicaConsumedStorage
            - CloudVmReplicaConsumedMemory
            - CloudVmReplicaComputeResources
            - CloudReplicationDataTransferOut
            - Vb365RemoteUser
            - Vb365RemoteBackupSize
            - Vb365RemoteArchiveSize
            - Vb365HostedUser
            - Vb365HostedBackupSize
            - Vb365HostedArchiveSize
            - LicVspcWorkstation
            - LicVspcServer
            - LicStandardVbrVm
            - LicStandardVbrWorkstation
            - LicStandardVbrServer
            - LicStandardVbrApplication
            - LicStandardVbrMicrosoftEntraId
            - LicStandardVbrFileShare
            - LicStandardVbrObjectStorage
            - LicEnterpriseVbrVm
            - LicEnterpriseVbrWorkstation
            - LicEnterpriseVbrServer
            - LicEnterpriseVbrApplication
            - LicEnterpriseVbrMicrosoftEntraId
            - LicEnterpriseVbrFileShare
            - LicEnterpriseVbrObjectStorage
            - LicEnterprisePlusVbrVm
            - LicEnterprisePlusVbrWorkstation
            - LicEnterprisePlusVbrServer
            - LicEnterprisePlusVbrApplication
            - LicEnterprisePlusVbrMicrosoftEntraId
            - LicEnterprisePlusVbrFileShare
            - LicEnterprisePlusVbrObjectStorage
            - LicVccBackupVm
            - LicVccReplicaVm
            - LicVccServer
            - LicVccWorkstation
            - LicVb365User
            - LicPublicCloudVm
            - LicPublicCloudDatabase
            - LicPublicCloudFileShare
            - LicVeeamOneMonitoredObject
            - VbrRepositoryRemoteConsumedSpace
            - VbrRepositoryRemoteAllocatedSpace
            - VbrRepositoryHostedConsumedSpace
            - VbrRepositoryHostedAllocatedSpace
            - PublicCloudRemoteNetwork
            - PublicCloudRemoteNetworkBackupServices
            - PublicCloudHostedNetwork
            - PublicCloudHostedNetworkBackupServices
            - Vb365RemoteEducationalUser
            - Vb365RemoteRepositoryAllocatedSpace
            - Vb365HostedEducationalUser
            - Vb365HostedRepositoryAllocatedSpace
            - LicStandardVbrCloudVm
            - LicStandardVbrCloudFileShare
            - LicStandardVbrCloudDatabase
            - LicEnterpriseVbrCloudVm
            - LicEnterpriseVbrCloudFileShare
            - LicEnterpriseVbrCloudDatabase
            - LicEnterprisePlusVbrCloudVm
            - LicEnterprisePlusVbrCloudFileShare
            - LicEnterprisePlusVbrCloudDatabase
            - LicFoundationVdpVm
            - LicFoundationVdpWorkstation
            - LicFoundationVdpServer
            - LicFoundationVdpApplication
            - LicFoundationVdpFileShare
            - LicFoundationVdpObjectStorage
            - LicFoundationVdpMicrosoftEntraId
            - LicFoundationVdpCloudVm
            - LicFoundationVdpCloudFileShare
            - LicFoundationVdpCloudDatabase
            - LicAdvancedVdpVm
            - LicAdvancedVdpWorkstation
            - LicAdvancedVdpServer
            - LicAdvancedVdpApplication
            - LicAdvancedVdpFileShare
            - LicAdvancedVdpObjectStorage
            - LicAdvancedVdpMicrosoftEntraId
            - LicAdvancedVdpCloudVm
            - LicAdvancedVdpCloudFileShare
            - LicAdvancedVdpCloudDatabase
            - LicPremiumVdpVm
            - LicPremiumVdpWorkstation
            - LicPremiumVdpServer
            - LicPremiumVdpApplication
            - LicPremiumVdpFileShare
            - LicPremiumVdpObjectStorage
            - LicPremiumVdpMicrosoftEntraId
            - LicPremiumVdpCloudVm
            - LicPremiumVdpCloudFileShare
            - LicPremiumVdpCloudDatabase
          type: string
          description: Type of consumed service.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: InvoiceChargeCategory
        measure:
          enum:
            - None
            - Bytes
            - KB
            - MB
            - GB
            - TB
            - PB
            - Seconds
            - Minutes
            - Hours
            - Days
            - Weeks
            - Months
            - Units
          type: string
          description: Measurement units of consumed service.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: InvoiceMeasure
        quantity:
          type: number
          description: Amount of consumed service units.
          format: double
          nullable: true
          readOnly: true
        net:
          type: number
          description: Final cost of consumed service.
          format: double
          nullable: true
          readOnly: true
        gross:
          type: number
          description: Cost of consumed service before applying descount and taxes.
          format: double
          nullable: true
          readOnly: true
        discount:
          type: number
          description: Discounted amount.
          format: double
          nullable: true
          readOnly: true
        tax:
          type: number
          description: Sales tax amount.
          format: double
          nullable: true
          readOnly: true
    DiscoveryRule:
      required:
        - masterAgentUid
        - name
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a discovery rule.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a discovery rule
        masterAgentUid:
          type: string
          description: UID assigned to a master agent.
          format: uuid
        locationUid:
          type: string
          description: UID assigned to a location for which a discovery rule is configured.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company for which a discovery rule is configured.
          format: uuid
          readOnly: true
        systemType:
          enum:
            - Unknown
            - Windows
            - Linux
          type: string
          description: Type of guest OS.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: DiscoveryRuleSystemType
        status:
          enum:
            - Unknown
            - Created
            - Running
            - Success
            - Canceled
            - Failed
            - CancellationRequested
            - CancellationRequestFailed
          type: string
          description: Current status of a discovery rule.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: DiscoveryRuleStatus
        lastRun:
          type: string
          description: Date and time of the latest discovery session.
          format: date-time
          nullable: true
          readOnly: true
        filter:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleFilter'
          description: Discovery filter.
          nullable: true
        notificationSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleNotificationSettings'
          description: Settings configured for email notifications about discovery results.
          nullable: true
        scheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleScheduleSettings'
          description: Discovery scheduling settings.
          nullable: true
          x-veeam-create-by-default: true
        totalComputersCount:
          type: integer
          description: Number of discovered computers.
          format: int32
          readOnly: true
        onlineComputersCount:
          type: integer
          description: Number of online computers.
          format: int32
          readOnly: true
        offlineComputersCount:
          type: integer
          description: Number of offline computers.
          format: int32
          readOnly: true
    EmbeddedForDiscoveryRuleChildren:
      type: object
      properties:
        discoveryRule:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRule'
          description: Resource representation of a discovery rule.
          nullable: true
          readOnly: true
      description: Resource representation of the related discovery rule entity.
      nullable: true
      readOnly: true
    EmbeddedForWindowsDiscoveryRuleChildren:
      type: object
      properties:
        discoveryRule:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRule'
          description: Resource representation of a descovery rule.
          nullable: true
          readOnly: true
        windowsDiscoveryRule:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsDiscoveryRule'
          description: Resource representation of a Windows discovery rule.
          nullable: true
          readOnly: true
      description: Resource representation of the related Windows discovery rule entity.
      nullable: true
      readOnly: true
    EmbeddedForLinuxDiscoveryRuleChildren:
      type: object
      properties:
        discoveryRule:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRule'
          description: Resource representation of discovery rule.
          nullable: true
          readOnly: true
        linuxDiscoveryRule:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxDiscoveryRule'
          description: Resource representation of a Linux discovery rule.
          nullable: true
          readOnly: true
      description: Resource representation of the related Linux discovery rule entity.
      nullable: true
      readOnly: true
    WindowsDiscoveryRule:
      required:
        - masterAgentUid
        - accessAccount
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a discovery rule.
          format: uuid
          readOnly: true
        method:
          enum:
            - Unknown
            - NetworkBased
            - AD
            - Manual
          type: string
          description: Discovery method.
          default: NetworkBased
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: WindowsDiscoveryRuleMethod
        useMasterManagementAgentCredentials:
          type: boolean
          description: Indicates whether Veeam Service Provider Console must use master agent credentials to connect discovered computers.
          default: true
        accessAccount:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleCredentials'
          description: Credentials of an account with Local Administrator permissions on discovered computers.
        deploymentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsDiscoveryRuleDeploymentSettings'
          description: Settings configured for Veeam backup agent deployment.
          nullable: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForDiscoveryRuleChildren'
    LinuxDiscoveryRule:
      required:
        - masterAgentUid
        - credentials
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a discovery rule.
          format: uuid
          readOnly: true
        method:
          enum:
            - Unknown
            - NetworkBased
            - Manual
          type: string
          description: Discovery method.
          default: NetworkBased
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: LinuxDiscoveryRuleMethod
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/LinuxDiscoveryCredentials'
          description: Credentials required to access discovered computers.
        deploymentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxDiscoveryRuleDeploymentSettings'
          description: Settings configured for Veeam backup agent deployment.
          nullable: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForDiscoveryRuleChildren'
    DiscoveryRuleFilter:
      type: object
      properties:
        exclusionMask:
          type: array
          items:
            type: string
          description: Array of applied exclusion masks. For custom discovery rules this property is ignored.
          nullable: true
        ignoreInaccessibleMachine:
          type: boolean
          description: Indicates whether discovery is performed among accessible computers only.
          default: false
        osTypes:
          uniqueItems: true
          type: array
          items:
            enum:
              - Unknown
              - WindowsServer
              - WindowsWorkstation
              - CentOS
              - Debian
              - OracleLinux
              - Fedora
              - Ubuntu
              - OpenSUSE
              - SLES
              - RedHat
              - AmazonLinux
              - RockyLinux
              - AlmaLinux
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: DiscoveryRuleFilterOperationSystemType
          description: Type of operating system.
          nullable: true
        applications:
          uniqueItems: true
          type: array
          items:
            enum:
              - Unknown
              - OtherApp
              - MicrosoftExchangeServer
              - MicrosoftSqlServer
              - MicrosoftActiveDirectory
              - MicrosoftSharePoint
              - Oracle
              - MySQL
              - PostgreSQL
              - MongoDB
              - ApacheServer
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: DiscoveryRuleFilterApplication
          description: Applications that must run on discovered computers.
          nullable: true
        customApplication:
          type: string
          description: "Name of an application required for the `OtherApp` application type.\n> Available only for Linux computers.\n"
          nullable: true
        platforms:
          uniqueItems: true
          type: array
          items:
            enum:
              - Unknown
              - Other
              - MicrosoftHyperVandVmWareVSphere
              - Physical
              - MicrosoftAzure
              - AmazonWebServices
              - GoogleCloud
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: DiscoveryRuleFilterPlatform
          description: Platforms on which discovered computers must run.
          nullable: true
    DiscoveryRuleNetwork:
      required:
        - networkName
        - firstIp
        - lastIp
      type: object
      properties:
        networkName:
          type: string
          description: Name of a network configured in Veeam Service Provider Console.
        firstIp:
          pattern: '^(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)$'
          type: string
          description: First IP-address in the range set for discovery.
        lastIp:
          pattern: '^(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)$'
          type: string
          description: Last IP-address in the range set for discovery.
        trustOptions:
          type: object
          allOf:
            - $ref: '#/components/schemas/MachinesNetworkTrustOptions'
          description: Trust options for Linux computers in the selected range of IP addresses.
          nullable: true
      example:
        networkName: Production
        firstIp: 172.17.53.1
        lastIp: 172.17.53.50
    MachinesNetworkTrustOptions:
      required:
        - trustOption
      type: object
      properties:
        trustOption:
          enum:
            - Unknown
            - All
            - KnownList
          type: string
          description: Type of trusted computer selection.
          x-extensible-enum: true
          x-ms-enum:
            name: NetworkTrustOption
        knownHostList:
          type: string
          description: List of trusted computers required for the `KnownList` type of selection.
          nullable: true
    WindowsNetworkBasedDiscoveryRule:
      required:
        - networks
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a network-based discovery rule.
          format: uuid
          readOnly: true
        networks:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/DiscoveryRuleNetwork'
          description: Network settings.
        _embedded:
          $ref: '#/components/schemas/EmbeddedForWindowsDiscoveryRuleChildren'
    LinuxNetworkBasedDiscoveryRule:
      required:
        - networks
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a network-based discovery rule.
          format: uuid
          readOnly: true
        networks:
          type: array
          items:
            $ref: '#/components/schemas/DiscoveryRuleNetwork'
          description: Network settings.
        _embedded:
          $ref: '#/components/schemas/EmbeddedForLinuxDiscoveryRuleChildren'
    WindowsNetworkBasedDiscoveryRuleInput:
      required:
        - name
        - masterAgentUid
        - networks
        - accessAccount
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^\<\>\=\%\~]+$'
          type: string
          description: Name of a network-based discovery rule.
        masterAgentUid:
          type: string
          description: UID assigned to a master agent.
          format: uuid
        networks:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/DiscoveryRuleNetwork'
          description: Range of IP addresses.
        useMasterManagementAgentCredentials:
          type: boolean
          description: Indicates whether credentials specified in the master management agent configuration must be used.
          default: true
        accessAccount:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleCredentials'
          description: Credentials of an account with Local Administrator permissions on discovered computers.
        filter:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleFilter'
          description: Discovery filter.
          nullable: true
        notificationSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleNotificationSettings'
          description: Settings configured for email notifications about discovery results.
          nullable: true
        deploymentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsDiscoveryRuleDeploymentSettings'
          description: Settings configured for Veeam backup agent deployment.
          nullable: true
        scheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleScheduleSettings'
          description: Discovery scheduling settings.
          nullable: true
          x-veeam-create-by-default: true
    LinuxNetworkBasedDiscoveryRuleInput:
      required:
        - name
        - masterAgentUid
        - networks
        - credentials
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^\<\>\=\%\~]+$'
          type: string
          description: Name of a network-based discovery rule.
        masterAgentUid:
          type: string
          description: UID assigned to a master agent.
          format: uuid
        networks:
          type: array
          items:
            $ref: '#/components/schemas/DiscoveryRuleNetwork'
          description: Range of IP addresses.
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/LinuxDiscoveryCredentialsInput'
          description: Credentials required to access discovered computers.
        filter:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleFilter'
          description: Discovery filter.
          nullable: true
        notificationSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleNotificationSettings'
          description: Settings configured for email notifications about discovery results.
          nullable: true
        deploymentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxDiscoveryRuleDeploymentSettings'
          description: Settings configured for Veeam backup agent deployment.
          nullable: true
        scheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleScheduleSettings'
          description: Discovery scheduling settings.
          nullable: true
          x-veeam-create-by-default: true
    WindowsCustomDiscoveryRule:
      required:
        - hosts
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a custom discovery rule.
          format: uuid
          readOnly: true
        hosts:
          minItems: 1
          type: array
          items:
            type: string
          description: Array of IP addresses or DNS names of computers on which Veeam backup agent is deployed.
        _embedded:
          $ref: '#/components/schemas/EmbeddedForWindowsDiscoveryRuleChildren'
    LinuxCustomDiscoveryRule:
      required:
        - hosts
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a custom discovery rule.
          format: uuid
          readOnly: true
        hosts:
          minItems: 1
          type: array
          items:
            type: string
          description: Array of IP addresses or DNS names of computers on which Veeam backup agent is deployed.
        _embedded:
          $ref: '#/components/schemas/EmbeddedForLinuxDiscoveryRuleChildren'
    WindowsCustomDiscoveryRuleInput:
      required:
        - name
        - masterAgentUid
        - hosts
        - accessAccount
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^\<\>\=\%\~]+$'
          type: string
          description: Name of a discovery rule.
        masterAgentUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
        hosts:
          minItems: 1
          type: array
          items:
            type: string
          description: Array of IP addresses or DNS names of computers on which Veeam backup agent is deployed.
        useMasterManagementAgentCredentials:
          type: boolean
          description: Indicates whether credentials specified in the master management agent configuration must be used.
          default: true
        accessAccount:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleCredentials'
          description: Credentials of an account with Local Administrator permissions on discovered computers.
        filter:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleFilter'
          description: Discovery filter.
          nullable: true
        notificationSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleNotificationSettings'
          description: Settings configured for email notifications about discovery results.
          nullable: true
        deploymentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsDiscoveryRuleDeploymentSettings'
          description: Settings configured for Veeam backup agent deployment.
          nullable: true
        scheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleScheduleSettings'
          description: Discovery scheduling settings.
          nullable: true
          x-veeam-create-by-default: true
    LinuxCustomDiscoveryRuleInput:
      required:
        - name
        - masterAgentUid
        - hosts
        - credentials
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^\<\>\=\%\~]+$'
          type: string
          description: Name of a discovery rule.
        masterAgentUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
        hosts:
          type: array
          items:
            type: string
          description: Array of IP addresses or DNS names of computers on which Veeam Agent for Linux is deployed.
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/LinuxDiscoveryCredentialsInput'
          description: Credentials required to access discovered computers.
        filter:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleFilter'
          description: Discovery filter.
          nullable: true
        notificationSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleNotificationSettings'
          description: Settings configured for email notifications about discovery results.
          nullable: true
        deploymentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/LinuxDiscoveryRuleDeploymentSettings'
          description: Settings configured for Veeam backup agent deployment.
          nullable: true
        scheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleScheduleSettings'
          description: Discovery scheduling settings.
          nullable: true
          x-veeam-create-by-default: true
    WindowsActiveDirectoryBasedDiscoveryRule:
      required:
        - adMethod
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to an Microsoft Entra ID discovery rule.
          format: uuid
          readOnly: true
        customQuery:
          type: string
          description: LDAP query that returns a list of computers to scan.
          nullable: true
        adMethod:
          enum:
            - Unknown
            - Search
            - Query
            - Custom
          type: string
          description: Microsoft Entra ID discovery method.
          x-extensible-enum: true
          x-ms-enum:
            name: WindowsDiscoveryRuleAdMethod
        skipOfflineComputersDays:
          type: integer
          description: Number of days for which offline computers are skipped from discovery.
          format: int32
          nullable: true
        _embedded:
          $ref: '#/components/schemas/EmbeddedForWindowsDiscoveryRuleChildren'
    WindowsActiveDirectoryBasedDiscoveryRuleInput:
      required:
        - name
        - masterAgentUid
        - adMethod
        - accessAccount
      type: object
      properties:
        name:
          maxLength: 128
          minLength: 1
          pattern: '^[^\<\>\=\%\~]+$'
          type: string
          description: Name of an Microsoft Entra ID discovery rule.
        masterAgentUid:
          type: string
          description: UID assigned to a master agent.
          format: uuid
        skipOfflineComputersDays:
          type: integer
          description: Number of days for which offline computers are skipped from discovery.
          format: int32
          nullable: true
        customQuery:
          type: string
          description: LDAP query that returns a list of computers to scan.
          nullable: true
        adMethod:
          enum:
            - Unknown
            - Search
            - Query
            - Custom
          type: string
          description: Microsoft Entra ID discovery method.
          x-extensible-enum: true
          x-ms-enum:
            name: WindowsDiscoveryRuleAdMethod
        useMasterManagementAgentCredentials:
          type: boolean
          description: Indicates whether credentials specified in the master management agent configuration must be used.
          default: true
        accessAccount:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleCredentials'
          description: Credentials of an account with Local Administrator permissions on discovered computers.
        filter:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleFilter'
          description: Discovery filter.
          nullable: true
        notificationSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleNotificationSettings'
          description: Settings configured for email notifications about discovery results.
          nullable: true
        deploymentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/WindowsDiscoveryRuleDeploymentSettings'
          description: Settings configured for Veeam backup agent deployment.
          nullable: true
        scheduleSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleScheduleSettings'
          description: Discovery scheduling settings.
          nullable: true
          x-veeam-create-by-default: true
    DiscoveryRuleNotificationSettings:
      required:
        - scheduleType
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether notifications about discovery results are enabled.
          default: true
        scheduleType:
          enum:
            - Days
            - Weeks
          type: string
          description: Notification frequency.
          nullable: true
          x-ms-enum:
            name: SchedulePeriod
        scheduleTime:
          type: string
          description: Time at which notifications must are sent in the `hh:mm` format.
          format: time-of-day
          default: '10:00'
        weekSettings:
          required:
            - scheduleDay
          type: object
          properties:
            scheduleDay:
              enum:
                - Sunday
                - Monday
                - Tuesday
                - Wednesday
                - Thursday
                - Friday
                - Saturday
              type: string
              description: Day at which notifications must are sent.
              x-ms-enum:
                name: DayOfWeek
          nullable: true
        to:
          maxLength: 128
          minLength: 1
          type: string
          description: Email address at which notifications must be sent.
          nullable: true
        subject:
          maxLength: 128
          minLength: 1
          pattern: '^[^\<\>\=\%\~]+$'
          type: string
          description: Subject of a notification message.
          nullable: true
        notifyOnTheFirstRun:
          type: boolean
          description: 'Indicates whether a notification must be sent on the first '
          default: false
      example:
        isEnabled: true
        scheduleType: Days
        scheduleTime: '12:30'
        scheduleDay: Sunday
        to: administrator@vac.com
        subject: VSPC Discovery Results
        notifyOnTheFirstRun: false
    WindowsDiscoveryRuleDeploymentSettings:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether Veeam backup agent is automatically installed on computers as part of discovery.
          default: false
        backupPolicyUid:
          type: string
          description: UID of a discovery rule that must be assigned after Veeam Agent for Microsoft Windows installation.
          format: uuid
          nullable: true
        setReadOnlyAccess:
          type: boolean
          description: Indicates whether the read-only access mode is enabled for Veeam Agent for Microsoft Windows.
          default: true
        backupAgentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupAgentSettings'
          description: Veeam backup agent settings.
          nullable: true
    LinuxDiscoveryRuleDeploymentSettings:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether Veeam backup agent is automatically installed on computers as part of discovery.
          default: false
        backupPolicyUid:
          type: string
          description: UID of a discovery rule that must be assigned after installation.
          format: uuid
          nullable: true
        setReadOnlyAccess:
          type: boolean
          description: Indicates whether the read-only access mode is enabled for Veeam Agent for Linux.
          default: true
    DiscoveredComputer:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a discovered computer.
          format: uuid
          readOnly: true
        ruleUid:
          type: string
          description: UID assigned to a rule used to discover a computer.
          format: uuid
          nullable: true
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a discovered computer.
          format: uuid
          nullable: true
          readOnly: true
        discoveredTime:
          type: string
          description: Date and time when a computer was discovered.
          format: date-time
          nullable: true
          readOnly: true
        backupAgentInstallationStatus:
          enum:
            - Unknown
            - Installed
            - NotInstalled
          type: string
          description: Status of Veeam backup agent installation on a discovered computer.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: InstallationStatus
        status:
          enum:
            - Unknown
            - Online
            - Offline
            - Error
          type: string
          description: "Computer connection status.\n> If management agent is not installed on the computer, the connection status does not change after discovery.'\n"
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ComputerStatus
        backupAgentVersion:
          type: string
          description: Veeam backup agent version.
          readOnly: true
        backupAgentManagementStatus:
          enum:
            - Unknown
            - UnManaged
            - ManagedByVBR
            - ManagedByConsole
          type: string
          description: Veeam backup agent management status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentManagedMode
        info:
          type: object
          allOf:
            - $ref: '#/components/schemas/ComputerInfo'
          description: Information about a discovered computer.
          readOnly: true
    AutoDeploymentSettings:
      type: object
      properties:
        organizationUid:
          type: string
          description: UID assigned to an organization that manages Veeam backup agent auto deployment.
          format: uuid
          readOnly: true
        isEnabled:
          type: boolean
          description: Indicates whether auto deployment is enabled.
          default: false
        windowsBackupPolicyUid:
          type: string
          description: UID of a backup policy that must be assigned to a Veeam Agent for Microsoft Windows.
          format: uuid
          nullable: true
        linuxBackupPolicyUid:
          type: string
          description: UID of a backup policy that must be assigned to a Veeam Agent for Linux.
          format: uuid
          nullable: true
        macBackupPolicyUid:
          type: string
          description: UID of a backup policy that must be assigned to a Veeam Agent for Mac.
          format: uuid
          nullable: true
        isRetryEnabled:
          type: boolean
          description: Indicates whether retry is enabled in case deployment session fails.
          default: false
        retryCount:
          type: integer
          description: Number of allowed retries.
          format: int32
          default: 3
        retryInterval:
          type: integer
          description: Time interval in minutes after which the next deployment attempt starts.
          format: int32
          default: 7
        acceptNewConnections:
          type: boolean
          description: Indicates whether Veeam Service Provider Console accepts connections from new management agents.
          default: true
        installDriver:
          type: boolean
          description: Indicates whether CBT driver is installed during auto deployment.
          default: false
        setReadOnlyAccess:
          type: boolean
          description: Indicates whether the read-only access mode is enabled for Veeam backup agent.
          default: true
        backupAgentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupAgentSettings'
          description: Veeam backup agent settings.
          nullable: true
    About:
      type: object
      properties:
        installationId:
          type: string
          description: UID assigned to a Veeam Service Provider Console unique installation type.
          format: uuid
          readOnly: true
        installationDate:
          type: string
          description: Date of Veeam Service Provider Console installation.
          format: date-time
          readOnly: true
        actualVawVersion:
          type: string
          description: Current version of Veeam Agent for Windows.
          nullable: true
          readOnly: true
        actualValVersion:
          type: string
          description: Current version of Veeam Agent for Linux.
          nullable: true
          readOnly: true
        actualVamVersion:
          type: string
          description: Current version of Veeam Agent for Mac.
          nullable: true
          readOnly: true
        serverVersion:
          type: string
          description: Veeam Service Provider Console Server version.
          readOnly: true
        windowsManagementAgentVersion:
          type: string
          description: Version of management agents for Microsoft Windows computers.
          readOnly: true
        linuxManagementAgentVersion:
          type: string
          description: Version of management agents for Linux computers.
          readOnly: true
        macManagementAgentVersion:
          type: string
          description: Version of management agents for macOS computers.
          readOnly: true
    BackupAgentAssignedBackupPolicy:
      type: object
      properties:
        configUid:
          type: string
          description: UID assigned to a backup policy configuration.
          format: uuid
          readOnly: true
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        backupPolicyUid:
          type: string
          description: UID assigned to a backup policy.
          format: uuid
          readOnly: true
        backupPolicyId:
          type: integer
          description: System ID assigned to a backup policy.
          format: int32
          readOnly: true
        status:
          enum:
            - Unknown
            - Applying
            - Applied
            - Warning
            - Failed
            - Removing
          type: string
          description: Status of the policy assignment.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: BackupAgentAssignedBackupPolicyStatus
        isCustom:
          type: boolean
          description: Indicates whether a backup policy is custom.
          readOnly: true
        isOutOfDate:
          type: boolean
          description: Indicates whether a newer revision of a backup policy exists that has not been assigned to an agent.
          readOnly: true
        backupPolicyFailureMessage:
          type: string
          description: Message that is displayed in case backup policy assignment fails.
          readOnly: true
        backupPolicyRevision:
          type: integer
          description: Revision of a backup policy.
          format: int32
          nullable: true
          readOnly: true
        assignedDate:
          type: string
          description: "Date of the policy assignment.\n> If the backup policy is assigned to a Linux or Mac computer, the value of this property is `null`.\n"
          format: date-time
          nullable: true
          readOnly: true
        assignedBy:
          type: string
          description: "Organization or user who assigned a backup policy.\n> If the backup policy is assigned to a Linux or Mac computer, the value of this property is `null`.\n"
          nullable: true
          readOnly: true
    UserLogin:
      required:
        - id
        - userUid
        - identifierInProvider
        - identityProviderName
        - description
        - usage
        - isReadAccessOnly
        - status
      type: object
      properties:
        id:
          type: integer
          description: System ID assigned to a user identity.
          format: int64
          readOnly: true
        userUid:
          type: string
          description: UID assigned to a user.
          format: uuid
          readOnly: true
        userName:
          type: string
          description: User name.
          readOnly: true
        companyId:
          type: string
          description: UID assigned to a user company.
          format: uuid
          readOnly: true
        companyName:
          type: string
          description: Name of a user company.
          readOnly: true
        identityProviderName:
          type: string
          description: Name of an identity provider that manages user identity.
          readOnly: true
        description:
          type: string
          description: Description of a user identity.
        isReadAccessOnly:
          type: boolean
          description: Indicates whether a user identity has the read-only access.
          readOnly: true
        scopes:
          type: array
          items:
            enum:
              - unknown
              - integration
              - rest
              - ui
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: UserLoginScope
          description: Services that are available to the user identity.
          readOnly: true
        status:
          enum:
            - Unknown
            - enabled
            - disabled
            - disabledDueToUser
            - disabledDueToCompany
            - disabledDueToSystem
            - disabledDueSystemComponentsRestrictions
            - disabledDueToTenant
          type: string
          description: "User identity status.\n> You can change status to `enabled` or `disabled` using the PATCH method.\n"
          x-extensible-enum: true
          x-ms-enum:
            name: UserLoginStatus
        parameters:
          type: string
          description: Parameters of a user identity.
          readOnly: true
        identifierInProvider:
          type: string
          description: Provided identity.
          readOnly: true
        creationDate:
          type: string
          description: Date and time of identity creation.
          format: date-time
          readOnly: true
      x-veeam-expandable: true
    RsaKeyPair:
      required:
        - privateKey
        - publicKey
      type: object
      properties:
        privateKey:
          type: string
          description: Private key.
          readOnly: true
        publicKey:
          type: string
          description: Public key.
          readOnly: true
    TotpSecret:
      required:
        - secret
        - secretUrl
      type: object
      properties:
        secret:
          type: string
          description: TOTP secret encoded in the Base 32 format.
          readOnly: true
        secretUrl:
          type: string
          description: URL encoded secret for authentication applications.
          readOnly: true
    CompleteSmtpOAuth2SignInResponseData:
      type: object
      properties:
        credential:
          type: object
          allOf:
            - $ref: '#/components/schemas/OAuth2Credential'
          description: OAuth 2.0 pair of tokens.
          nullable: true
    User:
      required:
        - role
        - profile
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a user.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to a user organization.
          format: uuid
          readOnly: true
        userName:
          type: string
          description: User name.
          readOnly: true
        status:
          enum:
            - Unknown
            - Enabled
            - Disabled
          type: string
          description: User status.
          default: Enabled
          x-extensible-enum: true
          x-ms-enum:
            name: UserStatus
        mfaPolicyStatus:
          enum:
            - Unknown
            - Disabled
            - Enabled
            - EnabledByInheritance
          type: string
          description: Status of MFA configuration requirement for user.
          default: Disabled
          x-extensible-enum: true
          x-ms-enum:
            name: UserMfaPolicyStatus
        mfaPolicyConfigurationStatus:
          enum:
            - Unknown
            - NotConfigured
            - Configured
          type: string
          description: Status of user MFA policy configuration.
          default: NotConfigured
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: UserMfaPolicyConfigurationStatus
        role:
          $ref: '#/components/schemas/UserRole'
        profile:
          type: object
          allOf:
            - $ref: '#/components/schemas/UserProfile'
          description: User profile.
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/CredentialsInfo'
          description: User credentials.
          nullable: true
    UserRole:
      enum:
        - Unknown
        - PortalAdministrator
        - PortalOperator
        - PortalReadonlyOperator
        - SiteAdministrator
        - CompanyLocationAdministrator
        - CompanyLocationUser
        - CompanyOwner
        - CompanyAdministrator
        - CompanyInvoiceAuditor
        - CompanySubtenant
        - ResellerOwner
        - ResellerOperator
        - ResellerUser
        - ResellerInvoiceAuditor
        - ResellerAdministrator
        - CompanyTenant
      type: string
      description: User role.
      x-extensible-enum: true
      x-ms-enum:
        name: UserRole
    UserProfile:
      type: object
      properties:
        firstName:
          maxLength: 2048
          type: string
          description: User first name.
          nullable: true
        lastName:
          maxLength: 2048
          type: string
          description: User last name.
          nullable: true
        title:
          enum:
            - Unknown
            - Mr
            - Miss
            - Mrs
            - Ms
          type: string
          description: User title.
          default: Unknown
          x-ms-enum:
            name: UserTitle
        email:
          maxLength: 2048
          minLength: 1
          pattern: '^(")?(?:[^\."])(?:(?:[\.])?(?:[\w\-!#$%&''*+\/=?\^_`{|}~]))*\1@(\w[\-\w]*\.){1,5}([A-Za-z]){2,6}$'
          type: string
          description: User email address.
          nullable: true
        address:
          maxLength: 2048
          type: string
          description: Address of a user or user organization.
          nullable: true
        phone:
          maxLength: 512
          type: string
          description: Telephone number of a user or user organization.
          nullable: true
      example:
        firstName: Mark
        lastName: Brown
        title: Mr
        status: Enabled
        email: mark.brown@delta.com
        address: 90 West Broad St Columbus OH 43215
        phone: (524) 745-5371
    UserInput:
      required:
        - organizationUid
        - role
        - profile
        - credentials
      type: object
      properties:
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
        role:
          enum:
            - Unknown
            - PortalAdministrator
            - PortalOperator
            - PortalReadonlyOperator
            - SiteAdministrator
            - CompanyLocationAdministrator
            - CompanyLocationUser
            - CompanyOwner
            - CompanyAdministrator
            - CompanyInvoiceAuditor
            - CompanySubtenant
            - ResellerOwner
            - ResellerOperator
            - ResellerUser
            - ResellerInvoiceAuditor
            - ResellerAdministrator
            - CompanyTenant
          type: string
          description: User role in Veeam Service Provider Console.
          x-extensible-enum: true
          x-ms-enum:
            name: UserRole
        mfaPolicyStatus:
          enum:
            - Unknown
            - Disabled
            - Enabled
          type: string
          description: Status of MFA configuration requirement for user.
          default: Disabled
          x-extensible-enum: true
          x-ms-enum:
            name: UserMfaPolicyStatusInput
        profile:
          type: object
          allOf:
            - $ref: '#/components/schemas/UserProfile'
          description: User profile.
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/Credentials'
          description: User credentials.
        backupResource:
          type: object
          allOf:
            - $ref: '#/components/schemas/UserBackupResourceInput'
          description: Backup resource configured for a subtenant account.
          nullable: true
    UserBackupResource:
      required:
        - siteUid
        - tenantBackupResourceUid
        - resourceFriendlyName
      type: object
      properties:
        userUid:
          type: string
          description: UID assigned to a subtenant user in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        description:
          type: string
          description: Subtenant user description.
          nullable: true
        subtenantUid:
          type: string
          description: UID assigned to a subtenant user in Veeam Cloud Connect.
          format: uuid
          readOnly: true
        vcdUserId:
          type: string
          description: UID assigned to a VMware Cloud Director organization user account.
          nullable: true
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
        tenantBackupResourceUid:
          type: string
          description: UID assigned to a tenant backup resource.
          format: uuid
        resourceFriendlyName:
          type: string
          description: Friendly name of a subtenant backup resource.
        storageQuota:
          maximum: 1124774006935781400
          minimum: 1073741824
          type: integer
          description: 'Subtenant quota, in bytes.'
          format: int64
          nullable: true
        storageQuotaUsage:
          type: integer
          description: 'Amount of storage space used by a subtenant, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        isStorageQuotaUnlimited:
          type: boolean
          description: Indicates whether a subtenant has unlimited quota.
          default: true
    UserBackupResourceInput:
      required:
        - tenantBackupResourceUid
        - resourceFriendlyName
      type: object
      properties:
        siteUid:
          type: string
          description: "UID assigned to a Veeam Cloud Connect site. \n> You can provide the `null` value only if a single tenant is assigned to a company. Otherwise, the server will return an error.'\n"
          format: uuid
          nullable: true
        tenantBackupResourceUid:
          type: string
          description: UID assigned to a tenant backup resource.
          format: uuid
        description:
          type: string
          description: Subtenant user description.
          nullable: true
        vcdUserId:
          type: string
          description: UID assigned to a VMware Cloud Director organization user account.
          nullable: true
        resourceFriendlyName:
          type: string
          description: Friendly name of a subtenant backup resource.
        storageQuota:
          maximum: 1124774006935781400
          minimum: 1073741824
          type: integer
          description: 'Subtenant quota, in bytes.'
          format: int64
          nullable: true
        isStorageQuotaUnlimited:
          type: boolean
          description: Defines whether a subtenant has unlimited quota.
          default: true
    SingleLicenseReport:
      type: object
      properties:
        reportStatus:
          enum:
            - Unknown
            - ApprovalRequired
            - Finalization
            - Approved
          type: string
          description: License usage report status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ReportStatus
        reportParameters:
          type: object
          allOf:
            - $ref: '#/components/schemas/LicenseReportParameters'
          description: Report parameters
          readOnly: true
        reportSummary:
          type: object
          allOf:
            - $ref: '#/components/schemas/LicenseReportSummary'
          description: Report summary information.
          readOnly: true
        organizationsUsage:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationLicenseUsage'
          description: Number of license points used by managed organizations.
          readOnly: true
        notCollectedCloudServers:
          type: array
          items:
            type: string
          description: Array of Veeam Cloud Connect servers from which Veeam Service Provider Console could not collect the license usage data.
          readOnly: true
        clonedCloudServers:
          type: array
          items:
            type: string
          description: Array of cloned Veeam Cloud Connect servers.
          readOnly: true
        unsupportedCloudServers:
          type: array
          items:
            type: string
          description: Array of unsupported Veeam Cloud Connect servers.
          readOnly: true
        usageDetails:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationUsageOfLicensesWithSameSupportId'
          description: Usage of licenses with the same support ID.
          readOnly: true
        appendices:
          type: array
          items:
            $ref: '#/components/schemas/LicenseReportAppendix'
          description: Usage of licenses issued to organizations other than report owner.
          readOnly: true
    LicenseReportAppendix:
      type: object
      properties:
        licenseCompanyName:
          type: string
          description: Licensee company name.
          readOnly: true
        appendixSummary:
          type: object
          allOf:
            - $ref: '#/components/schemas/LicenseReportSummary'
          description: Appendix summary information.
          readOnly: true
        organizationsUsage:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationLicenseUsage'
          description: Number of license points used by managed organizations.
          readOnly: true
        notCollectedCloudServers:
          type: array
          items:
            type: string
          description: Array of Veeam Cloud Connect servers from which Veeam Service Provider Console could not collect the license usage data.
          readOnly: true
        clonedCloudServers:
          type: array
          items:
            type: string
          description: Array of cloned Veeam Cloud Connect servers.
          readOnly: true
        unsupportedCloudServers:
          type: array
          items:
            type: string
          description: Array of unsupported Veeam Cloud Connect servers.
          readOnly: true
        usageDetails:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationUsageOfLicensesWithSameSupportId'
          description: Detailed information about license usage.
          readOnly: true
    OrganizationUsageOfLicensesWithSameSupportId:
      type: object
      properties:
        organizationName:
          type: string
          description: Organization name.
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        supportId:
          type: string
          description: License support ID.
          nullable: true
          readOnly: true
        notCollectedClientServers:
          type: array
          items:
            type: string
          description: Array of client servers from which Veeam Service Provider Console could not collect the license usage data.
          readOnly: true
        clonedClientServers:
          type: array
          items:
            type: string
          description: Array of cloned client servers.
          readOnly: true
        unsupportedClientServers:
          type: array
          items:
            type: string
          description: Array of unsupported client servers.
          readOnly: true
        usageByLicenseAndProduct:
          type: array
          items:
            $ref: '#/components/schemas/ProductLicenseUsage'
          description: License usage for each license and product.
          readOnly: true
    ProductLicenseUsage:
      type: object
      properties:
        licenseId:
          type: string
          description: License ID.
          nullable: true
          readOnly: true
        productType:
          enum:
            - Unknown
            - EnterpriseManager
            - BackupAndReplication
            - CloudConnect
            - VSPC
            - VONE
            - VB365
            - VDP
          type: string
          description: Product type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ReportProductType
        licenseEdition:
          type: string
          description: License edition.
          nullable: true
          readOnly: true
        usedPoints:
          type: number
          description: Number of license points used by an organization.
          format: double
          readOnly: true
        workloadUsage:
          type: array
          items:
            $ref: '#/components/schemas/WorkloadLicenseUsage'
          description: License usage for each workload type.
          readOnly: true
    OrganizationLicenseUsage:
      type: object
      properties:
        organizationType:
          enum:
            - Unknown
            - Company
            - Reseller
            - Provider
          type: string
          description: Organization type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: OrganizationLicenseUsageType
        organizationName:
          type: string
          description: Organization name.
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        usedPoints:
          type: number
          description: Number of license points used by an organization.
          format: double
          readOnly: true
    LicenseReportSummary:
      required:
        - totalPoints
        - productsUsage
      type: object
      properties:
        totalPoints:
          type: number
          description: Number of report owner license points used by managed organizations.
          format: double
        productsUsage:
          type: array
          items:
            $ref: '#/components/schemas/TotalProductLicenseUsage'
          description: License usage for each product.
    TotalProductLicenseUsage:
      type: object
      properties:
        productType:
          enum:
            - Unknown
            - EnterpriseManager
            - BackupAndReplication
            - CloudConnect
            - VSPC
            - VONE
            - VB365
            - VDP
          type: string
          description: Product type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ReportProductType
        totalPoints:
          type: number
          description: Number of used license points.
          format: double
          readOnly: true
        licenseEdition:
          type: string
          description: License edition.
          readOnly: true
        workloadUsage:
          type: array
          items:
            $ref: '#/components/schemas/WorkloadLicenseUsage'
          description: License usage for each workload type.
          readOnly: true
    WorkloadLicenseUsage:
      type: object
      properties:
        workloadType:
          enum:
            - Unknown
            - VBR_VM
            - VBR_Cloud_VM
            - VAC_Workstation_Agent
            - VAC_Server_Agent
            - VBR_Workstation_Agent
            - VBR_Server_Agent
            - VBR_Application_Plugins
            - VBR_NAS_Backup
            - CC_VM_Backup
            - CC_Workstation_Backup
            - CC_Server_Backup
            - CC_VM_Replica
            - VONE_VM
            - VONE_Cloud_VM
            - VONE_Workstation_Agent
            - VONE_Server_Agent
            - VONE_Nas_Backup
            - VB365_User
            - VBR_NAS_Server
            - VBR_Cloud_Database
            - VBR_Cloud_File_Share
            - VBR_Tape_Backup
            - VBR_Tape_Server
            - VONE_Cloud_Database
            - VONE_Cloud_File_Share
            - VONE_Tape_Backup
            - VONE_User
            - Dynamic
          type: string
          description: Workload type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: WorkloadType
        description:
          type: string
          description: Workload description.
          readOnly: true
        initialCount:
          type: integer
          description: Number of managed agents.
          format: int32
          readOnly: true
        reportedCount:
          type: integer
          description: Number of managed agents after report finalization.
          format: int32
          readOnly: true
        newCount:
          type: integer
          description: Number of managed agents that were activated within the current calendar month.
          format: int32
          readOnly: true
        weight:
          type: number
          description: Number of points a single workload uses.
          format: double
          readOnly: true
        usedPoints:
          type: number
          description: Number of points used by all managed agents of the same type.
          format: double
          readOnly: true
        workloadsByPlatform:
          type: array
          items:
            $ref: '#/components/schemas/WorkloadLicenseUsageByPlatform'
          description: License usage by workloads for each platform.
          readOnly: true
    WorkloadLicenseUsageByPlatform:
      type: object
      properties:
        typeId:
          type: string
          description: ID of a workload type and platform.
          readOnly: true
        description:
          type: string
          description: Description of a workload type and platform.
          readOnly: true
        objectsByWeight:
          type: array
          items:
            $ref: '#/components/schemas/WorkloadLicenseUsageByWeight'
          description: License usage by workloads for each number of consumed units.
          readOnly: true
    WorkloadLicenseUsageByWeight:
      type: object
      properties:
        weight:
          type: number
          description: Number of license units consumed by a single workload.
          format: double
          readOnly: true
        initialCount:
          type: integer
          description: Number of managed Veeam backup agents.
          format: int32
          readOnly: true
        reportedCount:
          type: integer
          description: Number of managed Veeam backup agents in a finalized report.
          format: int32
          readOnly: true
        newCount:
          type: integer
          description: Number of managed Veeam backup agents that were activated within the current calendar month.
          format: int32
          readOnly: true
        usedPoints:
          type: number
          description: Number of license units consumed by all workloads.
          format: double
          readOnly: true
    LicenseReportParameters:
      required:
        - reportId
        - organizationName
        - organizationUid
        - licenseCompanyName
        - generationDate
        - reportInterval
      type: object
      properties:
        reportId:
          type: integer
          description: Report ID.
          format: int32
        organizationName:
          type: string
          description: Name of a report owner organization.
        organizationUid:
          type: string
          description: UID assigned to a report owner organization.
          format: uuid
        licenseCompanyName:
          type: string
          description: Name of a licensee organization.
        generationDate:
          type: string
          description: Date of report generation.
          format: date
        reportInterval:
          type: object
          allOf:
            - $ref: '#/components/schemas/LicenseReportInterval'
          description: Reporting interval.
    LicenseReportInterval:
      required:
        - startOfInterval
        - endOfInterval
      type: object
      properties:
        startOfInterval:
          type: string
          description: Start date of reporting interval.
          format: date
        endOfInterval:
          type: string
          description: End date of reporting interval.
          format: date
    SingleLicenseReportSettings:
      required:
        - autoApprove
        - sendReports
      type: object
      properties:
        autoApprove:
          type: boolean
          description: Indicates whether reports are approved automatically.
    LicenseReportFinalizationStatus:
      required:
        - reportApprovalStatus
        - message
      type: object
      properties:
        reportApprovalStatus:
          enum:
            - Unknown
            - NotApproved
            - Approved
            - Finalized
            - Finalization
            - NotApprovable
          type: string
          description: Report finalization status.
          x-extensible-enum: true
          x-ms-enum:
            name: LicenseUsageReportApprovalStatus
        message:
          type: string
          description: Message.
    VOneServerLicense:
      required:
        - autoUpdateEnabled
      type: object
      properties:
        vOneServerUid:
          type: string
          description: UID assigned to a Veeam ONE server.
          format: uuid
          readOnly: true
        autoUpdateEnabled:
          type: boolean
          description: Indicates whether license updates automatically.
        company:
          type: string
          description: Name of an organization to which a license is issued.
          readOnly: true
        email:
          type: string
          description: Email address of an organization to which a license is issued.
          readOnly: true
        expirationDate:
          type: string
          description: License expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        supportExpirationDate:
          type: string
          description: Support expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        licenseId:
          type: string
          description: License ID.
          format: uuid
          nullable: true
          readOnly: true
        supportId:
          type: string
          description: License ID required to contact Veeam Support.
          readOnly: true
        status:
          enum:
            - Unknown
            - Valid
            - Warning
            - Error
            - Expired
            - Unlicensed
          type: string
          description: Current status of the license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseStatus
        statusMessage:
          type: string
          description: Status message.
          readOnly: true
        units:
          type: number
          description: Number of available license units.
          format: double
          nullable: true
          readOnly: true
        usedUnits:
          type: number
          description: Number of used license units.
          format: double
          nullable: true
          readOnly: true
        unitType:
          enum:
            - Unknown
            - Instances
            - Points
          type: string
          description: Type of license units.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseUnitsType
        type:
          enum:
            - Unknown
            - NotInstalled
            - Community
            - Rental
            - Subscription
            - Evaluation
            - NFR
            - Perpetual
          type: string
          description: Type of the license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseType
    Vb365ServerLicense:
      required:
        - autoUpdateEnabled
      type: object
      properties:
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          readOnly: true
        autoUpdateEnabled:
          type: boolean
          description: Indicates whether license updates automatically.
        company:
          type: string
          description: Name of an organization to which a license is issued.
          readOnly: true
        email:
          type: string
          description: Email address of an organization to which a license is issued.
          readOnly: true
        expirationDate:
          type: string
          description: License expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        supportExpirationDate:
          type: string
          description: Support expiration date and time.
          format: date-time
          nullable: true
          readOnly: true
        licenseId:
          type: string
          description: License ID.
          format: uuid
          nullable: true
          readOnly: true
        supportId:
          type: string
          description: License ID required to contact Veeam Support.
          readOnly: true
        status:
          enum:
            - Unknown
            - Valid
            - Warning
            - Error
            - Expired
            - Unlicensed
          type: string
          description: Current status of the license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseStatus
        licensedUsers:
          type: integer
          description: Number of licensed users.
          format: int32
          readOnly: true
        protectedUsers:
          type: integer
          description: Number of protected users.
          format: int32
          readOnly: true
        type:
          enum:
            - Unknown
            - NotInstalled
            - Community
            - Rental
            - Subscription
            - Evaluation
            - NFR
            - Perpetual
          type: string
          description: Type of the license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseType
    OrganizationCurrentLicenseUsage:
      type: object
      properties:
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        organizationType:
          enum:
            - Unknown
            - Company
            - Provider
            - Reseller
          type: string
          description: Type of an organization.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: LicenseUsageOrganizationType
        providerUid:
          type: string
          description: UID assigned to a provider organization.
          format: uuid
          nullable: true
          readOnly: true
        servers:
          type: array
          items:
            $ref: '#/components/schemas/ServerCurrentLicenseUsage'
          description: License usage by workloads for each server managing these workloads.
          readOnly: true
    ServerCurrentLicenseUsage:
      type: object
      properties:
        serverUid:
          type: string
          description: Server UID.
          format: uuid
          readOnly: true
        serverType:
          enum:
            - Unknown
            - BackupAndReplication
            - CloudConnect
            - VSPC
            - VONE
            - VB365
          type: string
          description: Veeam product installed on the server.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: LicenseUsageProductType
        workloads:
          type: array
          items:
            $ref: '#/components/schemas/CurrentLicenseUsageWorkload'
          description: License usage by each workload type.
          readOnly: true
    CurrentLicenseUsageWorkload:
      required:
        - id
        - description
        - unitType
        - rentalUnits
        - newUnits
        - usedUnits
        - rentalCount
        - newCount
        - usedCount
        - workloadsByPlatform
      type: object
      properties:
        id:
          type: string
          description: ID assigned to a workload.
          format: uuid
        description:
          type: string
          description: Workload description.
          readOnly: true
        unitType:
          enum:
            - Unknown
            - Instances
            - Points
          type: string
          description: License unit type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VeeamLicenseUnitsType
        rentalUnits:
          type: number
          description: Number of units with rental licenses installed.
          format: double
        newUnits:
          type: number
          description: Number of units that were activated within the current calendar month.
          format: double
        usedUnits:
          type: number
          description: Number of units that have licenses assigned and are fully managed by Veeam Service Provider Console.
          format: double
        rentalCount:
          type: integer
          description: Number of objects with rental licenses installed.
          format: int32
        newCount:
          type: integer
          description: Number of objects that were activated within the current calendar month.
          format: int32
        usedCount:
          type: integer
          description: Number of objects that have licenses assigned and are fully managed by Veeam Service Provider Console.
          format: int32
        workloadsByPlatform:
          type: array
          items:
            $ref: '#/components/schemas/CurrentLicenseUsageWorkloadByPlatform'
          description: License usage by workloads for each platform.
    CurrentLicenseUsageWorkloadByPlatform:
      required:
        - typeId
        - description
        - weight
        - rentalUnits
        - newUnits
        - usedUnits
        - rentalCount
        - newCount
        - usedCount
      type: object
      properties:
        typeId:
          type: string
          description: ID assigned to a workload type.
          readOnly: true
        description:
          type: string
          description: Workload description.
          readOnly: true
        weight:
          type: number
          description: Number of license units consumed by a single workload.
          format: double
        rentalUnits:
          type: number
          description: Number of units with rental licenses installed.
          format: double
        newUnits:
          type: number
          description: Number of units that were activated within the current calendar month.
          format: double
        usedUnits:
          type: number
          description: Number of units that have licenses assigned and are fully managed by Veeam Service Provider Console.
          format: double
        rentalCount:
          type: integer
          description: Number of objects with rental licenses installed.
          format: int32
        newCount:
          type: integer
          description: Number of objects that were activated within the current calendar month.
          format: int32
        usedCount:
          type: integer
          description: Number of objects that have licenses assigned and are fully managed by Veeam Service Provider Console.
          format: int32
    ResponseError:
      required:
        - type
        - code
        - message
      type: object
      properties:
        message:
          type: string
          description: "Error message.\n> Every line break is represented by the `\\r\\n` control characters.\n"
        type:
          enum:
            - unspecified
            - transport
            - logical
            - retryableLogical
            - security
          type: string
          description: Error type.
          x-extensible-enum: true
          x-ms-enum:
            name: ErrorType
        code:
          type: integer
          description: Error code.
          format: int32
      readOnly: true
      x-veeam-expandable: true
    ResponseMetadata:
      type: object
      properties:
        pagingInfo:
          type: object
          allOf:
            - $ref: '#/components/schemas/PagingInformation'
          description: Paging information.
          nullable: true
      nullable: true
      readOnly: true
    PagingInformation:
      required:
        - total
        - count
        - offset
      type: object
      properties:
        total:
          type: integer
          description: Number of total resources.
          format: int32
        count:
          type: integer
          description: Number of resources on the current page.
          format: int32
        offset:
          type: integer
          description: Number of resources that are skipped.
          format: int32
      description: Pagination data.
    EmptyResponse:
      required:
        - errors
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ResponseError'
          readOnly: true
        data:
          type: object
          readOnly: true
        meta:
          type: object
          allOf:
            - $ref: '#/components/schemas/ResponseMetadata'
          readOnly: true
    ErrorResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/ResponseError'
          readOnly: true
      example:
        errors:
          - message: The property at path 'mfaPolicyConfigurationStatus' could not be updated.
            type: logical
            code: 1001
            failedJsonPatch:
              value: NotConfigured
              path: mfaPolicyConfigurationStatus
              op: replace
    DeploymentConfiguration:
      type: object
      properties:
        backupPolicyUid:
          type: string
          description: UID of a backup policy that must be assigned to Veeam backup agent.
          format: uuid
          nullable: true
        allowAutoRebootIfNeeded:
          type: boolean
          description: Indicates whether system reboot is allowed.
          default: false
        setReadOnlyAccess:
          type: boolean
          description: Indicates whether the read-only access mode is enabled for Veeam backup agents.
          default: true
        installCbtDriver:
          type: boolean
          description: Indicates whether CBT driver is installed during agent deployment.
          default: false
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/DomainCredentials'
          description: Credentials required to access discovered computers.
          nullable: true
        backupAgentSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupAgentSettings'
          description: Veeam backup agent global settings.
          nullable: true
    LinuxDeploymentConfiguration:
      type: object
      properties:
        backupPolicyUid:
          type: string
          description: UID of a backup policy that is assigned to Veeam Agent for Linux.
          format: uuid
          nullable: true
        setReadOnlyAccess:
          type: boolean
          description: Indicates whether the read-only access mode is enabled for Veeam Agent for Linux.
          default: true
        credentials:
          type: array
          items:
            $ref: '#/components/schemas/LinuxDiscoveryCredentials'
          description: Credentials required to access discovered computers.
          nullable: true
    LinuxDiscoveryCredentials:
      required:
        - username
        - type
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a credentials record.
          format: uuid
          readOnly: true
        username:
          maxLength: 256
          minLength: 1
          type: string
          description: User name.
        password:
          maxLength: 128
          minLength: 1
          type: string
          description: Password.
          format: password
          nullable: true
        priority:
          minimum: 0
          type: integer
          description: Priority level of credentials.
          format: int32
          default: 0
        description:
          maxLength: 128
          minLength: 0
          type: string
          description: Credentials description.
          nullable: true
        sshPort:
          type: integer
          description: SSH port that must be used to connect to a Linux server.
          format: int32
          default: 22
        elevateAccountPrivileges:
          type: boolean
          description: Indicates whether a non-root account must be provided with root account privileges.
          default: false
        addAccountToSudoersFile:
          type: boolean
          description: Indicates whether an account must be added to sudoers file.
          default: false
        useSuIfsudoFails:
          type: boolean
          description: Indicates whether the `su` command can be used instead of the `sudo` command.
          default: false
        rootPassword:
          maxLength: 4096
          type: string
          description: Password for a root account.
          format: password
          nullable: true
        sshPrivateKey:
          type: string
          description: SSH private key.
          format: password
          nullable: true
        passphrase:
          type: string
          description: Passphrase for the private key.
          format: password
          nullable: true
        type:
          enum:
            - Unknown
            - LinuxBased
            - LinuxCertificate
          type: string
          description: Type of Linux credentials.
          x-extensible-enum: true
          x-ms-enum:
            name: LinuxDiscoveryCredentialsType
    LinuxDiscoveryCredentialsInput:
      required:
        - username
        - type
      type: object
      properties:
        username:
          maxLength: 256
          minLength: 1
          type: string
          description: User name.
        password:
          maxLength: 128
          minLength: 1
          type: string
          description: Password.
          format: password
          nullable: true
        priority:
          minimum: 0
          type: integer
          description: Priority level of credentials.
          format: int32
          default: 0
        description:
          maxLength: 128
          minLength: 0
          type: string
          description: Credentials description.
          nullable: true
        sshPort:
          type: integer
          description: SSH port that must be used to connect to a Linux server.
          format: int32
          default: 22
        elevateAccountPrivileges:
          type: boolean
          description: Indicates whether a non-root account must be provided with root account privileges.
          default: false
        addAccountToSudoersFile:
          type: boolean
          description: Indicates whether an account must be added to sudoers file.
          default: false
        useSuIfsudoFails:
          type: boolean
          description: Indicates whether the `su` command can be used instead of the `sudo` command.
          default: false
        rootPassword:
          maxLength: 4096
          type: string
          description: Password for a root account.
          format: password
          nullable: true
        sshPrivateKey:
          type: string
          description: SSH private key.
          format: password
          nullable: true
        passphrase:
          type: string
          description: Passphrase for the private key.
          format: password
          nullable: true
        type:
          enum:
            - Unknown
            - LinuxBased
            - LinuxCertificate
          type: string
          description: Type of Linux credentials.
          x-extensible-enum: true
          x-ms-enum:
            name: LinuxDiscoveryCredentialsType
    VbrScheduledDeploymentConfiguration:
      required:
        - configuration
        - schedule
      type: object
      properties:
        configuration:
          type: object
          allOf:
            - $ref: '#/components/schemas/VbrDeploymentConfiguration'
          description: Deployment configuration.
        schedule:
          type: object
          allOf:
            - $ref: '#/components/schemas/DeploySchedule'
          description: Deployment scheduling settings.
    VbrScheduledDeploymentConfigurationWithCredentials:
      required:
        - configuration
        - schedule
      type: object
      properties:
        configuration:
          type: object
          allOf:
            - $ref: '#/components/schemas/VbrDeploymentConfigurationWithCredentials'
          description: Deployment configuration.
        schedule:
          type: object
          allOf:
            - $ref: '#/components/schemas/DeploySchedule'
          description: Deployment scheduling settings.
    VbrDeploymentConfigurationWithCredentials:
      required:
        - configuration
        - licenseSettings
      type: object
      properties:
        configuration:
          type: object
          allOf:
            - $ref: '#/components/schemas/VbrDeploymentConfiguration'
          description: Deployment configuration.
        licenseSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/VbrDeploymentLicenseSettings'
          description: License settings.
        credentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/VbrDeploymentCredentials'
          description: Credentials required to access the target server. Credentials are optional if the service provider management agent is installed on the server.
          nullable: true
    VbrDeploymentCredentials:
      required:
        - tenantName
        - tenantPassword
      type: object
      properties:
        tenantName:
          minLength: 1
          type: string
          description: User name of a tenant account.
        tenantPassword:
          minLength: 1
          type: string
          description: Password of a tenant account.
          format: password
    VbrDeploymentConfiguration:
      required:
        - answerXml
      type: object
      properties:
        distribution:
          type: object
          allOf:
            - $ref: '#/components/schemas/VbrDeploymentDistributionSource'
          description: Path to the Veeam Backup & Replication setup file.
          nullable: true
        usePredownloadedIso:
          type: boolean
          description: "Indicates whether the predownloaded Veeam Backup & Replication setup file is used for installation.\n> Provided value has higher priority than the `distribution` property value.\n"
          nullable: true
        answerXml:
          type: string
          description: "XML string containing installation parameters.\n> To obtain a template of XML string, perform the `GetBackupServerDeploymentConfigurationXml` operation.\n"
        allowAutoReboot:
          type: boolean
          description: Indicates whether a server must be automatically rebooted after the installation is complete.
          nullable: true
        stopAllActivities:
          type: boolean
          description: Indicates whether all other tasks must be stopped during installation. Can be enabled only for update installation.
          nullable: true
        useManagementAgentCredentials:
          type: boolean
          description: "Indicates whether management agent credentials must be used as service account credentials.\n> Provided value has higher priority than the `adminCredentials` property value.\n"
          nullable: true
        adminCredentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/ManagementAgentCredentials'
          description: Service account credentials.
          nullable: true
      description: 'If the `distribution` and `usePredownloadedIso` properties have the `null` value, the most recent version of Veeam Backup & Replication will be downloaded automatically.'
    VbrIsoPredownloadInput:
      required:
        - path
      type: object
      properties:
        path:
          maxLength: 1024
          minLength: 1
          type: string
          description: Path to a folder on a target machine where the Veeam Backup & Replication setup file must be downloaded.
      description: Setup file predownload configuration.
    VbrDeploymentLicenseSettings:
      required:
        - licenseSource
      type: object
      properties:
        licenseFileContent:
          type: string
          description: License file content in the Base64 format.
          format: base64
          nullable: true
        licenseUid:
          type: string
          description: UID assigned to a license.
          format: uuid
          nullable: true
        licenseSource:
          enum:
            - Unknown
            - LicenseFileContent
            - LicenseUid
            - AnswerXml
          type: string
          description: Source of a license file.
          x-extensible-enum: true
          x-ms-enum:
            name: VbrDeployLicenseSource
    VbrScheduledPatchConfiguration:
      required:
        - configuration
        - schedule
      type: object
      properties:
        configuration:
          type: object
          allOf:
            - $ref: '#/components/schemas/VbrPatchConfiguration'
          description: Patch deployment configuration.
        schedule:
          type: object
          allOf:
            - $ref: '#/components/schemas/DeploySchedule'
          description: Patch deployment schedule settings.
    VbrPatchConfiguration:
      type: object
      properties:
        allowAutoReboot:
          type: boolean
          description: Indicates whether a server must be automatically rebooted after the installation is complete.
          nullable: true
        stopAllActivities:
          type: boolean
          description: Indicates whether all other tasks must be stopped during installation.
          nullable: true
    BackupServerMultipartPatchInfo:
      type: object
      properties:
        uploadUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server patch upload.
          format: uuid
          readOnly: true
        files:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerMultipartPatchFile'
          description: Array of files included in a Veeam Backup & Replication server patch upload.
          readOnly: true
    BackupServerMultipartPatchFile:
      type: object
      properties:
        name:
          type: string
          description: Name of a file included in a Veeam Backup & Replication server patch upload.
          readOnly: true
        fileStreamUid:
          type: string
          description: UID assigned a file included in a Veeam Backup & Replication server patch upload.
          format: uuid
          readOnly: true
    CreateBackupServerMultipartPatchInput:
      required:
        - files
        - action
        - stopAllActivities
        - rebootAutomatically
      type: object
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerMultipartPatchFileInput'
          description: Array of files included in a Veeam Backup & Replication server patch upload.
        action:
          $ref: '#/components/schemas/BackupServerMultipartPatchAction'
        stopAllActivities:
          type: boolean
          description: Indicates whether all Veeam Backup & Replication activities must be stopped before patch installation begins.
        rebootAutomatically:
          type: boolean
          description: Indicates whether a Veeam Backup & Replication server must be rebooted after the patch installation is finished.
    BackupServerMultipartPatchFileInput:
      required:
        - name
        - fileSize
      type: object
      properties:
        name:
          type: string
          description: Name of a file.
        fileSize:
          maximum: 5368709120
          minimum: 1
          type: integer
          description: 'File size, in bytes.'
          format: int64
        targetDirectory:
          type: string
          description: Path to a target directory under %VBR_ROOT%.
          nullable: true
    BackupServerMultipartPatchAction:
      enum:
        - ExecuteFile
        - ReplaceFilesAndRestart
      type: string
      description: Action that must be performed on a Veeam Backup & Replication server patch.
    VbrDeploymentDistributionSource:
      required:
        - filePath
        - userName
        - password
      type: object
      properties:
        filePath:
          type: string
          description: Path to the Veeam Backup & Replication installation file.
        userName:
          type: string
          description: User name required to access the file.
        password:
          type: string
          description: Password required to access the file.
    DeploymentInformation:
      type: object
      properties:
        deployTaskUid:
          type: string
          description: UID assigned to a deployment task.
          format: uuid
          readOnly: true
        deployTaskId:
          type: integer
          description: ID assigned to a deployment task.
          format: int32
          nullable: true
          readOnly: true
    HostedAgentLinuxSaveParams:
      required:
        - connectionCredential
        - description
      type: object
      properties:
        managementAgentUid:
          type: string
          description: UID assigned to a hosted management agent.
          format: uuid
          nullable: true
          readOnly: true
        description:
          type: string
          description: '[Internal].'
          nullable: true
          readOnly: true
    DeploymentTask:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a deployment task.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a master agent or a management agent installed on a target server.
          format: uuid
          readOnly: true
        type:
          enum:
            - Unknown
            - Deploy
            - Discovery
            - Execute
            - UpgradeVac
            - UpdateWinAgent
            - PatchWinAgent
            - UpdateNixAgent
            - PatchNixAgent
            - PatchVbr
            - HostedAgentDeploy
            - Other
            - DeployVbr
            - UpgradeVbr
            - VbDeploy
            - VbUpgrade
            - VbRegister
            - VbUserAccountUpdate
            - VbServiceAccountUpdate
            - VbSqlAccountRemove
            - PatchPublicCloud
            - VbrIsoPredownload
            - VOneIsoPredownload
            - DeployVOne
            - UpgradeVOne
            - PatchVOne
            - VOnePatchIsoPredownload
          type: string
          description: Type of a deployment task.
          readOnly: true
          x-ms-enum:
            name: DeploymentTaskType
          x-extensible-enum: true
        status:
          enum:
            - Unknown
            - Created
            - Running
            - Success
            - Canceled
            - Failed
            - CancellationRequested
            - CancellationRequestFailed
          type: string
          description: Status of a deployment task.
          readOnly: true
          x-ms-enum:
            name: DeploymentTaskStatus
          x-extensible-enum: true
        startDate:
          type: string
          description: Date and time when a task started.
          format: date-time
          nullable: true
          readOnly: true
        endDate:
          type: string
          description: Date and time when a task ended.
          format: date-time
          nullable: true
          readOnly: true
        errorMessage:
          type: string
          description: Error message for failed deployment task.
          nullable: true
          readOnly: true
    DeploymentTaskResponse:
      type: object
      properties:
        deploymentTaskUid:
          type: string
          description: UID assigned to a deployment task.
          format: uuid
          nullable: true
    DeploymentLog:
      type: object
      properties:
        completePercentage:
          type: integer
          description: Percentage of deployment progress.
          format: int32
          readOnly: true
        status:
          enum:
            - success
            - failed
            - warning
          type: string
          description: Deployment status.
          readOnly: true
          x-ms-enum:
            name: DeployStatus
        logEntries:
          type: array
          items:
            $ref: '#/components/schemas/DeploymentLogEntry'
          description: Log entry containing details about deployment process.
          readOnly: true
    DeploymentLogEntry:
      type: object
      properties:
        taskUid:
          type: string
          description: UID assigned to a deployment task.
          format: uuid
          readOnly: true
        event:
          type: integer
          description: Event represented by the log entry.
          format: int32
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a deployed management agent.
          format: uuid
          readOnly: true
        biosUuid:
          type: string
          description: UUID in Win32_ComputerSystem WMI class.
          format: uuid
          readOnly: true
        hostName:
          type: string
          description: Hostname of a target computer.
          readOnly: true
        taskName:
          type: string
          description: Name of a deployment task.
          readOnly: true
        message:
          type: string
          description: Message.
          nullable: true
          readOnly: true
        time:
          type: string
          description: Date and time of an event.
          format: date-time
          nullable: true
    DomainCredentials:
      required:
        - userName
        - password
      type: object
      properties:
        userName:
          maxLength: 128
          minLength: 1
          type: string
          description: Domain credentials user name.
        password:
          maxLength: 128
          minLength: 1
          type: string
          description: Domain credentials password.
          format: password
          nullable: true
    DiscoveryRuleCredentials:
      required:
        - userName
      type: object
      properties:
        userName:
          maxLength: 128
          minLength: 0
          pattern: '^[^\/\[\]\:\;\|\=\,\+\*\?\<\>\@]+\\[^\/\[\]\:\;\|\=\,\+\*\?\<\>\@]+$'
          type: string
          description: User name.
        password:
          maxLength: 128
          minLength: 0
          type: string
          description: Password.
          format: password
          nullable: true
    CredentialsInfo:
      type: object
      properties:
        userName:
          type: string
          description: User name.
          readOnly: true
        password:
          maxLength: 128
          minLength: 1
          type: string
          description: Password.
          format: password
          nullable: true
    Credentials:
      required:
        - userName
        - password
      type: object
      properties:
        userName:
          maxLength: 256
          minLength: 1
          pattern: '^[^\/\\\[\]:;|=,+\*\?<>@"!#$%^&(){}]+(?<!\.)$'
          type: string
          description: User name.
        password:
          maxLength: 128
          minLength: 1
          type: string
          description: Password.
          format: password
          nullable: true
    OwnerCredentials:
      required:
        - userName
      type: object
      properties:
        userName:
          maxLength: 128
          minLength: 1
          pattern: '^[a-zA-Z0-9!#$%&()\-.^_{}~''` ]+(?<!\.)$'
          type: string
          description: User name.
        password:
          maxLength: 128
          minLength: 1
          type: string
          description: Password.
          format: password
          nullable: true
    Country:
      type: object
      properties:
        id:
          type: integer
          description: System ID assigned to a country.
          format: int32
          readOnly: true
        name:
          type: string
          description: Country name.
          readOnly: true
        code:
          type: string
          description: Two-letter code of a country.
          readOnly: true
    UsaState:
      type: object
      properties:
        id:
          type: integer
          description: System ID assigned to a USA state.
          format: int32
          readOnly: true
        name:
          type: string
          description: USA state name.
          readOnly: true
        code:
          type: string
          description: Postal code of a USA state.
          readOnly: true
    Currency:
      type: object
      properties:
        id:
          type: integer
          description: System ID assigned to a currency.
          format: int32
          readOnly: true
        name:
          type: string
          description: Currency name.
          readOnly: true
        code:
          type: string
          description: Three-letter code according to ISO 4217.
          readOnly: true
    BackupServerHost:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a server.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Host name of a server.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        type:
          enum:
            - Unknown
            - ESX
            - ESXi
            - VirtualCenter
            - LinuxHost
            - LocalHost
            - WindowsHost
            - Share
            - HyperVServer
            - HyperVCluster
            - Scvmm
            - BackupServer
            - SmbServer
            - SmbCluster
            - VcdSystem
            - ExternalInfrastructureServer
            - NasFiler
            - CifsShare
            - NfsShare
            - SanCifsServer
            - SanNfsServer
            - CifsServer
            - NfsServer
            - CifsServerShare
            - NfsServerShare
            - S3CompatibleServer
            - S3CompatibleBucket
            - AmazonS3Server
            - AmazonS3Bucket
            - AzureBlobServer
            - GoogleStorageServer
            - GoogleStorageBucket
          type: string
          description: Type of a server.
          readOnly: true
          x-ms-enum:
            name: BackupServerHostType
          x-extensible-enum: true
    BackupServerAgentProtectionGroup:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a server.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Host name of a server.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
    MalwareState:
      enum:
        - Unknown
        - Unverified
        - Clean
        - Infected
        - Suspicious
      type: string
      description: Malware status.
      readOnly: true
    ProtectedVirtualMachine:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a protected VM.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: VM hostname.
          readOnly: true
        hierarchyRef:
          type: string
          description: Reference ID of a VM.
          readOnly: true
        parentHostRef:
          type: string
          description: Reference ID assigned to a parent hypervisor.
          readOnly: true
        objectUid:
          type: string
          description: UID assigned to a VM as a job object.
          format: uuid
          nullable: true
          readOnly: true
        ipAddresses:
          type: array
          items:
            type: string
          description: IP addresses.
          readOnly: true
        provisionedSourceSize:
          type: integer
          description: 'Total size of protected VM disks, in bytes.'
          format: int64
          readOnly: true
        usedSourceSize:
          type: integer
          description: 'Used space on protected VM disks, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        totalRestorePointSize:
          type: integer
          description: 'Total size of all restore points, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        latestRestorePointSize:
          type: integer
          description: 'Size of the latest restore point, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a backup job that created the latest restore point.
          format: uuid
          nullable: true
          readOnly: true
        malwareState:
          $ref: '#/components/schemas/MalwareState'
        immutable:
          type: boolean
          description: Indicates whether a protected VM has any immutable restore points.
          readOnly: true
    ProtectedVirtualMachineBackup:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup chain.
          format: uuid
          readOnly: true
        virtualMachineUid:
          type: string
          description: UID assigned to a VM.
          format: uuid
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a backup job in Veeam Backup & Replication.
          format: uuid
          nullable: true
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        backupType:
          enum:
            - Unknown
            - Backup
            - Replication
            - BackupCopy
            - BackupToTape
          type: string
          description: Backup job type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ProtectedVirtualMachineBackupType
        repositoryUid:
          type: string
          description: UID assigned to a repository on which the restore point resides.
          format: uuid
          readOnly: true
        totalRestorePointSize:
          type: integer
          description: 'Total size of all restore points, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        latestRestorePointSize:
          type: integer
          description: 'Size of the latest restore point, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          nullable: true
          readOnly: true
        targetType:
          enum:
            - Unknown
            - Local
            - Cloud
          type: string
          description: Type of a target repository.
          readOnly: true
          x-ms-enum:
            name: RestorePointTargetType
          x-extensible-enum: true
        malwareState:
          $ref: '#/components/schemas/MalwareState'
        targetLocationTier:
          $ref: '#/components/schemas/SobrRepositoryTier'
        immutable:
          type: boolean
          description: Indicates whether a protected VM has any immutable restore points.
          readOnly: true
    SobrRepositoryTier:
      enum:
        - Unknown
        - None
        - Performance
        - Archive
        - Capacity
      type: string
      description: "Tier of a target repository in case it is an extent of a scale-out backup repository.\n> For individual repositories, the value is `None`.\n"
      readOnly: true
      x-ms-enum:
        name: SobrRepositoryTier
      x-extensible-enum: true
    ProtectedVirtualMachineBackupRestorePoint:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a restore point.
          format: uuid
          readOnly: true
        backupUid:
          type: string
          description: UID assigned to a backup chain.
          format: uuid
          readOnly: true
        virtualMachineUid:
          type: string
          description: UID assigned to a protected virtual machine.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        filePath:
          type: string
          description: Path to a backup file location.
          readOnly: true
        gfsType:
          type: array
          items:
            enum:
              - 'Weekly,'
              - 'Monthly,'
              - 'Quarterly,'
              - Yearly
            type: string
            x-ms-enum:
              name: RestorePointGfsType
            x-extensible-enum: true
          description: Array of enabled GFS retention types.
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a backup job.
          format: uuid
          nullable: true
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a repository on which the restore point resides.
          format: uuid
          readOnly: true
        size:
          type: integer
          description: 'Size of a restore point, in bytes. Includes all virtual machines protected by the same backup job.'
          format: int64
          nullable: true
          readOnly: true
        provisionedSourceSize:
          type: integer
          description: 'Total size of protected virtual machine disks, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        usedSourceSize:
          type: integer
          description: 'Used space on protected virtual machine disks, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        incrementRawDataSize:
          type: integer
          description: 'Size of backup increment, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        cpuCores:
          type: integer
          description: Number of vCPU cores of a cloud virtual machine.
          format: int32
          readOnly: true
        memory:
          type: integer
          description: 'Protected virtual machine memory, in bytes.'
          format: int64
          readOnly: true
        backupCreationTime:
          type: string
          description: Date and time when backup was created.
          format: date-time
          nullable: true
          readOnly: true
        fileCreationTime:
          type: string
          description: Date and time when a restore point was created.
          format: date-time
          nullable: true
          readOnly: true
        isConsistent:
          type: boolean
          description: Indicates whether a retore point has successfully passed a health check.
          nullable: true
          readOnly: true
        malwareState:
          $ref: '#/components/schemas/MalwareState'
        immutableTill:
          type: string
          description: Date and time when the latest immutable restore point was created.
          format: date-time
          nullable: true
          readOnly: true
    ProtectedVirtualMachineReplicaRestorePoint:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a restore point.
          format: uuid
          readOnly: true
        virtualMachineUid:
          type: string
          description: UID assigned to a virtual machine.
          format: uuid
          readOnly: true
        backupUid:
          type: string
          description: UID assigned to a replication chain.
          format: uuid
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a replication job.
          format: uuid
          nullable: true
          readOnly: true
        hardwarePlanUid:
          type: string
          description: UID assigned to a hardware plan.
          format: uuid
          nullable: true
          readOnly: true
        creationDate:
          type: string
          description: Date and time when a restore point was created.
          format: date-time
          nullable: true
          readOnly: true
    ProtectedCloudVirtualMachine:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a protected cloud VM.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: VM hostname.
          readOnly: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          nullable: true
          readOnly: true
        platformType:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatform'
        resourceId:
          type: string
          description: Resource ID of a cloud VM.
          readOnly: true
        destinations:
          type: array
          items:
            type: string
          description: Array of locations where backup files for a cloud VM reside.
          readOnly: true
        latestBackupDate:
          type: string
          description: Date and time of the latest backup restore point creation.
          format: date-time
          nullable: true
          readOnly: true
    ProtectedCloudVirtualMachineBackup:
      type: object
      properties:
        cloudVirtualMachineUid:
          type: string
          description: UID assigned to a cloud VM.
          format: uuid
          readOnly: true
        policyUid:
          type: string
          description: UID assigned to a backup policy.
          format: uuid
          nullable: true
          readOnly: true
        policyName:
          type: string
          description: Name of a backup policy.
          nullable: true
          readOnly: true
        backupType:
          enum:
            - Unknown
            - Backup
            - Snapshot
            - ReplicaSnapshot
            - BackupCopy
            - BackupToTape
            - PublicCloudArchive
          type: string
          description: Backup policy type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ProtectedCloudVirtualMachineBackupType
        destination:
          type: string
          description: Location where backup chain resides.
          readOnly: true
        size:
          type: integer
          description: "Total size of a backup chain, in bytes.\n> For the `Snapshot` and `ReplicaSnapshot` policy types, size of a cloud VM, in bytes.\n"
          format: int64
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Time and date of the latest restore point creation.
          format: date-time
          nullable: true
          readOnly: true
    ProtectedCloudDatabase:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a protected public cloud database.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a protected public cloud database.
          readOnly: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          nullable: true
          readOnly: true
        region:
          type: string
          description: Region where protected public cloud database is located.
          readOnly: true
        resourceId:
          type: string
          description: Resource ID assigned to a database server in public cloud.
          readOnly: true
        hierarchyRootName:
          type: string
          description: Name of a Veeam Backup for Microsoft 365 appliance.
          readOnly: true
        latestBackupDate:
          type: string
          description: Date and time of the latest successful backup job run protecting a public cloud database.
          format: date-time
          nullable: true
          readOnly: true
        latestArchiveDate:
          type: string
          description: Date and time of the latest successful archiving job run protecting public cloud database backups.
          format: date-time
          nullable: true
          readOnly: true
        latestSnapshotDate:
          type: string
          description: Data and time when the latest public cloud database snapshot was created.
          format: date-time
          nullable: true
          readOnly: true
        latestReplicaSnapshotDate:
          type: string
          description: Date and time when the latest replica snapshot of a public cloud database was created.
          format: date-time
          nullable: true
          readOnly: true
        backupCount:
          type: integer
          description: Number of backup files.
          format: int32
          nullable: true
          readOnly: true
        archiveCount:
          type: integer
          description: Number of archived backup files.
          format: int32
          nullable: true
          readOnly: true
        snapshotCount:
          type: integer
          description: Number of snapshots.
          format: int32
          nullable: true
          readOnly: true
        replicaSnapshotCount:
          type: integer
          description: Number of replica snapshots.
          format: int32
          nullable: true
          readOnly: true
        instanceSize:
          type: integer
          description: Size of a public cloud database.
          format: int64
          readOnly: true
        totalSize:
          type: integer
          description: Size of all backups and snapshots of a public cloud database.
          format: int64
          readOnly: true
        platform:
          enum:
            - Unknown
            - Azure
            - Amazon
            - Google
          type: string
          description: Public cloud platform.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ProtectedCloudDatabasePlatform
        databaseType:
          $ref: '#/components/schemas/PublicCloudDatabaseType'
        engineType:
          $ref: '#/components/schemas/ProtectedCloudDatabaseEngineType'
    ProtectedCloudDatabaseEngineType:
      enum:
        - Unknown
        - MsSql
        - AzureSql
        - Postgres
        - MySql
        - MariaDb
        - OracleDb
        - AuroraDbMySql
        - AuroraDbPostgres
        - DynamoDb
        - CloudSpanner
        - AwsRedshift
        - AwsRedshiftServerless
        - AzureCosmosDb
        - NoSql
        - MongoDb
        - Table
        - Gremlin
      type: string
      description: Database platform.
      nullable: true
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: ProtectedCloudDatabaseEngineType
    ProtectedCloudDatabaseBackup:
      type: object
      properties:
        databaseUid:
          type: string
          description: UID assigned to a database.
          format: uuid
          readOnly: true
        policyUid:
          type: string
          description: UID assigned to a backup policy.
          format: uuid
          nullable: true
          readOnly: true
        policyName:
          type: string
          description: Name of a backup policy.
          nullable: true
          readOnly: true
        backupType:
          enum:
            - Unknown
            - Backup
            - Archive
            - Snapshot
            - ReplicaSnapshot
          type: string
          description: Backup policy type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ProtectedCloudDatabaseBackupType
        size:
          type: integer
          description: "Total size of a backup chain, in bytes.\n> For the `Snapshot` and `ReplicaSnapshot` policy types, size of a database server, in bytes.\n"
          format: int64
          readOnly: true
        destinations:
          type: array
          items:
            type: string
          description: Array of target backup vaults.
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          nullable: true
          readOnly: true
        databaseType:
          $ref: '#/components/schemas/PublicCloudDatabaseType'
        engineType:
          $ref: '#/components/schemas/ProtectedCloudDatabaseEngineType'
    ProtectedComputerManagedByConsole:
      type: object
      properties:
        backupAgentUid:
          type: string
          description: UID assigned to a backup agent installed on a computer.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Hostname of a protected computer.
          readOnly: true
        numberOfJobs:
          type: integer
          description: Number of jobs.
          format: int32
          readOnly: true
        operationMode:
          enum:
            - Unknown
            - Server
            - Workstation
          type: string
          description: Operation mode.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ProtectedComputerOperationMode
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          readOnly: true
    ProtectedComputerManagedByConsoleJob:
      type: object
      properties:
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a job that protects the computer.
          format: uuid
          nullable: true
          readOnly: true
        jobName:
          type: string
          description: Name of a job that protects the computer.
          readOnly: true
        sourceSize:
          type: integer
          description: 'Size of protected data, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        totalRestorePointSize:
          type: integer
          description: 'Total size of all restore points, in bytes.'
          format: int64
          readOnly: true
        latestRestorePointSize:
          type: integer
          description: 'Size of the latest restore point, in bytes.'
          format: int64
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          nullable: true
          readOnly: true
        targetType:
          enum:
            - Unknown
            - Local
            - Cloud
          type: string
          description: Type of a target repository.
          readOnly: true
          x-ms-enum:
            name: RestorePointTargetType
          x-extensible-enum: true
    ProtectedComputerManagedByConsoleRestorePoint:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a restore point.
          format: uuid
          readOnly: true
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a backup job that created the restore point.
          format: uuid
          nullable: true
          readOnly: true
        backedupItems:
          type: string
          description: Protected objects.
          readOnly: true
        destination:
          type: string
          description: Path to the protected object locations.
          readOnly: true
        size:
          type: integer
          description: 'Size of the restore point, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        incrementRawDataSize:
          type: integer
          description: 'Size of backup increment, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        sourceSize:
          type: integer
          description: 'Size of the protected data, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        creationDate:
          type: string
          description: Date of the restore point creation.
          format: date-time
          nullable: true
          readOnly: true
    ProtectedComputerManagedByBackupServer:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a protected computer.
          format: uuid
          readOnly: true
        sourceInstanceUid:
          type: string
          description: Protected computer UID assigned in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        protectionGroups:
          type: array
          items:
            type: string
            format: uuid
          description: Protection group UIDs.
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Hostname of a protected computer.
          readOnly: true
        ipAddresses:
          type: array
          items:
            type: string
          description: Computer IP addresses.
          readOnly: true
        guestOs:
          type: string
          description: Operating system installed on a protected computer.
          readOnly: true
        platformType:
          enum:
            - Unknown
            - Windows
            - Linux
            - Mac
          type: string
          description: Platform type of a protected computer.
          readOnly: true
          x-ms-enum:
            name: ProtectedComputerPlatformType
          x-extensible-enum: true
        operationMode:
          enum:
            - Unknown
            - Server
            - Workstation
          type: string
          description: Operation mode.
          readOnly: true
          x-ms-enum:
            name: ProtectedComputerOperationMode
          x-extensible-enum: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          nullable: true
          readOnly: true
        malwareState:
          $ref: '#/components/schemas/MalwareState'
    ProtectedComputerManagedByBackupServerBackup:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup chain.
          format: uuid
          readOnly: true
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a backup job that created the restore point.
          format: uuid
          nullable: true
          readOnly: true
        jobName:
          type: string
          description: Name of a job that protects the computer.
          readOnly: true
        jobKind:
          enum:
            - Unknown
            - Backup
            - Copy
          type: string
          description: Job type.
          readOnly: true
          x-ms-enum:
            name: ComputerProtectingJobKind
          x-extensible-enum: true
        provisionedSourceSize:
          type: integer
          description: 'Total size of protected computer disks, in bytes.'
          format: int64
          readOnly: true
        usedSourceSize:
          type: integer
          description: 'Used space on protected computer disks, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a target repository.
          format: uuid
          readOnly: true
        totalRestorePointSize:
          type: integer
          description: 'Total size of all restore points, in bytes.'
          format: int64
          readOnly: true
        latestRestorePointSize:
          type: integer
          description: 'Size of the latest restore point, in bytes.'
          format: int64
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          nullable: true
          readOnly: true
        targetType:
          enum:
            - Unknown
            - Local
            - Cloud
          type: string
          description: Type of a target repository.
          readOnly: true
          x-ms-enum:
            name: RestorePointTargetType
          x-extensible-enum: true
        malwareState:
          $ref: '#/components/schemas/MalwareState'
        targetLocationTier:
          $ref: '#/components/schemas/SobrRepositoryTier'
    ProtectedComputerManagedByBackupServerRestorePoint:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a restore point.
          format: uuid
          readOnly: true
        backupAgentUid:
          type: string
          description: UID assigned to a Veeam backup agent.
          format: uuid
          readOnly: true
        backupUid:
          type: string
          description: UID assigned to a backup chain.
          format: uuid
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a backup job that created the restore point.
          format: uuid
          nullable: true
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a target repository
          format: uuid
          readOnly: true
        size:
          type: integer
          description: 'Size of the restore point, in bytes.'
          format: int64
          readOnly: true
        provisionedSourceSize:
          type: integer
          description: 'Total size of protected computer disks, in bytes.'
          format: int64
          readOnly: true
        usedSourceSize:
          type: integer
          description: 'Used space on protected computer disks, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        incrementRawDataSize:
          type: integer
          description: 'Size of the backup increment, in bytes.'
          format: int64
          readOnly: true
        sourceSize:
          type: integer
          description: 'Size of protected data, in bytes.'
          format: int64
          readOnly: true
        cpuCores:
          type: integer
          description: Number of protected computer CPU cores.
          format: int32
          readOnly: true
        memory:
          type: integer
          description: 'Protected computer memory, in bytes.'
          format: int64
          readOnly: true
        targetType:
          enum:
            - Unknown
            - Local
            - Cloud
          type: string
          description: Type of a target repository.
          readOnly: true
          x-ms-enum:
            name: RestorePointTargetType
          x-extensible-enum: true
        backupCreationTime:
          type: string
          description: Date and time when backup was created.
          format: date-time
          nullable: true
          readOnly: true
        fileCreationTime:
          type: string
          description: Date and time when a restore point was created.
          format: date-time
          nullable: true
          readOnly: true
        malwareState:
          $ref: '#/components/schemas/MalwareState'
    ProtectedOnPremisesFileShare:
      type: object
      properties:
        fileShareUid:
          type: string
          description: UID assigned to a file share.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a file share.
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          nullable: true
          readOnly: true
        totalArchiveSize:
          type: integer
          description: 'Size of archived file copies, in bytes.'
          format: int64
          readOnly: true
        totalShortTermBackupSize:
          type: integer
          description: 'Size of recent file copies, in bytes.'
          format: int64
          readOnly: true
        archiveRestorePoints:
          type: integer
          description: Number of restore points for long-term retention.
          format: int32
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
    ProtectedOnPremisesFileShareBackup:
      type: object
      properties:
        fileShareUid:
          type: string
          description: UID assigned to a file share.
          format: uuid
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a backup job that protects a file share.
          format: uuid
          nullable: true
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        backupUid:
          type: string
          description: UID assigned to a backup.
          format: uuid
          nullable: true
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
          readOnly: true
        archiveRepositoryUid:
          type: string
          description: UID assigned to an archive repository.
          format: uuid
          nullable: true
          readOnly: true
        archiveSize:
          type: integer
          description: 'Size of archived file copies, in bytes.'
          format: int64
          readOnly: true
        shortTermBackupSize:
          type: integer
          description: 'Size of recent file copies, in bytes.'
          format: int64
          readOnly: true
        archiveRestorePoints:
          type: integer
          description: Number of restore points for long-term retention.
          format: int32
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          readOnly: true
        sourceSize:
          type: integer
          description: 'Size of the protected data, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/ProtectedOnPremisesFileShareSource'
          description: File share backup scope.
          readOnly: true
    ProtectedOnPremisesFileShareRestorePoint:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a restore point.
          format: uuid
          readOnly: true
        fileShareUid:
          type: string
          description: UID assigned to a file share.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        backupUid:
          type: string
          description: UID assigned to a restore point.
          format: uuid
          nullable: true
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a job.
          format: uuid
          nullable: true
          readOnly: true
        restorePointDate:
          type: string
          description: Date and time of the restore point creation.
          format: date-time
          readOnly: true
        size:
          type: integer
          description: Size of a restore point.
          format: int64
          nullable: true
          readOnly: true
        isArchive:
          type: boolean
          description: Indicates whether an restore point is stored in an archive repository.
          default: true
    ProtectedOnPremisesFileShareSource:
      type: object
      properties:
        path:
          type: string
          description: Path to a location of protected data.
          readOnly: true
        inclusionMasks:
          type: array
          items:
            type: string
          description: Names and name masks of files that must be included into a backup scope.
          readOnly: true
        exclusionMasks:
          type: array
          items:
            type: string
          description: Names and name masks of files that must be excluded from a backup scope.
          readOnly: true
    ProtectedObjectStorage:
      type: object
      properties:
        objectStorageUid:
          type: string
          description: UID assigned to an object storage.
          format: uuid
          readOnly: true
        bucketUid:
          type: string
          description: UID assigned to an object storage bucket.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        objectStorageName:
          type: string
          description: Name of an object storage.
          readOnly: true
        bucketName:
          type: string
          description: Name of an object storage bucket.
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          nullable: true
          readOnly: true
        totalArchiveSize:
          type: integer
          description: 'Size of archived file copies, in bytes.'
          format: int64
          readOnly: true
        totalShortTermBackupSize:
          type: integer
          description: 'Size of recent file copies, in bytes.'
          format: int64
          readOnly: true
        archiveRestorePoints:
          type: integer
          description: Number of restore points for long-term retention.
          format: int32
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
    ProtectedObjectStorageBackup:
      type: object
      properties:
        objectStorageUid:
          type: string
          description: UID assigned to an object storage.
          format: uuid
          readOnly: true
        bucketUid:
          type: string
          description: UID assigned to an object storage bucket.
          format: uuid
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a backup job that protects an object storage.
          format: uuid
          nullable: true
          readOnly: true
        backupUid:
          type: string
          description: UID assigned to a backup.
          format: uuid
          nullable: true
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
          readOnly: true
        archiveRepositoryUid:
          type: string
          description: UID assigned to an archive repository.
          format: uuid
          nullable: true
          readOnly: true
        archiveSize:
          type: integer
          description: 'Size of archived file copies, in bytes.'
          format: int64
          readOnly: true
        shortTermBackupSize:
          type: integer
          description: 'Size of recent file copies, in bytes.'
          format: int64
          readOnly: true
        archiveRestorePoints:
          type: integer
          description: Number of restore points for long-term retention.
          format: int32
          readOnly: true
        restorePoints:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time of the latest restore point creation.
          format: date-time
          readOnly: true
        sourceSize:
          type: integer
          description: 'Size of the protected data, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        sources:
          type: array
          items:
            $ref: '#/components/schemas/ProtectedObjectStorageSource'
          description: Object storage backup scope.
          readOnly: true
    ProtectedObjectStorageRestorePoint:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a restore point.
          format: uuid
          readOnly: true
        objectStorageUid:
          type: string
          description: UID assigned to an object storage.
          format: uuid
          readOnly: true
        bucketUid:
          type: string
          description: UID assigned to an object storage bucket.
          format: uuid
          readOnly: true
        backupUid:
          type: string
          description: UID assigned to a backup.
          format: uuid
          nullable: true
          readOnly: true
        jobUid:
          type: string
          description: UID assigned to a job.
          format: uuid
          nullable: true
          readOnly: true
        restorePointDate:
          type: string
          description: Date and time of the restore point creation.
          format: date-time
          readOnly: true
        size:
          type: integer
          description: Size of a restore point.
          format: int64
          nullable: true
          readOnly: true
        isArchive:
          type: boolean
          description: Indicates whether an restore point is stored in an archive repository.
          default: true
    ProtectedObjectStorageSource:
      type: object
      properties:
        path:
          type: string
          description: Path to a location of protected data.
          readOnly: true
        inclusionMasks:
          type: array
          items:
            type: string
          description: Names and name masks of files that must be included into a backup scope.
          readOnly: true
        exclusionMasks:
          type: array
          items:
            type: string
          description: Names and name masks of files that must be excluded from a backup scope.
          readOnly: true
    ProtectedCloudFileShare:
      type: object
      properties:
        fileShareUid:
          type: string
          description: UID assigned to a file share.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a file share.
          readOnly: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          nullable: true
          readOnly: true
        resourceId:
          type: string
          description: ID assigned to a file share in public cloud infrastructure.
          readOnly: true
        platform:
          enum:
            - Unknown
            - Azure
            - Amazon
          type: string
          description: Public cloud platform.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: ProtectedCloudFileSharePlatform
        fileShareType:
          $ref: '#/components/schemas/PublicCloudFileShareType'
        snapshotsCount:
          type: integer
          description: Number of snapshots.
          format: int32
          readOnly: true
        policyCount:
          type: integer
          description: Number of backup policies protecting a file share.
          format: int32
          readOnly: true
        replicaSnapshotsCount:
          type: integer
          description: Number of replica snapshots.
          format: int32
          readOnly: true
        latestSnapshotDate:
          type: string
          description: Date and time when the latest snapshot was created.
          format: date-time
          nullable: true
          readOnly: true
        latestReplicaSnapshotDate:
          type: string
          description: Date and time when the latest replica snapshot was created.
          format: date-time
          nullable: true
          readOnly: true
    ProtectedCloudFileShareBackup:
      type: object
      properties:
        fileShareUid:
          type: string
          description: UID assigned to a file share.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a backup server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        policyUid:
          type: string
          description: UID assigned to a backup policy.
          format: uuid
          nullable: true
          readOnly: true
        policyName:
          type: string
          description: Name of a backup policy.
          nullable: true
          readOnly: true
        region:
          type: string
          description: Region where a file share is located.
          readOnly: true
        replicaRegion:
          type: string
          description: Region where a file share replica is located.
          readOnly: true
        fileShareType:
          $ref: '#/components/schemas/PublicCloudFileShareType'
        name:
          type: string
          description: Name of a file share.
          readOnly: true
        snapshotsCount:
          type: integer
          description: Number of file share snaphots.
          format: int32
          readOnly: true
        replicaSnapshotsCount:
          type: integer
          description: Number of file share replica snapshots.
          format: int32
          readOnly: true
        latestSnapshotDate:
          type: string
          description: Date and time when the latest file share snapshot was created.
          format: date-time
          nullable: true
          readOnly: true
        latestReplicaSnapshotDate:
          type: string
          description: Date and time when the latest file share replica snapshot was created.
          format: date-time
          nullable: true
          readOnly: true
        totalSize:
          type: integer
          description: 'Total size of file share and file share replica snapshots, in bytes.'
          format: int64
          nullable: true
          readOnly: true
    ProtectedCloudNetwork:
      type: object
      properties:
        instanceId:
          type: string
          description: ID assigned to a cloud network.
          readOnly: true
        accountUid:
          type: string
          description: UID assigned to a public cloud account.
          format: uuid
          nullable: true
          readOnly: true
        accountName:
          type: string
          description: Name of a public cloud account.
          readOnly: true
        subscriptionUid:
          type: string
          description: UID assigned to a cloud subscription.
          format: uuid
          nullable: true
          readOnly: true
        subscriptionName:
          type: string
          description: Name of a cloud subscription.
          readOnly: true
        regionTag:
          type: string
          description: Tag of a cloud network region.
          readOnly: true
        regionName:
          type: string
          description: Name of a cloud network region.
          readOnly: true
        policyUid:
          type: string
          description: UID assigned to a cloud network policy.
          format: uuid
          readOnly: true
        policyName:
          type: string
          description: Name of a cloud network policy.
          readOnly: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          nullable: true
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        backupServerName:
          type: string
          description: Name of a Veeam Backup & Replication server.
          readOnly: true
        restorePointsCount:
          type: integer
          description: Number of restore points.
          format: int32
          readOnly: true
        platformType:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatform'
        lastBackup:
          type: string
          description: Date and time when the latest backup was created.
          format: date-time
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a cloud network location.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to a mapped organization.
          format: uuid
          readOnly: true
    LocationAggregatedUsage:
      type: object
      properties:
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          readOnly: true
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          nullable: true
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a location.
          format: uuid
          readOnly: true
        date:
          type: string
          description: Date of data aggregation.
          format: date
          readOnly: true
        counters:
          type: array
          items:
            $ref: '#/components/schemas/AggregatedUsage'
          description: Managed services counters.
          readOnly: true
    ResellerAggregatedUsage:
      type: object
      properties:
        resellerUid:
          type: string
          description: UID assigned to a reseller.
          format: uuid
          readOnly: true
        date:
          type: string
          description: Date of data aggregation.
          format: date
          readOnly: true
        counters:
          type: array
          items:
            $ref: '#/components/schemas/AggregatedUsage'
          description: Managed services counters.
          readOnly: true
    AggregatedUsage:
      type: object
      properties:
        value:
          type: integer
          description: Counter value.
          format: int64
          readOnly: true
        type:
          enum:
            - Unknown
            - VmCloudBackups
            - VbrCloudBackupsDataTransferOut
            - VbrCloudBackupsDataTransferIn
            - ServerCloudBackups
            - WorkstationCloudBackups
            - AgentCloudBackupDataTransferOut
            - AgentCloudBackupDataTransferIn
            - CloudRepositoryUsageByServerAgent
            - CloudRepositoryUsageByWorkstationAgent
            - CloudRepositoryUsageByVm
            - CloudRepositoryUsageByUnknownFiles
            - BackedupVms
            - ReplicatedVms
            - ManagedVms
            - ManagedCloudVms
            - ManagedServerAgents
            - ManagedWorkstationAgents
            - ManagedAgentsWindowsDesktopOS
            - ManagedAgentsWindowsServerOS
            - ManagedAgentsLinuxOS
            - ManagedAgentsMacOS
            - ManagedUsers
            - VmCloudReplicas
            - VbrCloudReplicaDataTransferOut
            - VbrCloudReplicaDataTransferIn
            - VmCloudReplicaStorageUsage
            - VmCloudReplicaComputeTime
            - FileShareBackupSize
            - FileShareArchiveSize
            - FileShareSourceSize
            - ProtectedFileShares
            - ObjectStorageArchiveSize
            - ObjectStorageBackupSize
            - ObjectStorageSourceSize
            - ProtectedObjectStorages
            - CloudInsiderProtectionBackupSize
            - CloudCapacityTierBackupSize
            - CloudArchiveTierBackupSize
            - CloudPerformanceTierBackupSize
            - Vb365BackupSize
            - Vb365ArchiveSize
            - Vb365ProtectedUsers
            - Vb365ProtectedSites
            - Vb365ProtectedGroups
            - Vb365ProtectedTeams
            - CloudRegularStorageUsage
            - CloudObjectStorageUsage
            - CloudTotalUsage
            - VbrBackupSize
            - PublicCloudProtectedFileShares
            - PublicCloudProtectedCloudDatabases
            - PublicCloudBackupSize
            - PublicCloudArchiveSize
            - ManagedCdpVms
            - Vb365ProtectedEducationalUsers
          type: string
          description: Counter type.
          readOnly: true
          x-ms-enum:
            name: AggregatedUsageType
          x-extensible-enum: true
    EnterpriseManager:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup Enterprise Manager server.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Hostname of a Veeam Backup Enterprise Manager server.
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam Backup Enterprise Manager server.
          format: uuid
          readOnly: true
        installationUid:
          type: string
          description: UID assigned to a Veeam Backup Enterprise Manager installation.
          format: uuid
          readOnly: true
        version:
          type: string
          description: Version of a Veeam Backup Enterprise Manager.
          readOnly: true
        status:
          enum:
            - Unknown
            - Healthy
            - Inaccessible
            - OutofDate
          type: string
          description: Status of a Veeam Backup Enterprise Manager server.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: EnterpriseManagerStatus
    EnterpriseManagerBackupServer:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        address:
          type: string
          description: DNS name or IP address of a Veeam Backup & Replication server.
          readOnly: true
        port:
          type: integer
          description: Port used by Veeam Backup Service.
          readOnly: true
        backupServer:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServer'
          description: "Information about a Veeam Backup & Replication server.\n> If management agent is not installed on this server, the property value is `null`.'\n"
          nullable: true
          readOnly: true
      externalDocs:
        description: Enterprise Manager User Guide
        url: https://helpcenter.veeam.com/docs/backup/em/adding_veeam_backup_servers.html
    CustomWelcomeEmailTemplate:
      type: object
      properties:
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        organizationType:
          enum:
            - Unknown
            - Company
            - Reseller
          type: string
          description: Type of an organization.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: NotificationOrganizationType
        organizationScope:
          enum:
            - Unknown
            - CurrentObject
            - ChildObjects
          type: string
          description: Scope of notified organizations.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: NotificationOrganizationScope
        emailContent:
          maxLength: 10000
          minLength: 0
          type: string
          description: Content of an email message.
          nullable: true
        showSelfServiceSection:
          type: boolean
          description: Indicates whether the **Self-service** section is included in the email message.
          default: true
        isDefault:
          type: boolean
          description: Indicates whether an email message template is selected by default.
          default: true
    VOneServerSettings:
      required:
        - alarmsSynchronizationEnabled
      type: object
      properties:
        alarmsSynchronizationEnabled:
          type: boolean
    VOneServer:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam ONE server.
          format: uuid
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a Veeam ONE server location.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam ONE server.
          format: uuid
          readOnly: true
        installationUid:
          type: string
          description: UID assigned to a Veeam ONE installation.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Host name of a Veeam ONE server.
          readOnly: true
        version:
          type: string
          description: Veeam ONE version installed on a server.
          readOnly: true
        status:
          enum:
            - Unknown
            - Healthy
            - Warning
            - Inaccessible
          type: string
          description: Veeam ONE server status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VOneServerStatus
        managementAgentStatus:
          $ref: '#/components/schemas/ManagementAgentStatus'
        alarmsSynchronizationStatus:
          enum:
            - Unknown
            - Active
            - Error
            - Disabled
          type: string
          description: Veeam ONE server alarm synchronization status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: VOneServerAlarmsSynchronizationStatus
    VOneIsoPredownloadInput:
      required:
        - path
      type: object
      properties:
        path:
          maxLength: 1024
          minLength: 1
          type: string
          description: Path to a target folder.
        predownloadType:
          enum:
            - Regular
            - Patch
          type: string
          description: Veeam ONE distribution type.
          readOnly: true
          x-extensible-enum: false
          x-ms-enum:
            name: VOneServerPredownloadDistributionType
      description: Setup file predownload configuration.
    VOneServerMultipartPatchInfo:
      type: object
      properties:
        uploadUid:
          type: string
          description: UID assigned to a Veeam ONE server patch upload.
          format: uuid
          readOnly: true
        files:
          type: array
          items:
            $ref: '#/components/schemas/VOneServerMultipartPatchFile'
          description: Array of files included in a Veeam ONE server patch upload.
          readOnly: true
    VOneServerMultipartPatchFile:
      type: object
      properties:
        name:
          type: string
          description: Name of a file included in a Veeam ONE server patch upload.
          readOnly: true
        fileStreamUid:
          type: string
          description: UID assigned to a file included in a Veeam ONE server patch upload.
          format: uuid
          readOnly: true
    CreateVOneServerMultipartPatchInput:
      required:
        - files
        - action
        - stopAllActivities
        - rebootAutomatically
      type: object
      properties:
        files:
          type: array
          items:
            $ref: '#/components/schemas/VOneServerMultipartPatchFileInput'
          description: Array of files included in a Veeam ONE server patch upload.
        stopAllActivities:
          type: boolean
          description: Indicates whether all Veeam ONE activities must be stopped before patch installation begins.
        rebootAutomatically:
          type: boolean
          description: Indicates whether a Veeam ONE server must be rebooted after the patch installation is finished.
    VOneServerMultipartPatchFileInput:
      required:
        - name
        - fileSize
      type: object
      properties:
        name:
          type: string
          description: Name of a file.
        fileSize:
          maximum: 5368709120
          minimum: 1
          type: integer
          description: 'File size, in bytes.'
          format: int64
    VOneDeploymentConfigurationWithCredentials:
      required:
        - configuration
        - licenseSettings
      type: object
      properties:
        configuration:
          type: object
          allOf:
            - $ref: '#/components/schemas/VOneDeploymentConfiguration'
          description: "Deployment configuration.\n> If the `distribution` and `usePredownloadedIso` properties have the `null` value, the most recent version of Veeam ONE will be downloaded automatically.\n"
        licenseSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/VOneDeploymentLicenseSettings'
          description: License settings.
    VOneDeploymentConfiguration:
      required:
        - answerXml
        - adminUserName
        - adminPassword
      type: object
      properties:
        distribution:
          type: object
          allOf:
            - $ref: '#/components/schemas/VOneDeploymentDistributionSource'
          description: Path to the Veeam ONE setup file.
          nullable: true
        usePredownloadedIso:
          type: boolean
          description: "Indicates whether the predownloaded Veeam ONE setup file is used for installation.\n> Provided value has higher priority than the `distribution` property value.\n"
          nullable: true
        answerXml:
          type: string
          description: "XML string containing installation parameters.\n"
        allowAutoReboot:
          type: boolean
          description: Indicates whether a server must be automatically rebooted after the installation is complete.
          nullable: true
        stopAllActivities:
          type: boolean
          description: Indicates whether all other tasks must be stopped during installation. Can be enabled only for update installation.
          nullable: true
        useManagementAgentCredentials:
          type: boolean
          description: "Indicates whether management agent credentials must be used as service account credentials.\n> Provided value has higher priority than the `adminCredentials` property value.\n"
          nullable: true
        adminCredentials:
          type: object
          allOf:
            - $ref: '#/components/schemas/ManagementAgentCredentials'
          description: Service account credentials.
          nullable: true
      description: "Deployment configuration.\n> If the `distribution` and `usePredownloadedIso` properties have the `null` value, the most recent version of Veeam ONE will be downloaded automatically.      \n"
    VOneDeploymentDistributionSource:
      required:
        - filePath
        - userName
        - password
      type: object
      properties:
        filePath:
          type: string
          description: Path to the Veeam ONE installation file.
        userName:
          type: string
          description: User name required to access the file.
        password:
          type: string
          description: Password required to access the file.
    VOneDeploymentLicenseSettings:
      required:
        - licenseSource
      type: object
      properties:
        licenseFileContent:
          type: string
          description: License file content in the Base64 format.
          format: base64
          nullable: true
        licenseUid:
          type: string
          description: UID assigned to a license.
          format: uuid
          nullable: true
        licenseSource:
          enum:
            - Unknown
            - LicenseFileContent
            - AnswerXml
          type: string
          description: Source of a license file.
          x-extensible-enum: true
          x-ms-enum:
            name: VOneDeployLicenseSource
    VOneScheduledDeploymentConfiguration:
      required:
        - configuration
        - schedule
      type: object
      properties:
        configuration:
          type: object
          allOf:
            - $ref: '#/components/schemas/VOneDeploymentConfiguration'
          description: "Deployment configuration.\n> If the `distribution` and `usePredownloadedIso` properties have the `null` value, the most recent version of Veeam ONE will be downloaded automatically.\n"
        schedule:
          type: object
          allOf:
            - $ref: '#/components/schemas/DeploySchedule'
          description: Deployment scheduling settings.
    VOneScheduledDeploymentConfigurationWithCredentials:
      required:
        - configuration
        - schedule
      type: object
      properties:
        configuration:
          type: object
          allOf:
            - $ref: '#/components/schemas/VOneDeploymentConfigurationWithCredentials'
          description: Deployment configuration.
        schedule:
          type: object
          allOf:
            - $ref: '#/components/schemas/DeploySchedule'
          description: Deployment scheduling settings.
    Vb365Server:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          nullable: true
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server location.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam Backup for Microsoft 365 Server.
          format: uuid
          readOnly: true
        installationUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server installation.
          format: uuid
          nullable: true
          readOnly: true
        name:
          type: string
          description: Host name of a Veeam Backup for Microsoft 365 server.
          readOnly: true
        version:
          type: string
          description: Version of Veeam Backup for Microsoft 365 installed on a server.
          readOnly: true
        majorVersion:
          type: integer
          description: Major version of Veeam Backup for Microsoft 365 installed on a server.
          readOnly: true
        serverApiVersion:
          enum:
            - Unknown
            - V6
            - V7
            - V8
          type: string
          description: Version of Veeam Backup for Microsoft 365 server API.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365ServerApiVersion
        status:
          enum:
            - Unknown
            - Healthy
            - Warning
            - Inaccessible
          type: string
          description: Veeam Backup for Microsoft 365 server status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365ServerStatus
        managementAgentStatus:
          $ref: '#/components/schemas/ManagementAgentStatus'
    UnactivatedVb365Server:
      type: object
      properties:
        uniqueUid:
          type: string
          description: Temporary UID assigned to an unactivated Veeam Backup for Microsoft 365 server.
          format: uuid
          nullable: true
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server location.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam Backup for Microsoft 365 Server.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Host name of a Veeam Backup for Microsoft 365 server.
          readOnly: true
        version:
          type: string
          description: Veeam Backup for Microsoft 365 version installed on a server.
          readOnly: true
        status:
          enum:
            - Unknown
            - Healthy
            - Warning
            - Inaccessible
          type: string
          description: Veeam Backup for Microsoft 365 server status.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365ServerStatus
    Vb365OrganizationToCompanyMapping:
      required:
        - vb365OrganizationUid
        - companyUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a mapping.
          format: uuid
          readOnly: true
        vb365OrganizationUid:
          type: string
          description: UID assigned to a Microsoft organization.
          format: uuid
        vb365OrganizationName:
          type: string
          description: Name of a Microsoft organization.
          readOnly: true
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          readOnly: true
        vb365ServerName:
          type: string
          description: Name of a Veeam Backup for Microsoft 365 server.
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
        companyName:
          type: string
          description: Name of a company.
          readOnly: true
    Vb365DeviceCode:
      type: object
      properties:
        userCode:
          type: string
          description: Device code.
          readOnly: true
        verificationUrl:
          type: string
          description: Verification URL.
          readOnly: true
        expiresIn:
          type: integer
          description: Lifespan of the code in milliseconds.
          format: int64
          readOnly: true
        message:
          type: string
          description: Help message.
          readOnly: true
    Vb365DeviceCodeStatus:
      type: object
      properties:
        authenticated:
          type: boolean
          description: Indicates whether the authentication to Microsoft portal is completed.
          readOnly: true
    Vb365OrganizationRegion:
      enum:
        - Unknown
        - Default
        - Germany
        - China
        - USDefence
        - USGovernment
      type: string
      description: "Region where a Microsoft organization is located.\n> Available only for Microsoft 365 and hybrid organizations.\n"
      default: Default
      x-extensible-enum: true
      x-ms-enum:
        name: Vb365OrganizationRegion
    Vb365OrganizationBase:
      required:
        - id
        - name
        - type
        - isBackedUp
        - serverOwnership
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Microsoft organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Microsoft organization.
        type:
          enum:
            - Unknown
            - Microsoft365
            - OnPremises
            - Hybrid
          type: string
          description: Type of a Microsoft organization.
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365OrganizationType
        region:
          enum:
            - Unknown
            - Default
            - Germany
            - China
            - USDefence
            - USGovernment
          type: string
          description: "Region where a Microsoft organization is located.\n> Available only for Microsoft 365 and hybrid organizations.\n"
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365OrganizationRegion
        cloudAuthenticatedMethod:
          enum:
            - Unknown
            - Modern
            - ModernWithLegacyProtocols
            - Basic
          type: string
          description: "Authentication type of a Microsoft organization.\nAvailable only for Microsoft 365 and hybrid organization.\n"
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365OrganizationCloudAuthenticationType
        protectedServices:
          type: array
          items:
            enum:
              - Unknown
              - MicrosoftSharePointServer
              - SharePointOnlineAndOneDriveForBusiness
              - MicrosoftExchangeServer
              - ExchangeOnline
              - MicrosoftTeams
              - MicrosoftTeamsChats
            type: string
            readOnly: true
            x-extensible-enum: true
            x-ms-enum:
              name: Vb365OrganizationProtectedServices
          description: Array of protected Microsoft organization services.
          readOnly: true
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          readOnly: true
        vb365ServerName:
          type: string
          description: Name of a Veeam Backup for Microsoft 365 server.
          readOnly: true
        locationUid:
          type: string
          description: "UID assigned to a location of a management agent installed on a Veeam Backup for Microsoft 365 server.\n> If a Veeam Backup for Microsoft 365 server is not managed by Veeam Service Provider Console, the property value is `null`.\n"
          format: uuid
          nullable: true
        locationName:
          type: string
          description: "Name of a location of a management agent installed on a Veeam Backup for Microsoft 365 server.\n> If a Veeam Backup for Microsoft 365 server is not managed by Veeam Service Provider Console, the property value is `null`.\n"
          nullable: true
        isBackedUp:
          type: boolean
          description: Indicates whether the Microsoft organization files have been processed by a backup job.
          readOnly: true
        firstBackupTime:
          type: string
          description: Date and time when Microsoft organization were processed by a backup job for the first time.
          format: date-time
          nullable: true
          readOnly: true
        lastBackupTime:
          type: string
          description: Date and time when Microsoft organization files were processed by a backup job for the last time.
          format: date-time
          nullable: true
          readOnly: true
        registeredBy:
          type: string
          description: "Name of a Veeam Service Provider Console organization that registered a Microsoft organization.\nIf a Microsoft organization was not created in Veeam Service Provider Console or was deleted, the property value is `null`.\n"
          nullable: true
          readOnly: true
        registrationDate:
          type: string
          description: "Date and time when a Microsoft organization was registered.\nIf a Microsoft organization was not created in Veeam Service Provider Console, the property value is `null`.\n"
          format: date-time
          nullable: true
          readOnly: true
        isRemoving:
          type: boolean
          description: Indicates whether a Microsoft organization is currently being removed.
          readOnly: true
        isJobSchedulingEnabled:
          type: boolean
          description: Indicates whether the current user can apply changes to a Microsoft organization job schedule.
          nullable: true
          readOnly: true
        mappedOrganizationUid:
          type: string
          description: UID assigned to an organization that is mapped to a Microsoft organization.
          format: uuid
          nullable: true
          readOnly: true
        mappedOrganizationName:
          type: string
          description: Name of an organization that is mapped to a Microsoft organization.
          nullable: true
          readOnly: true
        _embedded:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OrganizationBaseEmbedded'
          description: Detailed information about a Microsoft organization.
          nullable: true
          readOnly: true
    Vb365OrganizationBaseEmbedded:
      type: object
      properties:
        organizationDetails:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OrganizationDetails'
          description: Microsoft organization details.
          nullable: true
          readOnly: true
        vb365Server:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Server'
          description: Information on a Veeam Backup for Microsoft 365 server.
          nullable: true
          readOnly: true
    Vb365OrganizationDetails:
      type: object
      properties:
        microsoft365OrganizationDetails:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365Organization'
          description: Detailed information about a Microsoft 365 organization.
          nullable: true
          readOnly: true
        onPremisesOrganizationDetails:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OnPremisesMicrosoftOrganization'
          description: Detailed information about an on-premises Microsoft organization.
          nullable: true
          readOnly: true
        hybridOrganizationDetails:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365HybridOrganization'
          description: Detailed information about a hybrid Microsoft organization.
          nullable: true
          readOnly: true
    Vb365Microsoft365Organization:
      required:
        - exchangeAndSharePointOnlineConnectionSettings
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Microsoft 365 organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Microsoft 365 organization.
          readOnly: true
        isTeamsOnline:
          type: boolean
          description: "Indicates whether an organization contains Microsoft Teams components.\n> If the property has the `true` value, the `exchangeAndSharePointOnlineConnectionSettings` property becomes required.\n"
          default: false
        isTeamsChatsOnline:
          type: boolean
          description: "Indicates whether an organization contains Microsoft Teams chats.\n> Cannot be enabled if the `isTeamsOnline` property has the `false` value.\n"
          default: false
        exchangeAndSharePointOnlineConnectionSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365ConnectionSettings'
          description: Microsoft Exchange Online and Microsoft SharePoint Online connection settings for one of authentication types.
        region:
          $ref: '#/components/schemas/Vb365OrganizationRegion'
        _embedded:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OrganizationChildrenEmbedded'
          description: Information about a source Microsoft organization.
          nullable: true
          readOnly: true
    Vb365Microsoft365ConnectionSettings:
      type: object
      properties:
        modernAppOnlyAuthenticationSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365ModernAppOnlyAuthenticationConnectionSettings'
          description: Settings for modern app-only authentication.
          nullable: true
        modernAuthenticationWithLegacyProtocolsSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365ModernAuthenticationWithLegacyProtocolsConnectionSettings'
          description: Settings for modern authentication and MFA-enabled service account with enabled legacy protocol.
          nullable: true
        basicAuthenticationSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365BasicAuthenticationConnectionSettings'
          description: Settings for basic authentication.
          nullable: true
    Vb365Microsoft365ModernAppOnlyAuthenticationConnectionSettings:
      type: object
      properties:
        configureApplication:
          type: boolean
          description: "Indicates whether Veeam Backup for Microsoft 365 can automatically assign the certificate and required permissions to the specified Azure AD application.\n> Required only for existing Azure AD application.\n"
          default: false
          nullable: true
          writeOnly: true
        userCode:
          type: string
          description: Device code.
          nullable: true
          writeOnly: true
        newApplicationName:
          type: string
          description: "Name of an Azure AD application.\n> Required only when registering a new Azure AD applications.\n"
          nullable: true
          writeOnly: true
        applicationId:
          type: string
          description: "UID assigned to the application in Azure AD.\n> Required only for an existing Azure AD application.\n"
          format: uuid
          nullable: true
        applicationCertificate:
          type: string
          description: SSL certificate for Azure AD application access in the Base64 format.
          format: byte
          nullable: true
          writeOnly: true
        applicationCertificatePassword:
          type: string
          description: Password for the SSL certificate.
          format: password
          nullable: true
          writeOnly: true
        applicationCertificateThumbprint:
          type: string
          description: Application certificate thumbprint for a Microsoft 365 organization.
          readOnly: true
        sharePointSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365ModernAppOnlyAuthenticationSharePointConnectionSettings'
          description: Microsoft SharePoint Online connection settings.
          nullable: true
        exchangeSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365ModernAppOnlyAuthenticationExchangeConnectionSettings'
          description: Microsoft Exchange Online connection settings.
          nullable: true
    Vb365Microsoft365ModernAuthenticationWithLegacyProtocolsConnectionSettings:
      type: object
      properties:
        sharePointSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365ModernAuthenticationWithLegacyProtocolsCommonConnectionSettings'
          description: Microsoft SharePoint Online connection settings.
          nullable: true
        exchangeSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365ModernAuthenticationWithLegacyProtocolsCommonConnectionSettings'
          description: Microsoft Exchange Online connection settings.
          nullable: true
    Vb365Microsoft365BasicAuthenticationConnectionSettings:
      type: object
      properties:
        sharePointSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365BasicAuthenticationCommonConnectionSettings'
          description: Microsoft SharePoint Online connection settings.
          nullable: true
        exchangeSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365BasicAuthenticationCommonConnectionSettings'
          description: Microsoft Exchange Online connection settings.
          nullable: true
    Vb365Microsoft365ModernAppOnlyAuthenticationExchangeConnectionSettings:
      required:
        - applicationCertificate
      type: object
      properties:
        officeOrganizationName:
          type: string
          description: "Name of a Microsoft Exchange Online organization in the following format: `<name>.onmicrosoft.com`.\n> Required only for an existing Azure AD application.\n"
          readOnly: true
        account:
          pattern: ^\S+@\S+$
          type: string
          description: "Name of a Microsoft Exchange Online organization account.\n> Required only for an existing Azure AD application.\n> Is not required if Microsoft SharePoint Online connection settings and the `officeOrganizationName` property value are specified.\n"
          nullable: true
    Vb365Microsoft365ModernAppOnlyAuthenticationSharePointConnectionSettings:
      required:
        - applicationCertificate
      type: object
      properties:
        sharePointSaveAllWebParts:
          type: boolean
          description: Indicates whether the export mode for SharePoint Web Parts must be changed to back up a customized content of Microsoft SharePoint Online sites.
          default: false
        officeOrganizationName:
          type: string
          description: "Name of a Microsoft SharePoint Online organization in the following format: `<name>.onmicrosoft.com`.\n> Required only for an existing Azure AD application.\n"
          nullable: true
    Vb365Microsoft365ModernAuthenticationWithLegacyProtocolsCommonConnectionSettings:
      required:
        - account
        - password
        - applicationId
      type: object
      properties:
        account:
          pattern: ^\S+@\S+$
          type: string
          description: User name of an account with enabled MFA.
        password:
          type: string
          description: Password of an account with enabled MFA.
          format: password
        grantAdminAccess:
          type: boolean
          description: "Indicates whether the `ApplicationImpersonation` role is assigned to an account. This role is required to back up Microsoft Exchange Online mailboxes.\nTo assign the ApplicationImpersonation role, make sure the account that you use is a member of the Organization Management group and has been granted the Role Management role in advance.\n"
          default: false
        applicationId:
          type: string
          description: UID assigned to the Azure AD application that is used to access a Microsoft 365 organization.
          format: uuid
        applicationSecret:
          type: string
          description: "Application secret for the Azure AD application.\n> Use either `applicationSecret` or `applicationCertificate`.\n"
          format: password
          nullable: true
        applicationCertificate:
          type: string
          description: "SSL certificate in the Base64 format that is used to access the Azure AD application.\nUse either `applicationSecret` or `applicationCertificate`.\n"
          format: byte
          nullable: true
        applicationCertificatePassword:
          type: string
          description: Password for the SSL certificate.
          format: password
          nullable: true
        applicationCertificateThumbprint:
          type: string
          description: Application certificate thumbprint for a Microsoft 365 organization.
          readOnly: true
    Vb365Microsoft365BasicAuthenticationCommonConnectionSettings:
      required:
        - account
        - password
      type: object
      properties:
        account:
          type: string
          description: User name of an account.
        password:
          type: string
          description: Password of an account.
          format: password
          nullable: true
          writeOnly: true
        grantAdminAccess:
          type: boolean
          description: "Indicates whether the `ApplicationImpersonation` role is assigned to an account. This role is required to back up Microsoft Exchange Online mailboxes.\nTo assign the ApplicationImpersonation role, make sure the account that you use is a member of the Organization Management group and has been granted the Role Management role in advance.\n"
          default: false
        useCustomVeeamAADApplication:
          type: boolean
          description: Indicates whether Veeam Backup for Microsoft 365 must use Veeam Azure AD Application to connect to a Microsoft organization.
          default: false
    Vb365OnPremisesMicrosoftOrganization:
      required:
        - name
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to an on-premises Microsoft organization in Veeam Service Provider Console.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of an on-premises Microsoft organization.
        sharePointSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OnPremisesMicrosoftSharePointSettings'
          description: Microsoft SharePoint Online connection settings.
          nullable: true
        exchangeSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OnPremisesMicrosoftExchangeSettings'
          description: Microsoft Exchange Online connection settings.
          nullable: true
        _embedded:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OrganizationChildrenEmbedded'
          description: Information about a source Microsoft organization.
          nullable: true
          readOnly: true
    Vb365OnPremisesMicrosoftSharePointSettings:
      type: object
      properties:
        serverName:
          type: string
          description: Microsoft SharePoint Online server EWS endpoint URL.
          readOnly: true
        serverPort:
          type: integer
          description: Port that is used to access a Microsoft SharePoint Online server. Default port is 5985.
          format: int32
          nullable: true
          readOnly: true
        grantImpersonation:
          type: boolean
          description: Indicates whether backup jobs can process all items within a Microsoft SharePoint Online organization.
          readOnly: true
        userName:
          type: string
          description: User name of an account that is used to access an on-premises Microsoft SharePoint Online organization.
          readOnly: true
        useSSL:
          type: boolean
          description: Indicates whether Veeam Backup for Microsoft Office 365 uses a secure connection with Microsoft SharePoint organization server.
          readOnly: true
        skipCAverification:
          type: boolean
          description: Indicates whether Certificate Authority verification check must not be performed.
          readOnly: true
        skipCommonNameVerification:
          type: boolean
          description: Indicates whether Common Name verification check must not be performed.
          readOnly: true
        skipRevocationCheck:
          type: boolean
          description: Indicates whether the check of certificate expiration against the certificate revocation list must not be performed.
          readOnly: true
    Vb365OnPremisesMicrosoftExchangeSettings:
      type: object
      properties:
        serverName:
          type: string
          description: Microsoft Exchange Online server EWS endpoint URL.
          readOnly: true
        grantImpersonation:
          type: boolean
          description: Indicates whether backup jobs can process all mailboxes within a Microsoft Exchange Online organization.
          readOnly: true
        userName:
          type: string
          description: User name of an account that is used to access an on-premises Microsoft Exchange Online organization.
          readOnly: true
        useSSL:
          type: boolean
          description: Indicates whether Veeam Backup for Microsoft 365 must use a secure connection with Microsoft SharePoint organization server.
          readOnly: true
        skipCAverification:
          type: boolean
          description: Indicates whether Certificate Authority verification check must not be performed.
          readOnly: true
        skipCommonNameVerification:
          type: boolean
          description: Indicates whether Common Name verification check must not be performed.
          readOnly: true
        skipRevocationCheck:
          type: boolean
          description: Indicates whether the check of certificate expiration against the certificate revocation list must not be performed.
          readOnly: true
        configureThrottlingPolicy:
          type: boolean
          description: "Indicates whether Veeam Backup for Microsoft 365 must configure `VeeamArchiverThrottlingPolicy` for connecting with Microsoft Exchange Online organization server.\n> `VeeamArchiverThrottlingPolicy` overrides existing Microsoft Exchange Online throttling policies and provides unlimited network bandwidth.\n"
          readOnly: true
    Vb365HybridOrganization:
      required:
        - exchangeAndSharePointOnlineConnectionSettings
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a hybrid Microsoft organization.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a hybrid Microsoft organization.
          readOnly: true
        isTeamsOnline:
          type: boolean
          description: "Indicates whether an organization contains Microsoft Teams components.\n> If the property has the `true` value, the `exchangeAndSharePointOnlineConnectionSettings`, `sharePointSettings` and `exchangeSettings` properties become required.\n"
          default: false
        isTeamsChatsOnline:
          type: boolean
          description: "Indicates whether an organization contains Microsoft Teams chats.\nCannot be enabled if the `isTeamsOnline` property has the `false` value.\n"
          default: false
        exchangeAndSharePointOnlineConnectionSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365Microsoft365ConnectionSettings'
          description: Microsoft Exchange Online and Microsoft SharePoint Online connection settings for one of authentication types.
        region:
          $ref: '#/components/schemas/Vb365OrganizationRegion'
        sharePointSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OnPremisesMicrosoftSharePointSettings'
          description: Microsoft SharePoint Online connection settings.
          nullable: true
        exchangeSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OnPremisesMicrosoftExchangeSettings'
          description: Microsoft Exchange Online connection settings.
          nullable: true
        _embedded:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OrganizationChildrenEmbedded'
          description: Information about a source Microsoft organization.
          nullable: true
          readOnly: true
    Vb365OrganizationChildrenEmbedded:
      type: object
      properties:
        organizationBase:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365OrganizationBase'
          description: Resource representation of a source Microsoft organization.
          nullable: true
          readOnly: true
    Vb365BackupProxy:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup proxy.
          format: uuid
          readOnly: true
        proxyType:
          enum:
            - Unknown
            - Local
            - Domain
            - Workgroup
          type: string
          description: Type of a backup proxy.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365ProxyType
        status:
          enum:
            - Unknown
            - Online
            - Offline
          type: string
          description: Status of a backup proxy.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365ProxyStatus
        hostName:
          type: string
          description: Host name of a backup proxy.
          readOnly: true
        description:
          type: string
          description: Description of a backup proxy.
          readOnly: true
        port:
          type: integer
          description: Port that is used to connect to a backup proxy.
          format: int32
          readOnly: true
    Vb365BackupProxyPool:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup proxy pool.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a backup proxy pool.
          readOnly: true
        description:
          type: string
          description: Description of a backup proxy pools.
          readOnly: true
    Vb365BackupRepository:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a backup repository
          readOnly: true
        description:
          type: string
          description: Description of a backup repository
          readOnly: true
        proxyUid:
          type: string
          description: UID assigned to a backup proxy.
          format: uuid
          nullable: true
          readOnly: true
        proxyPoolUid:
          type: string
          description: UID assigned to a backup proxy pool.
          format: uuid
          nullable: true
          readOnly: true
        path:
          type: string
          description: Path to a folder that contains backup files.
          readOnly: true
        isArchiveRepository:
          type: boolean
          description: Indicates whether a backup repository is used as an archive repository.
          readOnly: true
        isAvailableForBackupJob:
          type: boolean
          description: Indicates whether a backup repository can be used to store backups.
          readOnly: true
        isAvailableForCopyJob:
          type: boolean
          description: Indicates whether a backup repository can be used to store backup copies.
          readOnly: true
        isObjectStorageRepository:
          type: boolean
          description: Indicates whether a backup repository is used as an object storage.
          readOnly: true
        objectStorageRepositoryUid:
          type: string
          description: UID assigned to an object storage.
          format: uuid
          nullable: true
          readOnly: true
        objectStorageRepositoryCachePath:
          type: string
          description: Path to the directory of the backup repository on a backup proxy server.
          readOnly: true
        objectStorageRepositoryEncryptionEnabled:
          type: boolean
          description: Indicates whether the object storage encryption is enabled.
          nullable: true
          readOnly: true
        encryptionKeyId:
          type: string
          description: ID assigned to an encryption key.
          format: uuid
          nullable: true
          readOnly: true
        isOutOfSync:
          type: boolean
          description: Indicates whether a backup proxy server must be synchronized with the object storage to get the same cache state.
          readOnly: true
        capacityBytes:
          type: integer
          description: 'Storage capacity, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        freeSpaceBytes:
          type: integer
          description: 'Amount of free disk space on a backup repository, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        usedSpaceBytes:
          type: integer
          description: 'Amount of used disk space on a backup repository, in bytes.'
          format: int64
          nullable: true
          readOnly: true
        dailyRetentionPeriod:
          type: integer
          description: Retention period in days.
          nullable: true
          readOnly: true
        monthlyRetentionPeriod:
          type: integer
          description: Retention period in months.
          nullable: true
          readOnly: true
        dailyTime:
          type: string
          description: Time of the day when the daily clean-up must be performed.
          readOnly: true
        monthlyTime:
          type: string
          description: ' Time of the day when the monthly clean-up must be performed.'
          readOnly: true
        retentionType:
          enum:
            - Unknown
            - ItemLevel
            - SnapshotBased
          type: string
          description: Type of the retention policy.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365RetentionType
        retentionPeriodType:
          enum:
            - Unknown
            - Monthly
            - Daily
            - Yearly
          type: string
          description: Retention period type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365RetentionPeriodType
        yearlyRetentionPeriod:
          enum:
            - Unknown
            - Year1
            - Years2
            - Years3
            - Years5
            - Years7
            - Years10
            - Years25
            - Keep
          type: string
          description: Retention period in years.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365YearlyRetentionPeriod
        retentionFrequencyType:
          enum:
            - Unknown
            - Daily
            - Monthly
          type: string
          description: Clean-up schedule type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365RetentionFrequencyType
        dailyType:
          enum:
            - Unknown
            - Everyday
            - Workdays
            - Weekends
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
            - Sunday
          type: string
          description: Days when the daily clean-up must be performed.
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365RepositoryDailyType
        monthlyDayNumber:
          enum:
            - Unknown
            - First
            - Second
            - Third
            - Fourth
            - Last
          type: string
          description: Order number of the day of the week when the monthly clean-up must be performed.
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365MonthlyDayNumber
        monthlyDayOfWeek:
          enum:
            - Unknown
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Day of the week when the monthly clean-up must be performed.
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365MonthlyDayOfWeek
    Vb365Job:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 job.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Backup for Microsoft 365 job.
          readOnly: true
        jobType:
          enum:
            - Unknown
            - BackupJob
            - CopyJob
          type: string
          description: Type of a Veeam Backup for Microsoft 365 job.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365JobType
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
          readOnly: true
        repositoryName:
          type: string
          description: Name of a backup repository.
          readOnly: true
        vb365OrganizationUid:
          type: string
          description: UID assigned to a Microsoft organization.
          format: uuid
          readOnly: true
        vspcOrganizationUid:
          type: string
          description: UID assigned to a Veeam Service Provider Console organization.
          format: uuid
          nullable: true
          readOnly: true
        vspcOrganizationName:
          type: string
          description: Name of a Veeam Service Provider Console organization.
          nullable: true
          readOnly: true
        scheduleEditingAvailable:
          type: boolean
          description: Indicates whether job schedule editing is available to a current user.
          readOnly: true
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          readOnly: true
        vb365ServerName:
          type: string
          description: Name of a Veeam Backup for Microsoft 365 server.
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent installed on a Veeam Backup for Microsoft 365 Server.
          format: uuid
          readOnly: true
        lastRun:
          type: string
          description: Date and time of the latest job run.
          format: date-time
          nullable: true
          readOnly: true
        nextRun:
          type: string
          description: Date and time of the next scheduled job run.
          format: date-time
          nullable: true
          readOnly: true
        isEnabled:
          type: boolean
          description: Indicates whether a Veeam Backup for Microsoft 365 job is enabled.
          default: false
          readOnly: true
        isCopyJobAvailable:
          type: boolean
          description: Indicates whether a backup copy job can be created for the Veeam Backup for Microsoft 365 job.
          readOnly: true
        lastStatus:
          enum:
            - Unknown
            - Stopped
            - Running
            - Success
            - Failed
            - Warning
            - NotConfigured
            - Disconnected
            - Queued
            - Starting
            - Stopping
            - Deleting
          type: string
          description: Status of the latest job run.
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365JobLastStatus
        lastStatusDetails:
          type: string
          description: Details on the latest job run.
          readOnly: true
        siteName:
          type: string
          description: Name of a Veeam Cloud Connect site on which a Microsoft organization that owns Veeam backup agent is registered.
          nullable: true
          readOnly: true
        locationName:
          type: string
          description: Name of a location assigned to a Veeam backup agent.
          nullable: true
          readOnly: true
        lastErrorLogRecords:
          type: array
          items:
            $ref: '#/components/schemas/Vb365JobSessionLog'
          description: The list of last job session logs.
          readOnly: true
          x-veeam-empty-array-by-default: true
    Vb365CopyJob:
      required:
        - sourceBackupJobUid
        - repositoryUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 backup copy job.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Backup for Microsoft 365 backup copy job.
          readOnly: true
        sourceBackupJobUid:
          type: string
          description: UID assigned to a source Veeam Backup for Microsoft 365 job.
          format: uuid
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
        repositoryName:
          type: string
          description: Name of a backup repository.
          readOnly: true
        vb365OrganizationUid:
          type: string
          description: UID assigned to a Microsoft organization.
          format: uuid
          readOnly: true
        vspcOrganizationUid:
          type: string
          description: UID assigned to a Veeam Service Provider Console organization.
          format: uuid
          nullable: true
          readOnly: true
        vspcOrganizationName:
          type: string
          description: Name of a Veeam Service Provider Console organization.
          nullable: true
          readOnly: true
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          readOnly: true
        vb365ServerName:
          type: string
          description: Name of a Veeam Backup for Microsoft 365 server.
          readOnly: true
        lastRun:
          type: string
          description: Date and time of the latest job run.
          format: date-time
          nullable: true
          readOnly: true
        nextRun:
          type: string
          description: Date and time of the next scheduled job run.
          format: date-time
          nullable: true
          readOnly: true
        isEnabled:
          type: boolean
          description: Indicates whether a Veeam Backup for Microsoft 365 backup copy job is enabled.
          default: true
        lastStatus:
          enum:
            - Unknown
            - Stopped
            - Running
            - Success
            - Failed
            - Warning
            - NotConfigured
            - Disconnected
            - Queued
            - Starting
            - Stopping
            - Deleting
          type: string
          description: Status of the latest job run.
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365JobLastStatus
        lastStatusDetails:
          type: string
          description: Details on the latest job run.
          readOnly: true
        lastErrorLogRecords:
          type: array
          items:
            $ref: '#/components/schemas/Vb365JobSessionLog'
          description: The list of last job session logs.
          readOnly: true
          x-veeam-empty-array-by-default: true
        schedulePolicy:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365CopyJobSchedulePolicy'
          description: Schedule settings of a Veeam Backup for Microsoft 365 backup copy job.
          nullable: true
    Vb365CopyJobSchedulePolicy:
      type: object
      properties:
        schedulePolicyType:
          enum:
            - Unknown
            - Immediate
            - Periodically
            - DailyAtTime
          type: string
          description: Type of a schedule policy.
          nullable: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365CopyJobSchedulePolicyType
        periodicallyEvery:
          enum:
            - Unknown
            - Minutes5
            - Minutes10
            - Minutes15
            - Minutes30
            - Hours1
            - Hours2
            - Hours4
            - Hours8
            - Hours12
          type: string
          description: Type of a time interval for a periodically running job.
          nullable: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365PeriodicallyEvery
        dailyType:
          enum:
            - Unknown
            - Everyday
            - Workdays
            - Weekends
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
            - Sunday
          type: string
          description: Days when the daily job runs.
          nullable: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365DailyType
        backupWindowEnabled:
          type: boolean
          description: Indicates whether backup window is enabled.
          default: false
        backupWindowSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365BackupWindowSettings'
          description: Backup window settings.
          nullable: true
        dailyTime:
          type: string
          description: Time of the day when a daily job is started in the `hh:mm` format.
          format: time-of-day
          nullable: true
    Vb365BackupJob:
      required:
        - name
        - repositoryUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 backup job.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Backup for Microsoft 365 backup job.
        description:
          type: string
          description: Description of a Veeam Backup for Microsoft 365 backup job.
          nullable: true
        repositoryUid:
          type: string
          description: "UID assigned to a backup repository.\n>When patching job target repository, you can use the `GetVb365BackupJobAvailableBackupRepositories` operation to retrieve a list of available repositories.\n"
          format: uuid
        repositoryName:
          type: string
          description: Name of a backup repository.
          readOnly: true
        vb365OrganizationUid:
          type: string
          description: UID assigned to a Microsoft organization.
          format: uuid
          readOnly: true
        vspcOrganizationUid:
          type: string
          description: UID assigned to a Veeam Service Provider Console organization.
          format: uuid
          nullable: true
          readOnly: true
        vspcOrganizationName:
          type: string
          description: Name of a Veeam Service Provider Console organization.
          nullable: true
          readOnly: true
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          readOnly: true
        vb365ServerName:
          type: string
          description: Name Of a Veeam Backup for Microsoft 365 server.
          readOnly: true
        lastRun:
          type: string
          description: Date and time of the latest job run.
          format: date-time
          nullable: true
          readOnly: true
        nextRun:
          type: string
          description: Date and time of the next scheduled job run.
          format: date-time
          nullable: true
          readOnly: true
        isEnabled:
          type: boolean
          description: Indicates whether a Veeam Backup for Microsoft backup job is enabled.
          default: false
        isCopyJobAvailable:
          type: boolean
          description: Indicates whether a backup copy job can be created for the Veeam Backup for Microsoft 365 backup job.
          readOnly: true
        backupType:
          enum:
            - Unknown
            - EntireOrganization
            - SelectedItems
          type: string
          description: Type of a Veeam Backup for Microsoft 365 backup job.
          nullable: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365BackupType
        lastStatus:
          enum:
            - Unknown
            - Stopped
            - Running
            - Success
            - Failed
            - Warning
            - NotConfigured
            - Disconnected
            - Queued
            - Starting
            - Stopping
            - Deleting
          type: string
          description: Status of the latest job run.
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365JobLastStatus
        lastStatusDetails:
          type: string
          description: Details on the latest job run.
          readOnly: true
        lastErrorLogRecords:
          type: array
          items:
            $ref: '#/components/schemas/Vb365JobSessionLog'
          description: The list of last job session logs.
          readOnly: true
          x-veeam-empty-array-by-default: true
        selectedItems:
          type: array
          items:
            $ref: '#/components/schemas/Vb365JobItemComposed'
          description: Array of backup job items.
          x-veeam-empty-array-by-default: true
        excludedItems:
          type: array
          items:
            $ref: '#/components/schemas/Vb365JobItemComposed'
          description: Array of items excluded from the backup job.
          x-veeam-empty-array-by-default: true
        schedulePolicy:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365BackupJobSchedulePolicy'
          description: Backup job schedule settings.
          nullable: true
    Vb365JobSessionLog:
      type: object
      properties:
        message:
          type: string
          description: The job session log details
          readOnly: true
        logType:
          enum:
            - Unknown
            - Success
            - Error
            - Warning
          type: string
          description: The job session log type
          nullable: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365JobSessionLogType
    Vb365JobItemComposed:
      type: object
      properties:
        id:
          type: string
          description: ID assigned to a backup job item.
          readOnly: true
        itemType:
          enum:
            - Unknown
            - Group
            - User
            - Site
            - PartialOrganization
            - PersonalSites
            - OneDriveFolders
            - Team
          type: string
          description: Type of a backup job item.
          nullable: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365JobBackupItemType
        folders:
          uniqueItems: true
          type: array
          items:
            maxLength: 32767
            minLength: 1
            type: string
          description: Array of folders included in a backup job.
          nullable: true
        backupMailbox:
          type: boolean
          description: Indicates whether a backup job must include mailboxes.
          default: false
        backupOneDrive:
          type: boolean
          description: Indicates whether a backup job must include OneDrive data.
          default: false
        backupArchiveMailbox:
          type: boolean
          description: Indicates whether a backup job must include mailbox archive.
          default: false
        backupPersonalSite:
          type: boolean
          description: Indicates whether a backup job must include personal sites.
          default: false
        backupSites:
          type: boolean
          description: Indicates whether a backup job must include sites.
          default: false
        backupTeams:
          type: boolean
          description: Indicates whether a backup job must include Microsoft Teams data.
          default: false
        backupTeamsChats:
          type: boolean
          description: Indicates whether a backup job must include Microsoft Teams chat data.
          default: false
        backupMembers:
          type: boolean
          description: Indicates whether a backup job must include group member data.
          default: false
        backupMemberMailbox:
          type: boolean
          description: Indicates whether a backup job must include group member mailboxes.
          default: false
        backupMemberArchiveMailbox:
          type: boolean
          description: Indicates whether a backup job must include group member mailbox archive.
          default: false
        backupMemberOneDrive:
          type: boolean
          description: Indicates whether a backup job must include group member OneDrive data.
          default: false
        backupMemberSite:
          type: boolean
          description: Indicates whether a backup job must include group member sites.
          default: false
        backupGroupSite:
          type: boolean
          description: Indicates whether a backup job must include group sites.
          default: false
        site:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365JobItemSite'
          description: Site data.
          nullable: true
        team:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365JobItemTeam'
          description: Microsoft Teams data.
          nullable: true
        user:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365JobItemUser'
          description: User data.
          nullable: true
        group:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365JobItemGroup'
          description: Group data.
          nullable: true
    Vb365JobItemSite:
      required:
        - id
        - title
        - url
      type: object
      properties:
        id:
          type: string
          description: ID assigned to a site.
        name:
          type: string
          description: Name of a site.
          readOnly: true
        title:
          type: string
          description: Title of a site.
        url:
          type: string
          description: Site URL.
        parentUrl:
          type: string
          description: Parent URL of a site.
          readOnly: true
        isCloud:
          type: boolean
          description: Indicates whether a site is cloud-based.
          readOnly: true
        isPersonal:
          type: boolean
          description: Indicates whether a site is personal.
          readOnly: true
        isAvailable:
          type: boolean
          description: Indicates whether a site can be included in a backup job.
          readOnly: true
        siteCollectionError:
          type: string
          description: Message for site collection processing error.
          readOnly: true
    Vb365JobItemTeam:
      required:
        - id
        - displayName
        - mail
      type: object
      properties:
        id:
          type: string
          description: ID assigned to a team.
          format: uuid
        displayName:
          type: string
          description: Display name of a team.
        description:
          type: string
          description: Description of a team.
          default: ''
        mail:
          type: string
          description: Email address of a team.
    Vb365JobItemUser:
      required:
        - id
        - name
        - displayName
        - userType
      type: object
      properties:
        id:
          type: string
          description: ID assigned to a user.
        onPremisesSid:
          type: string
          description: SID assigned to a user of an on-premises organization.
          nullable: true
        officeName:
          type: string
          description: Microsoft 365 Online name of an organization to which a user belongs.
          readOnly: true
        userType:
          enum:
            - Unknown
            - User
            - Shared
            - Public
          type: string
          description: Type of a user.
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365UserType
        locationType:
          enum:
            - Unknown
            - OnPremises
            - Cloud
            - Hybrid
          type: string
          description: Type of a user location.
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365UserLocationType
        name:
          type: string
          description: Name of a user.
        displayName:
          type: string
          description: Display name of a user.
    Vb365JobItemGroup:
      required:
        - id
        - name
        - displayName
        - groupType
      type: object
      properties:
        id:
          type: string
          description: ID assigned to an organization group.
        onPremisesSid:
          type: string
          description: SID assigned to an on-premises organization group.
          nullable: true
        groupType:
          enum:
            - Unknown
            - Office365
            - Security
            - Distribution
            - DynamicDistribution
          type: string
          description: Type of an organization group.
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365GroupType
        locationType:
          enum:
            - Unknown
            - OnPremises
            - Cloud
            - Hybrid
          type: string
          description: Type of an organization group location.
          nullable: true
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365GroupLocationType
        name:
          type: string
          description: Name of an organization group.
        displayName:
          type: string
          description: Display name of an organization group.
        managedBy:
          type: string
          description: Name of a user that manages an organization group.
          readOnly: true
        site:
          type: string
          description: URL of an organization group site.
          readOnly: true
    Vb365BackupJobSchedulePolicy:
      required:
        - schedulePolicyType
      type: object
      properties:
        schedulePolicyType:
          enum:
            - Unknown
            - Periodically
            - Daily
            - ManualOnly
          type: string
          description: Type of a job schedule policy.
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365SchedulePolicyType
        periodicallyEvery:
          enum:
            - Unknown
            - Minutes5
            - Minutes10
            - Minutes15
            - Minutes30
            - Hours1
            - Hours2
            - Hours4
            - Hours8
            - Hours12
          type: string
          description: Type of a time interval for a periodically running job.
          nullable: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365PeriodicallyEvery
        dailyType:
          enum:
            - Unknown
            - Everyday
            - Workdays
            - Weekends
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
            - Sunday
          type: string
          description: Days when the daily job runs.
          nullable: true
          x-extensible-enum: true
          x-ms-enum:
            name: Vb365DailyType
        scheduleEnabled:
          type: boolean
          description: Indicates whether a job schedule is enabled.
          default: false
        backupWindowEnabled:
          type: boolean
          description: Indicates whether backup window is enabled.
          default: false
        backupWindowSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365BackupWindowSettings'
          description: Backup window settings.
          nullable: true
        periodicallyWindowSettings:
          type: object
          allOf:
            - $ref: '#/components/schemas/Vb365BackupWindowSettings'
          description: Backup window settings for periodically running jobs.
          nullable: true
        periodicallyWindowEnabled:
          type: boolean
          description: Indicates whether backup window is enabled for periodically running jobs.
          nullable: true
        periodicallyOffsetMinutes:
          maximum: 59
          minimum: 0
          type: integer
          description: Number of minutes that must be skipped after specified job starting time.
          format: int32
          default: 0
          nullable: true
        dailyTime:
          type: string
          description: Time of day when job must start in the `hh:mm` format.
          format: time-of-day
          nullable: true
        retryEnabled:
          type: boolean
          description: Indicates whether job retry is enabled.
          default: false
        retryNumber:
          minimum: 1
          type: integer
          description: Number of allowed retries.
          format: int32
          nullable: true
        retryWaitInterval:
          type: integer
          description: Time interval between job retries.
          format: int32
          nullable: true
    Vb365BackupWindowSettings:
      required:
        - backupWindow
      type: object
      properties:
        backupWindow:
          maxItems: 168
          minItems: 168
          type: array
          items:
            type: boolean
          description: "Defines an hourly scheme for the backup window. The scheduling scheme consists of 168 boolean elements. \nThese elements can be logically divided into 7 groups by 24. Each group represents a day of the week starting from Sunday. \nEach element represents a backup hours: `true` — backup is allowed, `false` — backup is not allowed.\n"
        minuteOffset:
          maximum: 59
          minimum: 0
          type: integer
          description: Number of minutes that must be skipped after specified job starting time.
          format: int32
          nullable: true
    Vb365ProtectedObjectType:
      enum:
        - Unknown
        - User
        - Group
        - Teams
        - Site
      type: string
      description: Type of a protected object.
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: Vb365ProtectedObjectType
    Vb365ProtectedObject:
      type: object
      properties:
        id:
          type: string
          description: ID assigned to an object protected by Veeam Backup for Microsoft 365.
          readOnly: true
        name:
          type: string
          description: Name of an object protected by Veeam Backup for Microsoft 365.
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
          readOnly: true
        repositoryName:
          type: string
          description: Name Of a backup repository.
          readOnly: true
        archiveRepositoryUid:
          type: string
          description: UID assigned to an archive repository.
          format: uuid
          nullable: true
          readOnly: true
        archiveRepositoryName:
          type: string
          description: Name an archive repository.
          nullable: true
          readOnly: true
        protectedDataType:
          $ref: '#/components/schemas/Vb365ProtectedObjectType'
        restorePointsCount:
          type: integer
          description: Number of restore points created for an object protected by Veeam Backup for Microsoft 365.
          format: int32
          readOnly: true
        archiveRestorePointsCount:
          type: integer
          description: Number of archive restore points created for an object protected by Veeam Backup for Microsoft 365.
          format: int32
          readOnly: true
        latestRestorePointDate:
          type: string
          description: Date and time when the latest restore point was created for an object protected by Veeam Backup for Microsoft 365.
          format: date-time
          readOnly: true
        vb365ServerUid:
          type: string
          description: UID assigned to a Veeam Backup for Microsoft 365 server.
          format: uuid
          readOnly: true
        vb365ServerName:
          type: string
          description: Name of a Veeam Backup for Microsoft 365 server.
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization to which a Veeam Backup for Microsoft 365 server belongs.
          format: uuid
          nullable: true
          readOnly: true
        organizationName:
          type: string
          description: Name of an organization to which a Veeam Backup for Microsoft 365 server belongs.
          nullable: true
          readOnly: true
        vb365OrganizationUid:
          type: string
          description: UID assigned to a Microsoft organization.
          format: uuid
          nullable: true
          readOnly: true
        vb365OrganizationName:
          type: string
          description: Name of a Microsoft organization.
          nullable: true
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site on which an organization that owns a Veeam backup agent protecting an object is registered.
          format: uuid
          nullable: true
          readOnly: true
        siteName:
          type: string
          description: Name of a Veeam Cloud Connect site on which an organization that owns Veeam backup agent protecting an object is registered.
          nullable: true
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a location assigned to Veeam backup agent protecting an object.
          format: uuid
          nullable: true
          readOnly: true
        locationName:
          type: string
          description: Name of a location assigned to a Veeam backup agent protecting an object.
          nullable: true
          readOnly: true
        consumesLicense:
          type: boolean
          description: Indicates whether a protected object consumes license units.
          nullable: true
          readOnly: true
        isEducationalUser:
          type: boolean
          description: Indicates whether a protected user has Microsoft 365 educational subscription.
          nullable: true
          readOnly: true
        fileRestorePortalUrl:
          type: string
          description: URL of a file restore portal.
          nullable: true
          readOnly: true
        isFileRestorePortalEnabled:
          type: boolean
          description: Indicates whether a file restore portal is enabled.
          readOnly: true
    Vb365RestorePoint:
      type: object
      properties:
        id:
          type: string
          description: ID assigned to a restore point.
          format: uuid
          readOnly: true
        protectedObjectId:
          type: string
          description: ID assigned to an object protected by Veeam Backup for Microsoft 365.
          format: uuid
          readOnly: true
        vb365JobUid:
          type: string
          description: UID assigned to a backup job.
          format: uuid
          readOnly: true
        repositoryUid:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
          readOnly: true
        repositoryName:
          type: string
          description: Name of a backup repository.
          readOnly: true
        backupTime:
          type: string
          description: Date and time when a restore point was created.
          format: date-time
          readOnly: true
        isArchive:
          type: boolean
          description: Indicates whether restore point is archive.
          readOnly: true
        processedObjectTypes:
          minItems: 1
          uniqueItems: true
          type: array
          items:
            minItems: 1
            enum:
              - Unknown
              - Mailbox
              - Archive
              - Site
              - OneDrive
              - Team
            type: string
            x-extensible-enum: true
            x-ms-enum:
              name: Vb365RestorePointProcessedObjectType
          description: Array of protected object types.
          nullable: true
        processedObjectTypesStr:
          type: string
          description: String representation of protected object type array.
          readOnly: true
    PulseConfiguration:
      required:
        - isCompanyMappingEnabled
        - isLicenseManagementEnabled
        - isPushingNewCompaniesToPulseEnabled
      type: object
      properties:
        token:
          type: string
          description: VCSP Pulse authentication token.
          format: password
          nullable: true
          writeOnly: true
        status:
          enum:
            - Unknown
            - NotConfigured
            - Configured
            - Warning
            - Error
          type: string
          description: Status of VCSP Pulse configuration.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: PulseConfigurationStatus
        statusMessage:
          type: string
          description: Status message.
          readOnly: true
        isCompanyMappingEnabled:
          type: boolean
          description: Indicates whether company management in VCSP Pulse is enabled.
        isLicenseManagementEnabled:
          type: boolean
          description: Indicates whether license management in VCSP Pulse is enabled.
        isPushingNewCompaniesToPulseEnabled:
          type: boolean
          description: Indicates whether a VCSP Pulse tenant must be created for each new company.
        lastUpdateDate:
          type: string
          description: Date of the last VCSP Pulse integration update.
          format: date-time
          nullable: true
          readOnly: true
        tokenExpirationDate:
          type: string
          description: Date when the VCSP Pulse Portal connection token expires.
          format: date-time
          nullable: true
          readOnly: true
    PulseLicenseContract:
      type: object
      properties:
        contractId:
          type: string
          description: ID assigned to a rental agreement contract.
          readOnly: true
        expirationDate:
          type: string
          description: Date of rental agreement contract expiration.
          format: date-time
          readOnly: true
        pointsLimit:
          type: number
          description: Maximum number of license points that can be consumed according to rental agreement contract.
          format: float
          nullable: true
          readOnly: true
        automaticExtensionAlwaysOn:
          type: boolean
          description: Indicates whether rental agreement contract must be automatically updated.
          readOnly: true
    PulseLicenseProduct:
      type: object
      properties:
        productId:
          type: string
          description: ID assigned to a licensed Veeam product.
          readOnly: true
        name:
          type: string
          description: Name of a licensed Veeam product.
          readOnly: true
        edition:
          type: string
          description: Edition of a licensed Veeam product.
          readOnly: true
        version:
          type: string
          description: Version of a licensed Veeam product.
          readOnly: true
        workloads:
          type: array
          items:
            $ref: '#/components/schemas/PulseLicenseProductWorkload'
          description: Array of Veeam product workloads included in the VCSP Pulse license.
          readOnly: true
    PulseLicenseProductWorkload:
      type: object
      properties:
        workloadId:
          type: string
          description: ID addigned to a workload.
          readOnly: true
        name:
          type: string
          description: Name of a workload.
          readOnly: true
        multiplier:
          type: number
          description: License unit multiplier for the workload type.
          format: double
          readOnly: true
    PulseLicense:
      required:
        - instanceUid
        - type
        - assignStatus
        - usageType
        - contractId
        - productId
        - points
        - automaticReportingStatus
        - workloads
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a VCSP Pulse license.
          format: uuid
          readOnly: true
        licenseId:
          type: string
          description: ID assigned to a VCSP Pulse license in SalesForce.
          format: uuid
          nullable: true
          readOnly: true
        type:
          enum:
            - Unknown
            - Rental
            - Internal
            - REMOVED_1
          type: string
          description: Type of a VCSP Pulse license.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: PulseLicenseType
        assignStatus:
          enum:
            - Unknown
            - Assigned
            - Assigning
            - FailedToAssign
            - Revoking
            - FailedToRevoke
            - NotAssigned
            - Editing
            - FailedToEdit
          type: string
          description: Status of VCSP Pulse license assignement.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: PulseLicenseAssignStatus
        usageType:
          enum:
            - Unknown
            - SingleCustomerUse
            - MultiCustomerUse
            - InternalUse
          type: string
          description: Type of VCSP Pulse license usage.
          x-extensible-enum: true
          x-ms-enum:
            name: PulseLicenseUsageType
        contractId:
          type: string
          description: ID assigned to a rental agreement contract.
          nullable: true
          readOnly: true
        createdBy:
          type: string
          description: Name of an organization that created VCSP Pulse license.
          nullable: true
          readOnly: true
        productId:
          type: string
          description: ID asigned to a Veeam product that requires a license.
          readOnly: true
        description:
          type: string
          description: Description of a VCSP Pulse license.
          nullable: true
          readOnly: true
        expirationDate:
          type: string
          description: Date of the VCSP Pulse license expiration.
          format: date-time
          nullable: true
        points:
          type: number
          description: Number of license points.
          format: double
          readOnly: true
        automaticExtensionStatus:
          enum:
            - Unknown
            - Off
            - On
            - AlwaysOn
            - AlwaysOff
            - SwitchingToOn
            - SwitchingToOff
          type: string
          description: Status of the VCSP Pulse license automatic update.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: PulseLicenseAutomaticExtensionStatus
        automaticReportingStatus:
          enum:
            - Unknown
            - Off
            - On
            - AlwaysOn
            - AlwaysOff
            - SwitchingToOn
            - SwitchingToOff
          type: string
          description: Status of the automatic license reporting.
          x-extensible-enum: true
          x-ms-enum:
            name: PulseLicenseAutomaticReportingStatus
        assignedCompanyUid:
          type: string
          description: UID of a company to which a VCSP Pulse license is assigned.
          format: uuid
          nullable: true
        assignedResellerUid:
          type: string
          description: UID of a reseller to which a VCSP Pulse license is assigned.
          format: uuid
          nullable: true
        workloads:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/PulseLicenseWorkload'
          description: Array of licensed workloads.
    PulseLicenseWorkload:
      required:
        - workloadId
        - count
      type: object
      properties:
        workloadId:
          type: string
          description: ID assigned to a workload type.
        name:
          type: string
          description: Name of a workload.
          readOnly: true
        multiplier:
          type: number
          description: License unit multiplier for the workload type.
          format: double
          readOnly: true
        count:
          maximum: 100000
          minimum: 1
          type: integer
          description: Number of objects.
          format: int32
    PulseLicenseInput:
      required:
        - productId
        - contractId
        - expirationDate
        - workloads
      type: object
      properties:
        productId:
          type: string
          description: ID asigned to a Veeam product that requires a license.
        contractId:
          type: string
          description: ID assigned to a rental agreement contract.
        description:
          type: string
          description: Description of a VCSP Pulse license.
          nullable: true
        expirationDate:
          type: string
          description: Date of the VCSP Pulse license expiration.
          format: date-time
        type:
          enum:
            - Unknown
            - Rental
            - Internal
            - REMOVED_1
          type: string
          description: Type of a VCSP Pulse license.
          default: Rental
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: PulseLicenseType
        isAutomaticReportingEnabled:
          type: boolean
          description: Defines whether automatic license reporting is enabled.
          default: false
        workloads:
          minItems: 1
          type: array
          items:
            $ref: '#/components/schemas/PulseLicenseWorkloadInput'
          description: Array of workloads that must be licensed.
    PulseLicenseWorkloadInput:
      required:
        - workloadId
        - count
      type: object
      properties:
        workloadId:
          type: string
          description: ID assigned to a workload type.
        count:
          maximum: 100000
          minimum: 1
          type: integer
          description: Number of objects.
          format: int32
    PulseTenant:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a VCSP Pulse tenant.
          readOnly: true
        mappingStatus:
          enum:
            - Unknown
            - NotMapped
            - Mapped
            - MappingInProggress
            - FailedToMap
          type: string
          description: Mapping status of a VCSP Pulse tenant.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: PulseTenantMappingStatus
        mappingStatusMessage:
          type: string
          description: Message for mapping status of a VCSP Pulse tenant.
          readOnly: true
        name:
          type: string
          description: Name of a VCSP Pulse tenant.
          readOnly: true
        mappedMasterOrganizationUid:
          type: string
          description: UID assigned to a master organization mapped to a VCSP Pulse tenant.
          format: uuid
          nullable: true
        mergedOrganizationUids:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to organizations merged with a master organization.
          readOnly: true
    CloudTenantProductVersionInfo:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam product.
          format: uuid
          readOnly: true
        productType:
          enum:
            - Unknown
            - VBR
          type: string
          description: Veeam product type.
          readOnly: true
          x-extensible-enum: true
          x-ms-enum:
            name: CloudTenantProductVersionInfoProductType
        version:
          type: string
          description: Version of a Veeam product.
          nullable: true
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site managing a tenant that uses a Veeam product.
          format: uuid
          readOnly: true
        companyUid:
          type: string
          description: UID assigned to a company associated with a tenant that uses a Veeam product.
          format: uuid
          readOnly: true
        tenantUid:
          type: string
          description: UID assigned to a tenant that uses a Veeam product.
          format: uuid
          readOnly: true
        isVersionInfoAvailable:
          type: boolean
          description: Indicates whether information on Veeam product version is available.
          readOnly: true
    Warnings:
      type: array
      items:
        $ref: '#/components/schemas/Warning'
      nullable: true
      readOnly: true
    Warning:
      type: object
      properties:
        message:
          type: string
          description: Warning message.
          readOnly: true
      readOnly: true
    ScheduledDeployTaskResponse:
      required:
        - taskUid
        - scheduledTaskUid
      type: object
      properties:
        scheduledTaskUid:
          type: string
          description: UID assigned to a scheduled task.
          format: uuid
          readOnly: true
        taskUid:
          type: string
          description: UID will be assigned to a deployment task when it has been be started.
          format: uuid
          readOnly: true
    DeploySchedule:
      required:
        - dateTime
      type: object
      properties:
        dateTime:
          type: string
          description: Date and time when the deployment must start.
          format: date-time
    ScheduledComputerDeploymentTask:
      required:
        - dateTime
      type: object
      properties:
        taskUid:
          type: string
          description: UID assigned to a scheduled deployment task.
          format: uuid
          readOnly: true
        dateTime:
          type: string
          description: Date and time when the scheduled deployment must start.
          format: date-time
        taskType:
          $ref: '#/components/schemas/ScheduledDeploymentTaskType'
    ScheduledManagementAgentDeploymentTask:
      required:
        - dateTime
      type: object
      properties:
        taskUid:
          type: string
          description: UID assigned to a scheduled deployment task.
          format: uuid
          readOnly: true
        dateTime:
          type: string
          description: Date and time when the scheduled deployment must start.
          format: date-time
        taskType:
          $ref: '#/components/schemas/ScheduledDeploymentTaskType'
    ScheduledDeploymentTaskType:
      enum:
        - unknown
        - patchVbr
        - upgradeVbr
        - deployVbr
      type: string
      description: Type of a scheduled deployment task.
      readOnly: true
      x-extensible-enum: true
      x-ms-enum:
        name: ScheduledDeploymentTaskType
    LocalUserRuleInput:
      required:
        - sid
        - name
        - scope
        - contextType
        - type
        - mfaPolicyStatus
      type: object
      properties:
        sid:
          type: string
          description: SID of a user or group.
        name:
          type: string
          description: Name of a user or group.
        description:
          type: string
          description: Description of a user or group.
          nullable: true
        enabled:
          type: boolean
          description: Indicates whether a user or group is enabled.
          default: true
        roleType:
          $ref: '#/components/schemas/LocalUserRuleRoleType'
        contextType:
          $ref: '#/components/schemas/WinContextType'
        scope:
          type: array
          items:
            $ref: '#/components/schemas/LocalUserRuleObject'
          description: Array of services available to a user or group.
        type:
          $ref: '#/components/schemas/LocalUserRuleTypeReadOnly'
        mfaPolicyStatus:
          $ref: '#/components/schemas/LocalUserRuleMfaPolicyStatus'
        hasAccessToProvider:
          type: boolean
          nullable: true
    LocalUserRule:
      required:
        - name
        - description
        - scope
        - roleType
        - type
        - contextType
        - mfaPolicyStatus
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a user or group.
          format: uuid
          readOnly: true
        sid:
          type: string
          description: SID assigned to a user or group.
          readOnly: true
        name:
          type: string
          description: Name of a user or group.
        description:
          type: string
          description: Description of a user or group.
          nullable: true
        enabled:
          type: boolean
          description: Indicates whether a user or group is enabled.
          default: true
        roleType:
          $ref: '#/components/schemas/LocalUserRuleRoleType'
        contextType:
          $ref: '#/components/schemas/WinContextType'
        scope:
          type: array
          items:
            $ref: '#/components/schemas/LocalUserRuleObject'
          description: Array of services available to a user or group.
        type:
          $ref: '#/components/schemas/LocalUserRuleType'
        mfaPolicyStatus:
          $ref: '#/components/schemas/LocalUserRuleMfaPolicyStatus'
        hasAccessToProvider:
          type: boolean
          nullable: true
    LocalUserRuleDiscoveryItem:
      type: object
      properties:
        sid:
          type: string
          description: SID assigned to a user or group.
          readOnly: true
        name:
          type: string
          description: Name of a user or group.
          readOnly: true
        displayName:
          type: string
          description: Display name of a user or group.
          readOnly: true
        description:
          type: string
          description: Description of a user or group.
          readOnly: true
        type:
          $ref: '#/components/schemas/LocalUserRuleType'
        contextType:
          $ref: '#/components/schemas/WinContextType'
    WinContextType:
      enum:
        - machine
        - domain
        - applicationDirectory
      type: string
      description: Type of a location where an account is stored.
      default: machine
    LocalUserRuleRoleType:
      enum:
        - unknown
        - readonlyOperator
        - operator
        - siteAdministrator
        - portalAdministrator
      type: string
      description: Role of a user or group users.
      default: portalAdministrator
    LocalUserRuleObject:
      required:
        - accessType
        - type
      type: object
      properties:
        type:
          $ref: '#/components/schemas/LocalUserRuleObjectType'
        objectUid:
          type: string
          description: UID assigned to a Company/CloudConnectAgent. Reference is depended on type
          format: uuid
          nullable: true
    LocalUserRuleObjectType:
      enum:
        - company
        - cloudConnect
        - all
      type: string
      description: Type of an account.
      default: all
    LocalUserRuleType:
      enum:
        - winNTUser
        - winNTGroup
      type: string
      description: Type of a user or group.
      default: winNTUser
      x-ms-enum:
        name: LocalUserRuleType
    LocalUserRuleTypeReadOnly:
      enum:
        - winNTUser
        - winNTGroup
      type: string
      description: Type of a user or group.
      default: winNTUser
      readOnly: true
      x-ms-enum:
        name: LocalUserRuleType
    LocalUserRuleMfaPolicyStatus:
      enum:
        - disabled
        - enabled
      type: string
      description: Status of MFA configuration requirement for a user or group.
    EAzureEnvironmentId:
      enum:
        - Global
        - Germany
        - China
        - UsGovernment
      type: string
      description: Type of a Microsoft Azure cloud environment.
      x-ms-enum:
        name: EAzureEnvironmentId
    EAzureEnvironmentIdReadonly:
      enum:
        - Global
        - Germany
        - China
        - UsGovernment
      type: string
      description: Type of a Microsoft Azure cloud environment.
      readOnly: true
      x-ms-enum:
        name: EAzureEnvironmentId
    EAzureAccountEnvironmentId:
      enum:
        - Global
        - China
        - UsGovernment
      type: string
      description: Type of a Microsoft Azure cloud environment.
      x-ms-enum:
        name: EAzureAccountEnvironmentId
    EAzureAccountEnvironmentIdReadonly:
      enum:
        - Global
        - China
        - UsGovernment
      type: string
      description: Type of a Microsoft Azure cloud environment.
      readOnly: true
      x-ms-enum:
        name: EAzureAccountEnvironmentId
    PublicCloudAzureAddExistingApplianceInput:
      required:
        - account
        - virtualMachine
        - guestOsCredentials
      type: object
      properties:
        account:
          required:
            - accountUid
            - subscriptionId
            - dataCenterId
            - environment
            - connectionUid
          type: object
          properties:
            accountUid:
              type: string
              description: UID assigned to an account in Microsoft Azure.
              format: uuid
            subscriptionId:
              type: string
              description: ID assigned to a Microsoft Azure connection.
            dataCenterId:
              type: string
              description: ID assigned to a Microsoft Azure datacenter.
            connectionUid:
              type: string
              description: UID assigned to a Microsoft Azure connection.
              format: uuid
            environment:
              $ref: '#/components/schemas/EAzureEnvironmentId'
        virtualMachine:
          required:
            - virtualMachineId
          type: object
          properties:
            virtualMachineId:
              type: string
              description: ID assigned to a VM.
            description:
              maxLength: 250
              type: string
              description: Description of a VM.
              nullable: true
        network:
          type: object
          properties:
            privateNetworkAddress:
              maxLength: 1024
              type: string
              description: Private IP address or DNS name of a network.
              nullable: true
          nullable: true
        guestOsCredentials:
          required:
            - guestOsCredentialsUid
          type: object
          properties:
            guestOsCredentialsUid:
              type: string
              description: UID assigned to guest OS credentials record.
              format: uuid
    PublicCloudAwsAccount:
      required:
        - accessKey
      type: object
      properties:
        accountUid:
          type: string
          description: UID assigned to an AWS account.
          format: uuid
          readOnly: true
        credentialTag:
          type: string
          description: UID assigned to an account in AWS.
          format: uuid
          readOnly: true
        accessKey:
          maxLength: 255
          minLength: 1
          type: string
          description: AWS access key.
        secretKey:
          maxLength: 1024
          minLength: 1
          type: string
          description: AWS access secret key.
          format: password
          nullable: true
        description:
          maxLength: 250
          type: string
          description: Description of an AWS account.
          nullable: true
        createdBy:
          type: string
          description: Name of a user that created an AWS account.
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site on which an AWS account is registered.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization associated with an AWS account.
          format: uuid
          readOnly: true
        appliances:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to associated Veeam Backup for Public Clouds appliances.
          nullable: true
          readOnly: true
    PublicCloudGrantPermissionsForMigrationInput:
      required:
        - accessKey
        - secretKey
      type: object
      properties:
        accessKey:
          type: string
          description: AWS access key.
        secretKey:
          type: string
          description: AWS access secret key.
          format: password
    PublicCloudAwsAccountInput:
      required:
        - accessKey
        - secretKey
      type: object
      properties:
        accessKey:
          maxLength: 255
          minLength: 1
          type: string
          description: AWS access key.
        secretKey:
          maxLength: 1024
          minLength: 1
          type: string
          description: AWS access secret key.
          format: password
        description:
          maxLength: 250
          type: string
          description: Description of an account.
          nullable: true
    PublicCloudAwsDataCenter:
      type: object
      properties:
        dataCenterId:
          type: string
          description: ID assigned to an AWS datacenter.
          readOnly: true
        dataCenterName:
          type: string
          description: Name of an AWS datacenter.
          readOnly: true
    PublicCloudAwsConnection:
      type: object
      properties:
        connectionUid:
          type: string
          description: UID assigned to an Amazon connection.
          format: uuid
          readOnly: true
    PublicCloudAwsAddExistingApplianceInput:
      required:
        - account
        - virtualMachine
        - guestOsCredentials
      type: object
      properties:
        account:
          required:
            - connectionUid
            - dataCenterId
            - regionId
            - accountUid
          type: object
          properties:
            connectionUid:
              type: string
              description: UID assigned to an Amazon connection.
              format: uuid
            dataCenterId:
              type: string
              description: ID assigned to an AWS datacenter.
            regionId:
              type: string
              description: ID assigned to an AWS region.
            accountUid:
              type: string
              description: UID assigned to an account in AWS.
              format: uuid
        virtualMachine:
          required:
            - virtualMachineId
          type: object
          properties:
            virtualMachineId:
              type: string
              description: ID assigned to a EC2 instance where Veeam Backup for Public Clouds appliance is deployed.
            description:
              maxLength: 250
              type: string
              description: Description of a EC2 instance.
              nullable: true
        network:
          type: object
          properties:
            privateNetworkAddress:
              maxLength: 1024
              type: string
              description: Private IP address or DNS name of a network.
              nullable: true
          nullable: true
        guestOsCredentials:
          required:
            - guestOsCredentialsUid
          type: object
          properties:
            guestOsCredentialsUid:
              type: string
              description: UID assigned to guest OS credentials record.
              format: uuid
            certificateThumbprint:
              type: string
              description: Thumbprint of a Veeam Backup for Public Clouds appliance security certificate.
              nullable: true
    PublicCloudAwsNewApplianceInput:
      required:
        - account
        - virtualMachine
        - ipAddress
        - guestOsCredentials
      type: object
      properties:
        account:
          required:
            - connectionUid
            - accountUid
            - regionId
            - dataCenterId
          type: object
          properties:
            connectionUid:
              type: string
              description: UID assigned to an AWS connection.
              format: uuid
            accountUid:
              type: string
              description: UID assigned to an account in AWS.
              format: uuid
            dataCenterId:
              type: string
              description: ID assigned to an AWS datacenter.
            regionId:
              type: string
              description: ID assigned to an AWS region.
        virtualMachine:
          required:
            - virtualMachineName
          type: object
          properties:
            virtualMachineName:
              maxLength: 125
              minLength: 1
              type: string
              description: Name of a EC2 instance where Veeam Backup for Public Clouds appliance will be deployed.
            description:
              maxLength: 250
              type: string
              description: Description of a VM.
              nullable: true
        network:
          required:
            - networkId
            - subnetId
          type: object
          properties:
            networkId:
              type: string
              description: ID assigned to a network.
            subnetId:
              type: string
              description: ID assigned to a subnet.
            securityGroupId:
              type: string
              description: ID assigned to a protection group. Specify the `null` value to create a new security group.
              nullable: true
          description: "Veeam Backup for Public Clouds appliance network resources.\n>If you send the `null` value, all required resources will be created automatically.'\n"
          nullable: true
        ipAddress:
          required:
            - backupServerIpAddresses
            - applianceIp
          type: object
          properties:
            applianceIp:
              properties:
                applianceIpAddressId:
                  type: string
                  description: Veeam Backup for Public Clouds appliance elastic IP address.
                  nullable: true
                newIpAddressType:
                  enum:
                    - dynamic
                    - static
                  type: string
                  description: Type of a new IP address that must be generated automatically.
                  nullable: true
              description: "Veeam Backup for Public Clouds appliance IP address.\n> Send only one of the following properties.\n"
            backupServerIpAddresses:
              maxLength: 48
              minLength: 1
              type: string
              description: Array of IP addresses of a Veeam Cloud Connect site.
        guestOsCredentials:
          required:
            - keyPairName
            - guestOsCredentialsUid
            - timeZoneId
          type: object
          properties:
            guestOsCredentialsUid:
              type: string
              description: UID assigned to guest OS credentials record.
              format: uuid
            keyPairName:
              type: string
              description: Name of a key pair.
            timeZoneId:
              type: string
              description: ID assigned to a time zone.
    PublicCloudAzureAppliance:
      required:
        - guestOsCredentialsUid
        - accountUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to management agent installed on a server where Veeam Backup for Public Clouds appliance is deployed.
          format: uuid
          readOnly: true
        guestOsCredentialsUid:
          type: string
          description: UID assigned to guest OS credentials record.
          format: uuid
        accountUid:
          type: string
          description: UID assigned to an account in Microsoft Azure.
          format: uuid
        environment:
          $ref: '#/components/schemas/EAzureEnvironmentIdReadonly'
        subscriptionId:
          type: string
          description: ID assigned to a Microsoft Azure subscription.
          readOnly: true
        tenantId:
          type: string
          description: ID assigned to a tenant available to a Microsoft Azure account.
          readOnly: true
        description:
          maxLength: 250
          type: string
          description: Description of a Veeam Backup for Public Clouds appliance.
          nullable: true
        publicAddress:
          type: string
          description: URL of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        privateNetworkAddress:
          maxLength: 1024
          type: string
          description: Private IP address or DNS name of a network.
          nullable: true
        virtualMachineId:
          type: string
          description: ID assigned to a VM.
          readOnly: true
        certificateThumbprint:
          type: string
          description: Thumbprint of a security certificate.
          readOnly: true
        dataCenterId:
          type: string
          description: ID assigned to a Microsoft Azure datacenter
          readOnly: true
    PublicCloudAwsAppliance:
      required:
        - accountUid
        - guestOsCredentialsUid
      type: object
      properties:
        managementAgentUid:
          type: string
          description: UID assigned to management agent installed on a server where Veeam Backup for Public Clouds appliance is deployed.
          format: uuid
          readOnly: true
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          readOnly: true
        accountUid:
          type: string
          description: UID assigned to an AWS account used to access a Veeam Backup for Public Clouds appliance.
          format: uuid
        description:
          maxLength: 250
          type: string
          description: Description of a Veeam Backup for Public Clouds appliance.
          nullable: true
        publicAddress:
          type: string
          description: URL of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        privateNetworkAddress:
          maxLength: 1024
          type: string
          description: Private IP address or DNS name of a network.
          nullable: true
        guestOsCredentialsUid:
          type: string
          description: UID assigned to guest OS credentials record.
          format: uuid
        certificateThumbprint:
          type: string
          description: Thumbprint of a security certificate.
          readOnly: true
        dataCenterId:
          type: string
          description: ID assigned to an AWS datacenter.
          readOnly: true
        regionId:
          type: string
          description: ID assigned to an AWS region.
          readOnly: true
        resourceId:
          type: string
          description: ID assigned to an AWS network resource.
          readOnly: true
    PublicCloudAwsVirtualMachine:
      type: object
      properties:
        virtualMachineId:
          type: string
          description: ID assigned to an EC2 instance.
          readOnly: true
        virtualMachineName:
          type: string
          description: Name of an EC2 instance.
          readOnly: true
    PublicCloudAwsKey:
      type: object
      properties:
        keyPairName:
          type: string
          description: Name of a key pair.
          readOnly: true
    PublicCloudAwsNetwork:
      type: object
      properties:
        networkId:
          type: string
          description: ID assigned to a network.
          readOnly: true
        networkName:
          type: string
          description: Name of a network.
          readOnly: true
    PublicCloudAwsKeyPairInput:
      required:
        - connectionUid
        - name
      type: object
      properties:
        connectionUid:
          type: string
          description: UID assigned to an Amazon connection.
          format: uuid
        name:
          type: string
          description: Name of an EC2 key pair.
    PublicCloudAwsNewKeyPair:
      required:
        - keyPairName
        - privateKey
        - fileName
      type: object
      properties:
        keyPairName:
          type: string
          description: Name of a key pair.
        privateKey:
          type: string
          description: Private key.
        fileName:
          type: string
          description: Name of a file containing key.
    PublicCloudAwsRegion:
      type: object
      properties:
        regionId:
          type: string
          description: ID assigned to an AWS region.
          readOnly: true
        regionName:
          type: string
          description: Name of an AWS region.
          readOnly: true
    PublicCloudRepository:
      required:
        - instanceUid
        - repositoryName
        - description
        - platform
        - applianceName
        - applianceUid
        - bucket
        - folder
        - region
        - storageClass
        - organizationName
        - organizationUid
        - siteName
        - siteUid
        - creatingState
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a public cloud repository.
        repositoryName:
          type: string
          description: Name of a public cloud repository.
        description:
          type: string
          description: Description of a public cloud repository.
        platform:
          type: string
          description: Platform of a public cloud repository.
        applianceName:
          type: string
          description: Name of a Veeam Backup for Public Clouds appliance to which a repository belongs.
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance to which a repository belongs.
          format: uuid
        bucket:
          type: string
          description: Name of an Amazon S3 bucket or Microsoft Azure container that is used as a backup target.
        folder:
          type: string
          description: Name of a folder used to group backup files in a bucket or container.
        region:
          type: string
          description: Name of a Veeam Backup for Public Clouds appliance region.
        storageClass:
          type: string
          description: Repository storage class.
        isEncrypted:
          type: boolean
          description: Indicates whether stored data encryption is enabled.
          nullable: true
        immutabilityEnabled:
          type: boolean
          description: Indicates whether immutability is enabled.
          nullable: true
        organizationName:
          type: string
          description: Name of an organization to which a Veeam Backup for Public Clouds appliance belongs.
        organizationUid:
          type: string
          description: UID assigned to an organization to which a Veeam Backup for Public Clouds appliance belongs.
          format: uuid
        siteName:
          type: string
          description: Name of a Veeam Cloud Connect site.
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
        creatingState:
          $ref: '#/components/schemas/CreatingObjectInfo'
    CreatingObjectInfo:
      type: object
      properties:
        state:
          $ref: '#/components/schemas/EPublicCloudObjectCreatingState'
        message:
          type: string
          description: Status message.
          readOnly: true
      description: Status of a repository creation.
      nullable: true
    EPublicCloudObjectCreatingState:
      enum:
        - None
        - Creating
        - Failed
      type: string
      description: Status of object creation.
      readOnly: true
    PublicCloudAwsSecurityGroup:
      type: object
      properties:
        securityGroupId:
          type: string
          description: ID assigned to a security group.
          readOnly: true
        securityGroupName:
          type: string
          description: Name of a security group.
          readOnly: true
    PublicCloudAwsSubnet:
      type: object
      properties:
        subnetId:
          type: string
          description: ID assigned to a subnet.
          readOnly: true
        subnetName:
          type: string
          description: AWS name of a subnet.
          readOnly: true
        range:
          type: string
          description: Range of IP addresses present in a subnet.
          readOnly: true
        displayName:
          type: string
          description: Display name of a subnet.
          readOnly: true
    PublicCloudAzureKeyPairInput:
      required:
        - connectionUid
        - keyPairName
        - subscriptionId
        - dataCenterId
        - resourceGroupName
      type: object
      properties:
        connectionUid:
          type: string
          description: UID assigned to a Microsoft Azure connection.
          format: uuid
        subscriptionId:
          type: string
          description: ID assigned to a Microsoft Azure subscription.
        dataCenterId:
          type: string
          description: ID assigned to a Microsoft Azure datacenter.
        resourceGroupName:
          type: string
          description: Name of a resource group.
        keyPairName:
          type: string
          description: Name of a key pair.
    PublicCloudAzureKey:
      type: object
      properties:
        keyPairName:
          type: string
          description: Name of a key pair.
          readOnly: true
    PublicCloudAzureNewApplianceInput:
      required:
        - account
        - virtualMachine
        - ipAddress
        - guestOsCredentials
      type: object
      properties:
        account:
          required:
            - connectionUid
            - environment
            - resourceGroupName
            - subscriptionId
            - dataCenterId
            - accountUid
          type: object
          properties:
            connectionUid:
              type: string
              description: UID assigned to a Microsoft Azure connection.
              format: uuid
            environment:
              $ref: '#/components/schemas/EAzureEnvironmentId'
            resourceGroupName:
              type: string
              description: Name of a resource group.
            subscriptionId:
              type: string
              description: ID assigned to a Microsoft Azure subscription.
            dataCenterId:
              type: string
              description: ID assigned to a Microsoft Azure datacenter.
            accountUid:
              type: string
              description: UID assigned to an account in Microsoft Azure.
              format: uuid
        virtualMachine:
          required:
            - virtualMachineName
          type: object
          properties:
            virtualMachineName:
              maxLength: 125
              minLength: 1
              type: string
              description: Name of a VM.
            description:
              maxLength: 250
              type: string
              description: Description of a VM.
              nullable: true
        network:
          required:
            - networkId
            - subnetName
          type: object
          properties:
            networkId:
              type: string
              description: ID assigned to a network.
            subnetName:
              type: string
              description: Name of a subnet.
            securityGroupId:
              type: string
              description: ID assigned to a security group. Send the `null` value to create a new security group.
              nullable: true
          description: "Veeam Backup for Public Clouds appliance network resources.\n>If you send the `null` value, all required resources will be created automatically.\n"
          nullable: true
        ipAddress:
          required:
            - applianceIp
            - backupServerIpAddresses
          type: object
          properties:
            backupServerIpAddresses:
              maxLength: 48
              minLength: 1
              type: string
              description: Array of IP addresses of a Veeam Cloud Connect site.
            applianceIp:
              properties:
                applianceIpAddressId:
                  type: string
                  description: Veeam Backup for Public Clouds appliance elastic IP address.
                  nullable: true
                newIpAddressType:
                  enum:
                    - dynamic
                    - static
                  type: string
                  description: Type of a new IP address that must be generated automatically.
                  nullable: true
              description: "Veeam Backup for Public Clouds appliance IP address.\n> Send only one of the following properties.\n"
        guestOsCredentials:
          required:
            - guestOsCredentialsUid
            - keyPairName
            - timeZoneId
          type: object
          properties:
            guestOsCredentialsUid:
              type: string
              description: UID assigned to guest OS credentials record.
              format: uuid
            keyPairName:
              type: string
              description: Name of a key pair.
            timeZoneId:
              type: string
              description: ID assigned to a time zone.
    PublicCloudTimeZone:
      type: object
      properties:
        timeZoneId:
          type: string
          description: ID assigned to a time zone.
          readOnly: true
        displayName:
          type: string
          description: Display name of a time zone.
          readOnly: true
        offset:
          type: string
          description: Time zone offset.
          format: time
          readOnly: true
    PublicCloudMapping:
      required:
        - applianceUid
        - companyUid
        - guestOsCredentialsUid
      type: object
      properties:
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
          nullable: true
        guestOsCredentialsUid:
          type: string
          description: UID assigned to guest OS credentials record.
          format: uuid
          nullable: true
    PublicCloudMappingInput:
      required:
        - companyUid
        - guestOsCredentialsUid
      type: object
      properties:
        companyUid:
          type: string
          description: UID assigned to a company.
          format: uuid
        guestOsCredentialsUid:
          type: string
          description: UID assigned to guest OS credentials record.
          format: uuid
    PublicCloudGuestOsCredentials:
      required:
        - password
      type: object
      properties:
        guestOsCredentialsUid:
          type: string
          description: UID assgined to guest OS credentials record.
          format: uuid
          readOnly: true
        role:
          enum:
            - serviceProviderAdministrator
            - companyAdministrator
          type: string
          readOnly: true
        username:
          maxLength: 255
          minLength: 1
          type: string
          description: User name.
          readOnly: true
        description:
          maxLength: 250
          type: string
          description: Description of credentials.
          nullable: true
        password:
          maxLength: 1024
          minLength: 8
          type: string
          description: Password.
          format: password
        organizationUid:
          type: string
          description: UID assigned to an organization to which an account belongs.
          format: uuid
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          nullable: true
          readOnly: true
        appliances:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to Veeam Backup for Public Clouds appliances that can be accessed using the credentials.
          nullable: true
          readOnly: true
        lastChangeTimestamp:
          type: string
          description: Date and time when the latest change was applied to credentials.
          format: date-time
          nullable: true
          readOnly: true
    PublicCloudGuestOsCredentialsInput:
      required:
        - password
        - username
        - role
      type: object
      properties:
        role:
          enum:
            - serviceProviderAdministrator
            - companyAdministrator
          type: string
          description: Role of a user.
        username:
          maxLength: 255
          minLength: 1
          type: string
          description: User name.
        description:
          maxLength: 250
          type: string
          description: Description of a user.
          nullable: true
        password:
          maxLength: 1024
          minLength: 8
          type: string
          description: Password.
          format: password
        siteUid:
          type: string
          description: Veeam Cloud Connect site UID.
          format: uuid
          nullable: true
      description: Potential fail on deploying an appliance because of wrong credentials format.
    PublicCloudAzureDeviceCode:
      type: object
      properties:
        userCode:
          type: string
          description: Verification code used to authenticate to the Azure CLI.
          readOnly: true
        verificationUrl:
          type: string
          description: Redirect URI used to authenticate to the Azure CLI.
          readOnly: true
        deviceCodeToken:
          type: string
          description: Verification code used to start an authentication session.
          readOnly: true
    PublicCloudAzureAccountInput:
      required:
        - accountName
        - environment
        - userCode
      type: object
      properties:
        accountName:
          maxLength: 255
          minLength: 1
          type: string
          description: Name of an account.
        description:
          maxLength: 250
          type: string
          description: Description of an account.
          nullable: true
        environment:
          $ref: '#/components/schemas/EAzureAccountEnvironmentId'
        userCode:
          type: string
          description: User code.
    PublicCloudExistingAzureAccountInput:
      required:
        - accountName
        - environment
        - applicationId
        - tenantId
        - secret
      type: object
      properties:
        accountName:
          maxLength: 255
          minLength: 1
          type: string
          description: Name of a Microsoft Azure account.
        description:
          maxLength: 250
          type: string
          description: Description of a Microsoft Azure account.
          nullable: true
        environment:
          $ref: '#/components/schemas/EAzureAccountEnvironmentId'
        applicationId:
          type: string
          description: ID assigned to a Microsoft Azure application.
        tenantId:
          type: string
          description: ID assigned to a tenant available to a Microsoft Azure account.
        secret:
          type: string
          description: Client secret.
    PublicCloudAzureAccountRenew:
      required:
        - userCode
      type: object
      properties:
        userCode:
          type: string
          description: Verification code used to authenticate to the Azure CLI.
    PublicCloudAzureAccount:
      required:
        - accountName
        - tenantId
        - applicationId
      type: object
      properties:
        accountUid:
          type: string
          description: UID assigned to a Microsoft Azure account.
          format: uuid
          readOnly: true
        credentialTag:
          type: string
          description: UID assigned to an account in Microsoft Azure.
          format: uuid
          readOnly: true
        accountName:
          maxLength: 255
          minLength: 1
          type: string
          description: Name of a Microsoft Azure account.
        description:
          maxLength: 250
          type: string
          description: Description of a Microsoft Azure account.
          nullable: true
        environment:
          $ref: '#/components/schemas/EAzureAccountEnvironmentIdReadonly'
        tenantId:
          type: string
          description: ID assigned to a tenant available to a Microsoft Azure account.
        secret:
          type: string
          description: Client secret.
          nullable: true
        applicationId:
          type: string
          description: ID assigned to a Microsoft Azure application.
        createdBy:
          type: string
          description: Name of a user that created an account.
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization associated with an account.
          format: uuid
          readOnly: true
        appliances:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to Veeam Backup for Public Clouds appliances.
          nullable: true
          readOnly: true
    PublicCloudAppliancePublicAddress:
      type: object
      properties:
        applianceIpAddressId:
          type: string
          description: Elastic IP address.
          readOnly: true
        ipAddress:
          type: string
          description: Public address of a Veeam Backup for Public Clouds appliance.
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Backup for Public Clouds appliance.
          nullable: true
    PublicCloudApplianceDeploymentTask:
      type: object
      properties:
        taskUid:
          type: string
          description: UID assigned to a deployment task.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to management agent installed on server where Veeam Backup for Public Clouds appliance will be deployed.
          format: uuid
          readOnly: true
    PublicCloudApplianceConnectionValidationResult:
      required:
        - errorType
        - certificateThumbprint
      type: object
      properties:
        errorMessage:
          type: string
          description: Error message for failed Veeam Backup for Public Clouds appliance connection.
          readOnly: true
        errorType:
          $ref: '#/components/schemas/PublicCloudApplianceConnectionValidationErrorType'
        certificateThumbprint:
          type: string
          description: Thumbprint of a Veeam Backup for Public Clouds appliance security certificate.
        certificate:
          type: object
          allOf:
            - $ref: '#/components/schemas/Certificate'
          description: Veeam Backup for Public Clouds appliance security certificate.
          readOnly: true
    PublicCloudApplianceConnectionValidationErrorType:
      enum:
        - None
        - Certificate
        - Other
      type: string
      description: Type of a Veeam Backup for Public Clouds appliance connection error.
      x-extensible-enum: true
      x-ms-enum:
        name: PublicCloudApplianceConnectionValidationErrorType
    PublicCloudBackupServerPublicAddress:
      type: object
      properties:
        backupServerIpAddresses:
          type: string
          description: Array of IP addresses of a Veeam Cloud Connect site.
          readOnly: true
    PublicCloudAzureSubscription:
      type: object
      properties:
        subscriptionId:
          type: string
          description: ID assigned to a Microsoft Azure subscription.
          format: uuid
          readOnly: true
        subscriptionName:
          type: string
          description: Name of a Microsoft Azure subscription.
          readOnly: true
        environment:
          $ref: '#/components/schemas/EAzureEnvironmentIdReadonly'
        tenantId:
          type: string
          description: ID assigned to a tenant available to a Microsoft Azure account.
          readOnly: true
    PublicCloudAzureConnection:
      type: object
      properties:
        connectionUid:
          type: string
          description: UID assigned to a Microsoft Azure connection.
          format: uuid
          readOnly: true
    PublicCloudAzureNetwork:
      type: object
      properties:
        networkId:
          type: string
          description: ID assigned to a network.
          readOnly: true
        networkName:
          type: string
          description: Name of a network.
          readOnly: true
        subnets:
          type: array
          items:
            $ref: '#/components/schemas/PublicCloudAzureSubnet'
          description: Array of subnets.
          readOnly: true
    PublicCloudAzureSubnet:
      type: object
      properties:
        addressSpace:
          type: string
          description: IP range for a subnet.
          readOnly: true
        subnetName:
          type: string
          description: Name of a subnet.
          readOnly: true
    PublicCloudAzureDataCenter:
      type: object
      properties:
        dataCenterId:
          type: string
          description: ID assigned to a Microsoft Azure datacenter.
          readOnly: true
        dataCenterName:
          type: string
          description: Name of a Microsoft Azure datacenter.
          readOnly: true
    PublicCloudAzureSecurityGroup:
      type: object
      properties:
        securityGroupId:
          type: string
          description: ID assigned to a security group.
          readOnly: true
        securityGroupName:
          type: string
          description: Name of a security group.
          readOnly: true
    PublicCloudAzureResourceGroup:
      type: object
      properties:
        resourceGroupName:
          type: string
          description: Name of a resource group.
          readOnly: true
        environment:
          $ref: '#/components/schemas/EAzureEnvironmentIdReadonly'
        subscriptionId:
          type: string
          description: UID assigned to a Microsoft Azure subscription.
          format: uuid
          readOnly: true
        dataCenterId:
          type: string
          description: ID assigned to a Microsoft Azure datacenter.
          readOnly: true
    PublicCloudAzureVirtualMachine:
      type: object
      properties:
        virtualMachineId:
          type: string
          description: ID assigned to a VM.
          readOnly: true
        virtualMachineName:
          type: string
          description: Name of a VM.
          readOnly: true
    PublicCloudAzureNewKeyPair:
      required:
        - keyPairName
        - privateKey
        - fileName
      type: object
      properties:
        keyPairName:
          type: string
          description: Name of a key pair.
        privateKey:
          type: string
          description: Private key.
        fileName:
          type: string
          description: Name of a file containing keys.
    PublicCloudApplianceCertificateCredentials:
      required:
        - username
        - password
        - certificateThumbprint
      type: object
      properties:
        username:
          maxLength: 255
          minLength: 1
          type: string
          description: User name.
        password:
          maxLength: 1024
          type: string
          description: Password.
        certificateThumbprint:
          maxLength: 128
          type: string
          description: Security certificate thumbprint.
    ValidatePublicCloudCredentialsForMigrationResult:
      required:
        - accountUid
        - success
        - insufficientRights
      type: object
      properties:
        accountUid:
          type: string
          description: UID assigned to an account.
          format: uuid
        success:
          type: boolean
          description: Indicates whether validation is successful.
        insufficientRights:
          type: array
          items:
            type: string
          description: Array of permissions that an account lacks.
          readOnly: true
    PublicCloudVirtualMachinePolicy:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud VM policy.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a cloud VM policy.
          readOnly: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/PublicCloudPolicyStatus'
        state:
          $ref: '#/components/schemas/PublicCloudPolicyState'
        applianceManagementType:
          $ref: '#/components/schemas/BackupServerPublicCloudApplianceManagementType'
        managementAgentUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to a mapped organization.
          format: uuid
          nullable: true
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a cloud VM policy location.
          format: uuid
          nullable: true
          readOnly: true
        instancesCount:
          type: integer
          description: Number of cloud VMs included in a policy.
          format: int32
          readOnly: true
        nextRun:
          type: string
          description: Date and time of the next scheduled policy run.
          format: date-time
          nullable: true
          readOnly: true
        platformType:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatform'
    PublicCloudVirtualMachinePolicyObject:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud VM.
          format: uuid
          readOnly: true
        instanceName:
          type: string
          description: Name of a cloud VM.
          readOnly: true
        policyUid:
          type: string
          description: UID assigned to cloud VM policy.
          format: uuid
          readOnly: true
        policyName:
          type: string
          description: Name of a cloud VM policy.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        resourceId:
          type: string
          description: Resource ID assigned to a cloud VM.
          readOnly: true
        lastBackup:
          $ref: '#/components/schemas/PublicCloudPolicySession'
        lastArchive:
          $ref: '#/components/schemas/PublicCloudPolicySession'
        lastReplicaSnapshot:
          $ref: '#/components/schemas/PublicCloudPolicySession'
        lastSnapshot:
          $ref: '#/components/schemas/PublicCloudPolicySession'
    PublicCloudFileSharePolicy:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud file share.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a cloud file share.
          readOnly: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/PublicCloudPolicyStatus'
        state:
          $ref: '#/components/schemas/PublicCloudPolicyState'
        applianceManagementType:
          $ref: '#/components/schemas/BackupServerPublicCloudApplianceManagementType'
        managementAgentUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to mapped organization.
          format: uuid
          nullable: true
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a cloud file share policy location.
          format: uuid
          nullable: true
          readOnly: true
        instancesCount:
          type: integer
          description: Number of cloud file shares included in a policy.
          format: int32
          readOnly: true
        platformType:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatform'
        nextRun:
          type: string
          description: Date and time of the next scheduled policy run.
          format: date-time
          nullable: true
          readOnly: true
        backupTargetVaultName:
          type: string
          description: Name of a vault that stores backups.
          nullable: true
          readOnly: true
        backupCopyTargetVaultName:
          type: string
          description: Name of a vault that stores backup copies.
          nullable: true
          readOnly: true
    PublicCloudFileSharePolicyObject:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to cloud file share.
          format: uuid
          readOnly: true
        instanceName:
          type: string
          description: Name of a cloud file share.
          readOnly: true
        policyUid:
          type: string
          description: UID assigned to a cloud file share policy.
          format: uuid
          readOnly: true
        policyName:
          type: string
          description: Name of a cloud file share policy.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        resourceId:
          type: string
          description: Resource ID of a cloud file share policy.
          readOnly: true
        lastSnapshot:
          $ref: '#/components/schemas/PublicCloudPolicySession'
        lastReplicaSnapshot:
          $ref: '#/components/schemas/PublicCloudPolicySession'
        fileShareType:
          $ref: '#/components/schemas/PublicCloudFileShareType'
    PublicCloudFileShareType:
      enum:
        - Unknown
        - AwsEfs
        - AwsFsx
        - AzureFiles
      type: string
      description: Public cloud fileshare type.
      readOnly: true
      x-extensible-enum: true
    PublicCloudDatabasePolicy:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud database policy.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of cloud database policy.
          readOnly: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/PublicCloudPolicyStatus'
        state:
          $ref: '#/components/schemas/PublicCloudPolicyState'
        applianceManagementType:
          $ref: '#/components/schemas/BackupServerPublicCloudApplianceManagementType'
        managementAgentUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to a mapped organization.
          format: uuid
          nullable: true
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a cloud database policy location.
          format: uuid
          nullable: true
          readOnly: true
        instancesCount:
          type: integer
          description: Number of cloud databases included in a policy.
          format: int32
          readOnly: true
        nextRun:
          type: string
          description: Date and time of the next scheduled policy run.
          format: date-time
          nullable: true
          readOnly: true
        platformType:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatform'
    PublicCloudDatabasePolicyObject:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud database.
          format: uuid
          readOnly: true
        instanceName:
          type: string
          description: Name of a cloud database.
          readOnly: true
        policyUid:
          type: string
          description: UID assigned to a cloud database policy.
          format: uuid
          readOnly: true
        policyName:
          type: string
          description: Name of a cloud database policy.
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        databaseType:
          $ref: '#/components/schemas/PublicCloudDatabaseType'
        engineType:
          $ref: '#/components/schemas/ProtectedCloudDatabaseEngineType'
        resourceId:
          type: string
          description: Resource ID of a cloud database policy.
          nullable: true
          readOnly: true
        lastBackup:
          $ref: '#/components/schemas/PublicCloudPolicySession'
        lastSnapshot:
          $ref: '#/components/schemas/PublicCloudPolicySession'
        lastReplicaSnapshot:
          $ref: '#/components/schemas/PublicCloudPolicySession'
        lastArchive:
          $ref: '#/components/schemas/PublicCloudPolicySession'
    PublicCloudNetworkPolicy:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a cloud network policy.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a cloud network policy.
          readOnly: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/PublicCloudPolicyStatus'
        state:
          $ref: '#/components/schemas/PublicCloudPolicyState'
        applianceManagementType:
          $ref: '#/components/schemas/BackupServerPublicCloudApplianceManagementType'
        organizationUid:
          type: string
          description: UID assigned to a mapped organization.
          format: uuid
          readOnly: true
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        vnetType:
          $ref: '#/components/schemas/PublicCloudNetworkTypeReadonly'
        platformType:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatform'
        subscriptionsCount:
          type: integer
          description: Number of Microsoft Azure subscriptions.
          format: int32
          readOnly: true
        regionsCount:
          type: integer
          description: Number of regions.
          format: int32
          readOnly: true
        lastBackup:
          $ref: '#/components/schemas/PublicCloudPolicySession'
    PublicCloudPolicy:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds policy.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Backup for Public Clouds policy.
          readOnly: true
        applianceUid:
          type: string
          description: UID assigned to a Veeam Backup for Public Clouds appliance.
          format: uuid
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/PublicCloudPolicyStatus'
        state:
          $ref: '#/components/schemas/PublicCloudPolicyState'
        applianceManagementType:
          $ref: '#/components/schemas/BackupServerPublicCloudApplianceManagementType'
        backupServerUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to a mapped organization.
          format: uuid
          nullable: true
          readOnly: true
        platformType:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatform'
        policyType:
          $ref: '#/components/schemas/PublicCloudPolicyTypeReadonly'
    PublicCloudPolicyStatus:
      enum:
        - Unknown
        - Idle
        - Starting
        - Running
        - Stopping
        - Deleting
      type: string
      description: Status of a Veeam Backup for Public Clouds policy.
      readOnly: true
    PublicCloudPolicyState:
      enum:
        - Unknown
        - Enabled
        - Disabled
        - Enabling
        - Disabling
      type: string
      description: State of a Veeam Backup for Public Clouds policy.
      readOnly: true
    PublicCloudDatabaseType:
      enum:
        - Unknown
        - AwsRds
        - AwsDynamoDb
        - AwsRedshift
        - AwsRedshiftServerless
        - AzureSql
        - AzureCosmosDb
        - GoogleCloudSpanner
        - GoogleSql
      type: string
      description: Type of a cloud database included in a policy.
      readOnly: true
    PublicCloudNetworkTypeReadonly:
      enum:
        - Unknown
        - AzureVnet
        - AwsVpc
      type: string
      description: Type of a cloud network included in a policy.
      readOnly: true
    PublicCloudPolicyTypeReadonly:
      enum:
        - Unknown
        - VirtualMachine
        - FileShare
        - Database
        - CloudNetwork
      type: string
      description: Type of a Veeam Backup for Public Clouds policy.
      readOnly: true
      x-ms-enum:
        name: PublicCloudPolicyTypeReadonly
    PublicCloudPolicySession:
      type: object
      properties:
        endTime:
          type: string
          description: End date and time of a Veeam Backup for Public Clouds policy session
          format: date-time
          nullable: true
          readOnly: true
        failureMessage:
          type: string
          description: Message containing information on failed Veeam Backup for Public Clouds policy session.
          nullable: true
          readOnly: true
        status:
          $ref: '#/components/schemas/PublicCloudPolicySessionStatusReadonly'
      readOnly: true
    PublicCloudPolicySessionStatusReadonly:
      enum:
        - None
        - Idle
        - Success
        - Warning
        - Failed
        - Running
        - Starting
        - Stopping
        - Enabling
        - Disabling
        - WaitingTape
        - WaitingRepository
        - Deleting
      type: string
      description: Status of a Veeam Backup for Public Clouds policy session.
      readOnly: true
    CreatePublicCloudMultipartPatchInput:
      required:
        - fileName
        - platform
        - fileSize
      type: object
      properties:
        fileName:
          type: string
          description: Name of a patch file.
        platform:
          $ref: '#/components/schemas/BackupServerPublicCloudAppliancePlatformInput'
        fileSize:
          maximum: 5368709120
          minimum: 1
          type: integer
          description: 'Size of a patch file, in bytes.'
          format: int64
    GrantPublicCloudCredentialsForMigrationResult:
      required:
        - accountUid
        - success
        - error
      type: object
      properties:
        accountUid:
          type: string
          description: UID assigned to an account.
          format: uuid
        success:
          type: boolean
          description: Indicates whether permissions are granted successfully.
        message:
          type: string
          nullable: true
    PublicCloudGoogleAccountInput:
      required:
        - name
        - jsonConfiguration
      type: object
      properties:
        name:
          maxLength: 255
          minLength: 1
          type: string
          description: Name of a Google Cloud account.
        description:
          maxLength: 250
          type: string
          description: Description of a Google Cloud account.
          nullable: true
        jsonConfiguration:
          type: string
          description: Configuration file of a Google Cloud account in the `JSON` format.
    PublicCloudGoogleAccount:
      required:
        - name
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Google Cloud account.
          format: uuid
          readOnly: true
        credentialTag:
          type: string
          description: Tag of Google Cloud account credentials.
          format: uuid
          readOnly: true
        name:
          maxLength: 255
          minLength: 1
          type: string
          description: Name of a Google Cloud account.
        description:
          maxLength: 250
          type: string
          description: Description of a Google Cloud account.
          nullable: true
        projectId:
          type: string
          description: ID assigned to a project in which a Google Cloud account is created.
          readOnly: true
        createdBy:
          type: string
          description: Name of a user that created a Google Cloud account.
          readOnly: true
        siteUid:
          type: string
          description: UID assigned to a Veeam Cloud Connect site on which a Google Cloud account is registered.
          format: uuid
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to a mapped organization.
          format: uuid
          readOnly: true
        appliances:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to Veeam Backup for Public Clouds appliances to which a Google Cloud account is assigned.
          readOnly: true
        jsonConfiguration:
          type: string
          description: Configuration file of a Google Cloud account in the `JSON` format.
          format: password
          nullable: true
          readOnly: true
    PublicCloudGoogleDataCenter:
      type: object
      properties:
        dataCenterId:
          type: string
          description: ID assigned to a Google Cloud datacenter.
          readOnly: true
        dataCenterName:
          type: string
          description: Name of a Google Cloud datacenter.
          readOnly: true
    PublicCloudGoogleAvailabilityZone:
      type: object
      properties:
        availabilityZoneId:
          type: string
          description: ID assigned to a Google Cloud availability zone.
          readOnly: true
    PublicCloudGoogleNetworks:
      type: object
      properties:
        networkId:
          type: string
          description: ID assigned to a network.
          readOnly: true
        networkName:
          type: string
          description: Name of a network.
          readOnly: true
        projectId:
          type: string
          description: ID assigned to a project to which a network is added.
          readOnly: true
        networkType:
          $ref: '#/components/schemas/PublicCloudGoogleNetworkType'
    PublicCloudGoogleNetworkType:
      enum:
        - Unknown
        - Standalone
        - Shared
      type: string
      description: Type of a network.
      nullable: true
    VirtualServerTag:
      required:
        - urn
        - name
      type: object
      properties:
        urn:
          minLength: 1
          type: string
          description: Tag URN.
        name:
          maxLength: 256
          minLength: 1
          type: string
          description: Name of a tag.
        size:
          type: string
          description: Size used by a tag.
          nullable: true
          readOnly: true
    PublicCloudGoogleSubNetworks:
      type: object
      properties:
        subNetworkId:
          type: string
          description: ID assigned to a subnet.
          readOnly: true
        name:
          type: string
          description: Name of a subnet.
          readOnly: true
        range:
          type: string
          description: IP address range of a subnet.
          readOnly: true
    PublicCloudGoogleNetworkTag:
      type: object
      properties:
        networkTagId:
          type: string
          description: ID assigned to a network tag.
          readOnly: true
        networkTagName:
          type: string
          description: Name of a network tag.
          readOnly: true
    PublicCloudGoogleVirtualMachine:
      type: object
      properties:
        virtualMachineName:
          type: string
          description: Name of a Google Cloud VM.
          readOnly: true
        virtualMachineId:
          type: string
          description: ID assigned to a Google Cloud VM.
          readOnly: true
        availabilityZoneId:
          type: string
          description: ID assigned to an availability zone.
          readOnly: true
    PublicCloudGoogleNewApplianceInput:
      required:
        - account
        - virtualMachine
        - ipAddress
        - guestOsCredentials
      type: object
      properties:
        account:
          required:
            - accountUid
            - dataCenterId
            - availabilityZoneId
          type: object
          properties:
            accountUid:
              type: string
              description: UID assigned to a Google Cloud account.
              format: uuid
            dataCenterId:
              type: string
              description: ID assigned to a Google Cloud datacenter.
            availabilityZoneId:
              type: string
              description: ID assigned to an availability zone.
        virtualMachine:
          required:
            - virtualMachineName
          type: object
          properties:
            virtualMachineName:
              maxLength: 62
              minLength: 1
              pattern: '^[a-z0-9-]+$'
              type: string
              description: "Name of a VM instance where Veeam Backup for Google Cloud appliance will be deployed.\n> Note that the name must meet [Google naming convention] (https://cloud.google.com/compute/docs/naming-resources#resource-name-format)\n"
            description:
              maxLength: 250
              type: string
              description: Description of a VM instance where Veeam Backup for Google Cloud appliance will be deployed.
              nullable: true
        network:
          required:
            - networkId
            - subnetId
          type: object
          properties:
            networkId:
              type: string
              description: ID assigned to a network.
            subnetId:
              type: string
              description: ID assigned to a subnet.
            networkTagId:
              type: string
              description: "ID assigned to a network tag.\n> Provide the `null` value to create a new network tag.\n"
              nullable: true
          description: "Veeam Backup for Google Cloud appliance network resources.\n> If you provide the `null` value, all required resources will be created automatically.\n"
          nullable: true
        ipAddress:
          required:
            - backupServerIpAddresses
            - applianceIp
          type: object
          properties:
            applianceIp:
              properties:
                applianceIpAddressId:
                  type: string
                  description: ID assigned to a specific IP address.
                  nullable: true
                newIpAddressType:
                  enum:
                    - dynamic
                    - static
                  type: string
                  description: Type of an IP address that must be generated automatically.
                  nullable: true
              description: "IP address that must be assigned to a Veeam Backup for Google Cloud appliance.\n> Send only one of the following properties.\n"
            backupServerIpAddresses:
              maxLength: 48
              minLength: 1
              type: string
              description: Array of IP addresses of a Veeam Cloud Connect site.
        guestOsCredentials:
          required:
            - keyPairName
            - guestOsCredentialsUid
            - timeZoneId
          type: object
          properties:
            guestOsCredentialsUid:
              type: string
              description: UID assigned to guest OS credentials record.
              format: uuid
            sshPublicKey:
              type: string
              description: SSH public key.
              nullable: true
            timeZoneId:
              type: string
              description: ID assigned to a time zone.
    PublicCloudGoogleAddExistingApplianceInput:
      required:
        - account
        - virtualMachine
        - guestOsCredentials
      type: object
      properties:
        account:
          required:
            - accountUid
            - subscriptionId
            - dataCenterId
            - environment
            - connectionUid
          type: object
          properties:
            accountUid:
              type: string
              description: UID assigned to a Google Cloud account.
              format: uuid
            dataCenterId:
              type: string
              description: ID assigned to a Google Cloud datacenter.
        virtualMachine:
          required:
            - virtualMachineId
          type: object
          properties:
            virtualMachineId:
              type: string
              description: ID assigned to a VM on which Veeam Backup for Google Cloud appliance is deployed.
            description:
              maxLength: 250
              type: string
              description: Description of a VM on which Veeam Backup for Google Cloud appliance is deployed.
              nullable: true
        network:
          required:
            - privateNetworkAddress
          type: object
          properties:
            privateNetworkAddress:
              maxLength: 1024
              type: string
              description: IP address or DNS name of a private network.
          description: "Veeam Backup for Google Cloud appliance connection settings.\n> Send `null` to connect a Veeam Backup for Google Cloud appliance directly to the internet.\n"
          nullable: true
        guestOsCredentials:
          required:
            - guestOsCredentialsUid
          type: object
          properties:
            guestOsCredentialsUid:
              type: string
              description: UID assigned to guest OS credentials record.
              format: uuid
    PublicCloudGoogleAppliance:
      required:
        - guestOsCredentialsUid
        - accountUid
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup for Google Cloud appliance.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a Veeam Backup for Google Cloud appliance.
          readOnly: true
        description:
          maxLength: 250
          type: string
          description: Description of a Veeam Backup for Google Cloud appliance.
          nullable: true
        managementAgentUid:
          type: string
          description: UID assigned to management agent installed on a Veeam Backup for Google Cloud appliance server.
          format: uuid
          readOnly: true
        accountUid:
          type: string
          description: UID assigned to a Google Cloud account used to access a Veeam Backup for Google Cloud appliance.
          format: uuid
        guestOsCredentialsUid:
          type: string
          description: UID assigned to guest OS credentials record.
          format: uuid
        certificateThumbprint:
          type: string
          description: Thumbprint of a security certificate.
          readOnly: true
        publicAddress:
          type: string
          description: IP address or DNS name of a Veeam Backup for Google Cloud appliance.
          readOnly: true
        privateNetworkAddress:
          maxLength: 1024
          type: string
          description: Private IP address or DNS name of a Google Cloud network.
          nullable: true
        virtualMachineId:
          type: string
          description: ID assigned to a VM on which a Veeam Backup for Google Cloud appliance is deployed.
          readOnly: true
        dataCenterId:
          type: string
          description: ID assigned to a Google Cloud datacenter.
          readOnly: true
        availabilityZoneId:
          type: string
          description: ID assigned to an availability zone.
          readOnly: true
    BackupServerVirtualMachine:
      required:
        - urn
        - name
      type: object
      properties:
        urn:
          type: string
          description: VM URN.
        name:
          type: string
          description: Name of a VM.
        size:
          type: string
          description: Size used by a VM.
          nullable: true
          readOnly: true
    BackupServerVcdVirtualMachine:
      required:
        - urn
        - name
      type: object
      properties:
        urn:
          type: string
          description: VM URN.
        name:
          type: string
          description: Name of a VM.
        size:
          type: string
          description: Size used by a VM.
          nullable: true
          readOnly: true
        vcdOrganizationUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization.
          format: uuid
          nullable: true
          readOnly: true
        vcdOrganizationName:
          type: string
          description: Name assigned to a VMware Cloud Director organization.
          nullable: true
          readOnly: true
    BackupServerVirtualApplication:
      required:
        - urn
        - name
      type: object
      properties:
        urn:
          type: string
          description: URN of a vApp.
        name:
          type: string
          description: Name of a vApp.
        vcdOrganizationUid:
          type: string
          description: UID assigned to a VMware Cloud Director organization.
          format: uuid
          nullable: true
          readOnly: true
        vcdOrganizationName:
          type: string
          description: Name of a VMware Cloud Director organization.
          nullable: true
          readOnly: true
    BackupServerBackupJobConfiguration:
      required:
        - name
        - description
        - isHighPriority
        - storage
        - virtualMachines
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup job.
          format: uuid
          readOnly: true
        originalUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        name:
          maxLength: 125
          minLength: 1
          type: string
          description: Name of a backup job.
        description:
          maxLength: 2048
          type: string
          description: Description of a backup job.
        isDisabled:
          type: boolean
          description: Indicates whether a backup job is disabled.
          readOnly: true
        mappedOrganizationUid:
          type: string
          description: UID assigned to an organization that is mapped to a backup job on a hosted Veeam Backup & Replication server.
          format: uuid
          nullable: true
          readOnly: true
        mappedOrganizationName:
          type: string
          description: Name of an organization that is mapped to a backup job on a hosted Veeam Backup & Replication server.
          nullable: true
          readOnly: true
        backupServerUid:
          type: string
          description: UID of a hosted Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        backupServerName:
          type: string
          description: Name of a hosted Veeam Backup & Replication server.
          readOnly: true
        isHighPriority:
          type: boolean
          description: Indicates whether a backup job has a high priority in getting backup resources.
        virtualMachines:
          $ref: '#/components/schemas/BackupServerBackupJobVirtualMachines'
        storage:
          $ref: '#/components/schemas/BackupServerBackupJobStorage'
        guestProcessing:
          $ref: '#/components/schemas/BackupServerBackupJobGuestProcessing'
        schedule:
          $ref: '#/components/schemas/BackupServerBackupJobSchedule'
    BackupServerCloudDirectorBackupJobConfiguration:
      required:
        - name
        - description
        - virtualMachines
        - isHighPriority
        - storage
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a backup job.
          format: uuid
          readOnly: true
        originalUid:
          type: string
          description: UID assigned to a job in Veeam Backup & Replication.
          format: uuid
          readOnly: true
        name:
          maxLength: 125
          minLength: 1
          type: string
          description: Name of a backup job.
        description:
          maxLength: 2048
          type: string
          description: Description of a backup job.
        isDisabled:
          type: boolean
          description: Indicates whether a backup job is disabled.
          readOnly: true
        mappedOrganizationUid:
          type: string
          description: UID assigned to an organization to which a backup job belongs.
          format: uuid
          nullable: true
          readOnly: true
        mappedOrganizationName:
          type: string
          description: Name of an organization to which a backup job belongs.
          nullable: true
          readOnly: true
        backupServerUid:
          type: string
          description: UID of a Veeam Backup & Replication server.
          format: uuid
          readOnly: true
        backupServerName:
          type: string
          description: Name of a Veeam Backup & Replication server.
          readOnly: true
        isHighPriority:
          type: boolean
          description: Indicates whether a backup job has a high priority in getting backup resources.
        virtualMachines:
          $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobVirtualMachines'
        storage:
          $ref: '#/components/schemas/BackupServerBackupJobStorage'
        guestProcessing:
          $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobGuestProcessing'
        schedule:
          $ref: '#/components/schemas/BackupServerBackupJobSchedule'
      description: VMware Cloud Director backup job configuration.
    BackupServerBackupJobVirtualMachines:
      required:
        - includes
      type: object
      properties:
        includes:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerBackupJobVmwareObjectSize'
          description: Array of VMs and VM containers processed by a backup job.
        excludes:
          $ref: '#/components/schemas/BackupServerBackupJobExclusions'
      description: Backup scope.
    BackupServerCloudDirectorBackupJobVirtualMachines:
      required:
        - includes
      type: object
      properties:
        includes:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerCloudDirectorObject'
          description: Array of VMware Cloud Director objects included in a backup job.
        excludes:
          $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobExclusions'
      description: Backup scope of a VMware Cloud Director backup job.
    BackupServerBackupJobVmwareObjectSize:
      required:
        - inventoryObject
      type: object
      properties:
        inventoryObject:
          $ref: '#/components/schemas/BackupServerVmwareObject'
        size:
          type: string
          description: Storage space used by the VMware vSphere object.
          nullable: true
          readOnly: true
      description: VMware vSphere object and its size.
    BackupServerVmwareInventoryType:
      enum:
        - Unknown
        - VirtualMachine
        - vCenterServer
        - Datacenter
        - Cluster
        - Host
        - ResourcePool
        - Folder
        - Datastore
        - DatastoreCluster
        - StoragePolicy
        - Template
        - ComputeResource
        - VirtualApp
        - Tag
        - Category
        - Multitag
        - Network
        - DVSNetwork
      type: string
      description: Type of a VMware vSphere object.
      x-extensible-enum: true
      x-ms-enum:
        name: BackupServerVmwareInventoryType
    BackupServerBackupJobExclusions:
      type: object
      properties:
        vms:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerBackupJobVmwareObjectSize'
          description: Array of VMs excluded from a backup job.
          nullable: true
        disks:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerBackupJobVmwareObjectDisk'
          description: Array of VM disks excluded from a backup job.
          nullable: true
        templates:
          $ref: '#/components/schemas/BackupServerBackupJobExclusionsTemplates'
      description: Array of objects excluded from a backup job.
      nullable: true
    BackupServerCloudDirectorInventoryType:
      enum:
        - Unknown
        - VirtualMachine
        - CloudDirectorServer
        - Organization
        - OrganizationVDC
        - vApp
        - StoragePolicy
        - Network
        - vCenter
        - VmTemplate
        - Datastore
      type: string
      description: Type of a VMware Cloud Director object.
      x-extensible-enum: true
      x-ms-enum:
        name: BackupServerCloudDirectorInventoryType
    BackupServerCloudDirectorBackupJobExclusions:
      type: object
      properties:
        vms:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerCloudDirectorObject'
          description: Array of VMs excluded from a backup job.'
          nullable: true
        disks:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobDisk'
          description: Array of VM disks excluded from a backup job.
          nullable: true
        templates:
          $ref: '#/components/schemas/BackupServerBackupJobExclusionsTemplates'
      description: Array of objects excluded from a backup job.
      nullable: true
    BackupServerCloudDirectorBackupJobDisk:
      required:
        - disks
        - disksToProcess
        - vmObject
      type: object
      properties:
        vmObject:
          $ref: '#/components/schemas/BackupServerCloudDirectorObject'
        disksToProcess:
          $ref: '#/components/schemas/BackupServerBackupJobVmwareDisksTypeToProcess'
        disks:
          type: array
          items:
            type: string
          description: Array of IDs assigned to VM disks.
        removeFromVMConfiguration:
          type: boolean
          description: Indicates whether the disk is removed from the VM configuration.
          nullable: true
    BackupServerBackupJobVmwareObjectDisk:
      required:
        - disks
        - disksToProcess
        - vmObject
      type: object
      properties:
        vmObject:
          $ref: '#/components/schemas/BackupServerVmwareObject'
        disksToProcess:
          $ref: '#/components/schemas/BackupServerBackupJobVmwareDisksTypeToProcess'
        disks:
          type: array
          items:
            type: string
          description: Array of IDs assigned to VM disks.
        removeFromVMConfiguration:
          type: boolean
          description: Indicates whether the disk is removed from the VM configuration.
          nullable: true
    BackupServerBackupJobVmwareDisksTypeToProcess:
      enum:
        - AllDisks
        - SystemOnly
        - SelectedDisks
      type: string
      description: Type of a disk.
    BackupServerBackupJobExclusionsTemplates:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether VM templates are excluded from a backup job.
          default: true
        excludeFromIncremental:
          type: boolean
          description: Indicates whether VM templates are excluded from the incremental backup.
          default: true
      description: Excluded VM templates.
      nullable: true
    BackupServerBackupJobStorage:
      required:
        - backupProxies
        - backupRepositoryId
        - retentionPolicy
      type: object
      properties:
        backupRepositoryId:
          type: string
          description: UID assigned to a backup repository.
          format: uuid
        backupProxies:
          $ref: '#/components/schemas/BackupServerBackupJobProxiesSettings'
        retentionPolicy:
          $ref: '#/components/schemas/BackupServerBackupJobRetentionPolicySettings'
        gfsPolicy:
          $ref: '#/components/schemas/BackupServerBackupJobGFSPolicySettings'
        advancedSettings:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedSettings'
      description: Backup repository settings.
    BackupServerBackupJobProxiesSettings:
      required:
        - autoSelection
      type: object
      properties:
        autoSelection:
          type: boolean
          description: Indicates whether backup proxies are detected and assigned automatically.
          default: true
        proxyIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to a backup proxy.
          nullable: true
      description: Backup proxy settings.
    BackupServerBackupJobRetentionPolicySettings:
      type: object
      properties:
        type:
          $ref: '#/components/schemas/BackupServerBackupJobRetentionPolicyType'
        quantity:
          maximum: 9999
          minimum: 1
          type: integer
          description: Number of restore points or days that must must be stored.
          format: int32
          default: 7
      description: Retention policy settings.
      x-veeam-create-by-default: true
    BackupServerBackupJobRetentionPolicyType:
      enum:
        - RestorePoints
        - Days
      type: string
      description: Type of a retention policy.
      default: Days
    BackupServerBackupJobGFSPolicySettings:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether the long-term retention policy is enabled.
        weekly:
          $ref: '#/components/schemas/BackupServerBackupGFSPolicySettingsWeekly'
        monthly:
          $ref: '#/components/schemas/BackupServerBackupJobGFSPolicySettingsMonthly'
        yearly:
          $ref: '#/components/schemas/BackupServerBackupJobGFSPolicySettingsYearly'
      description: Long-term retention policy settings.
      nullable: true
    BackupServerBackupGFSPolicySettingsWeekly:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether the weekly long-term retention policy is enabled.
        keepForNumberOfWeeks:
          maximum: 9999
          minimum: 1
          type: integer
          description: Number of weeks during which restore points must be stored.
          format: int32
          nullable: true
        desiredTime:
          enum:
            - Sunday
            - Monday
            - Tuesday
            - Wednesday
            - Thursday
            - Friday
            - Saturday
          type: string
          description: Day of the week when the weekly retore point must be created.
          nullable: true
          x-ms-enum:
            name: DaysOfWeek
      description: Weekly long-term retention policy settings.
      nullable: true
    BackupServerBackupJobGFSPolicySettingsMonthly:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether the monthly GFS retention policy is enabled.
        keepForNumberOfMonths:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of months during which restore points must be stored.
          format: int32
          nullable: true
        desiredTime:
          enum:
            - First
            - Second
            - Third
            - Fourth
            - Fifth
            - Last
          type: string
          description: "Week of the month when the monthly restore point must be created.\n"
          nullable: true
          x-ms-enum:
            name: BackupServerBackupJobSennightOfMonth
      description: Monthly long-term retention policy.
      nullable: true
    BackupServerBackupJobGFSPolicySettingsYearly:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether the yearly GFS retention policy is enabled.
        keepForNumberOfYears:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of years during which restore points must be stored.
          format: int32
          nullable: true
        desiredTime:
          enum:
            - Jan
            - Feb
            - Mar
            - Apr
            - May
            - Jun
            - Jul
            - Aug
            - Sep
            - Oct
            - Nov
            - Dec
          type: string
          description: Month when the yearly restore point must be created.
          nullable: true
          x-ms-enum:
            name: Month
      description: Yearly long-term retention policy.
      nullable: true
    BackupServerBackupJobAdvancedSettings:
      type: object
      properties:
        backupModeType:
          $ref: '#/components/schemas/BackupServerBackupJobBackupModeType'
        syntheticFulls:
          $ref: '#/components/schemas/BackupServerBackupJobSyntheticFullSettings'
        activeFulls:
          $ref: '#/components/schemas/BackupServerBackupJobActiveFullSettings'
        backupHealth:
          $ref: '#/components/schemas/BackupServerBackupJobHealthCheckSettings'
        fullBackupMaintenance:
          $ref: '#/components/schemas/BackupServerBackupJobFullBackupMaintenance'
        storageData:
          $ref: '#/components/schemas/BackupServerBackupJobStorageSetting'
        notifications:
          $ref: '#/components/schemas/BackupServerBackupJobNotificationSettings'
        vSphere:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedSettingsVSphere'
        storageIntegration:
          $ref: '#/components/schemas/BackupServerBackupJobPrimaryStorageIntegrationSettings'
        scripts:
          $ref: '#/components/schemas/BackupServerJobScriptsSettings'
      description: Backup job advanced settings.
      nullable: true
      x-veeam-create-by-default: true
    BackupServerBackupJobBackupModeType:
      enum:
        - Full
        - Incremental
        - ReverseIncremental
        - Transform
        - TransformForeverIncremental
      type: string
      description: Backup method.
      default: Incremental
      x-ms-enum:
        name: BackupServerBackupJobBackupModeType
    BackupServerBackupJobSyntheticFullSettings:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether synthetic full backup creation is enabled.
        weekly:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedStorageScheduleWeekly'
        monthly:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedStorageScheduleMonthly'
      description: Synthetic full backup settings.
      nullable: true
    BackupServerBackupJobAdvancedStorageScheduleWeekly:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether the weekly schedule is enabled.
          default: false
        days:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/DaysOfWeek'
          description: Array of week days when the operation is performed.
          nullable: true
      description: Weekly schedule settings.
      nullable: true
    BackupServerBackupJobAdvancedStorageScheduleMonthly:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether the monthly schedule is enabled.
        dayOfWeek:
          $ref: '#/components/schemas/DaysOfWeekNullable'
        dayNumberInMonth:
          $ref: '#/components/schemas/BackupServerBackupJobDayNumberInMonthNullable'
        dayOfMonths:
          maximum: 32
          minimum: 1
          type: integer
          description: Numerical value of the day when the operation is performed.
          format: int32
          nullable: true
        months:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Month'
          description: Months when the operation is performed.
          nullable: true
      description: Monthly schedule settings.
      nullable: true
    BackupServerBackupJobDayNumberInMonthNullable:
      enum:
        - First
        - Second
        - Third
        - Fourth
        - Last
        - OnDay
      type: string
      description: Week day number in a month.
      nullable: true
      x-ms-enum:
        name: BackupServerBackupJobDayNumberInMonth
    BackupServerBackupJobDayNumberInMonth:
      enum:
        - First
        - Second
        - Third
        - Fourth
        - Last
        - OnDay
      type: string
      description: Week day number in a month.
      nullable: true
      x-ms-enum:
        name: BackupServerBackupJobDayNumberInMonth
    BackupServerBackupJobActiveFullSettings:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether active full backup creation are enabled.
        weekly:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedStorageScheduleWeekly'
        monthly:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedStorageScheduleMonthly'
      description: Active full backup settings.
      nullable: true
    BackupServerBackupJobHealthCheckSettings:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether health checks are enabled.
        weekly:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedStorageScheduleWeekly'
        monthly:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedStorageScheduleMonthly'
      description: Health check settings for the latest restore point in the backup chain.
      nullable: true
    BackupServerBackupJobFullBackupMaintenance:
      type: object
      properties:
        removeData:
          $ref: '#/components/schemas/BackupServerBackupJobFullBackupMaintenanceRemoveData'
        defragmentAndCompact:
          $ref: '#/components/schemas/BackupServerBackupJobFullBackupMaintenanceDefragmentAndCompact'
      description: Maintenance settings for full backup files.
      nullable: true
    BackupServerBackupJobFullBackupMaintenanceRemoveData:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether Veeam Backup & Replication keeps the backup data of the deleted VMs.
        afterDays:
          maximum: 999
          minimum: 1
          type: integer
          description: Number of days during which Veeam Backup & Replication keeps the backup data of the deleted VMs.
          format: int32
          default: 14
      description: Backup data settings for deleted VMs.
      nullable: true
    BackupServerBackupJobFullBackupMaintenanceDefragmentAndCompact:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether periodical full backup compact feature is enabled.
        weekly:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedStorageScheduleWeekly'
        monthly:
          $ref: '#/components/schemas/BackupServerBackupJobAdvancedStorageScheduleMonthly'
      description: Compact operation settings.
      nullable: true
    BackupServerBackupJobStorageSetting:
      type: object
      properties:
        enableInlineDataDeduplication:
          type: boolean
          description: Indicates whether VM data deduplication is enabled.
          default: true
        excludeSwapFileBlocks:
          type: boolean
          description: Indicates whether swap file block exclusion is enabled.
          default: true
        excludeDeletedFileBlocks:
          type: boolean
          description: Indicates whether deleted file block copy is enabled.
          default: true
        compressionLevel:
          $ref: '#/components/schemas/BackupServerCompressionLevel'
        storageOptimization:
          $ref: '#/components/schemas/BackupServerStorageOptimization'
        encryption:
          $ref: '#/components/schemas/BackupServerBackupJobStorageSettingsEncryption'
      description: Storage settings.
      nullable: true
      x-veeam-create-by-default: true
    BackupServerStorageOptimization:
      enum:
        - LocalTargetLarge
        - LocalTarget
        - LANTarget
        - WANTarget
        - LocalTargetLarge8192
        - LocalTargetLarge4096
      type: string
      description: "Storage optimization type.\n>256 KB - WANTarget\n>512 KB - LANTarget\n>1024 KB - LocalTarget\n>2048 KB - LocalTargetLarge\n>4096 KB - LocalTargetLarge4096\n>8192 KB - LocalTargetLarge8192\n"
      default: LocalTarget
      x-ms-enum:
        name: BackupServerStorageOptimization
    BackupServerCompressionLevel:
      enum:
        - None
        - DeduplicationFriendly
        - Optimal
        - High
        - Extreme
      type: string
      description: Compression level.
      default: Optimal
      x-ms-enum:
        name: BackupServerCompressionLevel
    BackupServerEncryptionTypeNullable:
      enum:
        - ByUserPassword
        - ByKms
      type: string
      description: Type of backup file content encryption.
      nullable: true
      x-ms-enum:
        name: BackupServerEncryptionType
    BackupServerBackupJobStorageSettingsEncryption:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether backup file content encryption is enabled.
          default: false
        encryptionType:
          $ref: '#/components/schemas/BackupServerEncryptionTypeNullable'
        encryptionPasswordId:
          type: string
          description: "ID assigned to a password used for encryption.\n>For exported objects, the property value is `null`.\n"
          format: uuid
          nullable: true
        encryptionPasswordTag:
          type: string
          description: Tag used to identify the password.
          nullable: true
        kmsServerId:
          type: string
          description: ID assigned to a Key Management Server.
          format: uuid
          nullable: true
      description: Backup file encryption settings.
      nullable: true
      x-veeam-create-by-default: true
    BackupServerBackupJobNotificationSettings:
      type: object
      properties:
        sendSNMPNotifications:
          type: boolean
          description: Indicates whether SNMP notifications are enabled for a job.
          default: false
        emailNotifications:
          $ref: '#/components/schemas/BackupServerEmailNotificationSettings'
        vmAttribute:
          $ref: '#/components/schemas/BackupServerNotificationVmAttributeSettings'
      description: Notification settings.
      nullable: true
    BackupServerCredentialsRecord:
      required:
        - instanceUid
        - type
        - username
        - creationTime
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to credentials record.
          format: uuid
        type:
          $ref: '#/components/schemas/BackupServerCredentialsType'
        username:
          type: string
          description: User name.
        description:
          maxLength: 256
          type: string
          description: Description of credentials.
          nullable: true
        creationTime:
          type: string
          description: Date and time when credentials were created.
          format: date-time
          readOnly: true
        mappedOrganizationUid:
          type: string
          description: UID of a company to whom credentials are assigned.
          format: uuid
          nullable: true
        mappedOrganizationName:
          type: string
          description: Name of a company to whom credentials are assigned.
          nullable: true
          readOnly: true
        linuxCredentialsDetails:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerCredentialsRecordLinuxDetails'
          description: Details of credentials used to access Linux computers.
          nullable: true
      description: Veeam Backup & Replication credentials.
      nullable: true
    BackupServerCredentialsRecordLinuxDetails:
      required:
        - username
      type: object
      properties:
        sshPort:
          type: integer
          description: SSH port used to connect to a Linux server.
          format: int32
          default: 22
        autoElevated:
          type: boolean
          description: Indicates whether the account that owns credentials has permissions of a root user.
          default: false
        addToSudoers:
          type: boolean
          description: Indicates whether the account that owns credentials is added to the sudoers file.
          default: false
        useSu:
          type: boolean
          description: Indicates whether the `su` command is used for Linux distributions where the `sudo` command is not available.
          default: false
        privateKey:
          type: string
          description: Private key.
          format: password
          nullable: true
        passphrase:
          type: string
          description: Passphrase for the private key.
          format: password
          nullable: true
      description: Details of credentials used to access Linux computers.
    BackupServerCredentialsStandard:
      required:
        - instanceUid
        - username
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a credentials record.
          format: uuid
          readOnly: true
        username:
          minLength: 1
          type: string
          description: User name.
        description:
          maxLength: 256
          type: string
          description: Description of credentials.'
          nullable: true
        creationTime:
          type: string
          description: Date and time when credentials were created.
          format: date-time
          readOnly: true
        mappedOrganizationUid:
          type: string
          description: UID of a company to whom credentials are assigned.
          format: uuid
          nullable: true
        mappedOrganizationName:
          type: string
          description: Name of a company to whom credentials are assigned.
          nullable: true
          readOnly: true
      nullable: true
    BackupServerCredentialsStandardInput:
      required:
        - username
        - password
      type: object
      properties:
        username:
          minLength: 1
          type: string
          description: User name.
        password:
          minLength: 1
          type: string
          description: Password.
          format: password
        description:
          maxLength: 256
          type: string
          description: Credentials description.
          nullable: true
        mappedOrganizationUid:
          type: string
          description: UID of a company to whom credentials are assigned.
          format: uuid
          nullable: true
      nullable: true
    BackupServerCredentialsLinux:
      required:
        - username
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a credentials record.
          format: uuid
          readOnly: true
        username:
          type: string
          description: User name.
        description:
          maxLength: 256
          type: string
          description: Description of credentials.
          nullable: true
        creationTime:
          type: string
          description: Date and time when credentials were created.
          format: date-time
          readOnly: true
        sshPort:
          type: integer
          description: SSH port used to connect to a Linux server.
          format: int32
          default: 22
        autoElevated:
          type: boolean
          description: Indicates whether the account that owns credentials has permissions of a root user.
          default: false
        addToSudoers:
          type: boolean
          description: Indicates whether the account that owns credentials is added to the sudoers file.
          default: false
        useSu:
          type: boolean
          description: Indicates whether the `su` command is used for Linux distributions where the `sudo` command is not available.
          default: false
        privateKey:
          type: string
          description: Private key.
          format: password
          nullable: true
        passphrase:
          type: string
          description: Passphrase for the private key.
          format: password
          nullable: true
        mappedOrganizationUid:
          type: string
          description: UID of a company to whom credentials are assigned.
          format: uuid
          nullable: true
        mappedOrganizationName:
          type: string
          description: Name of a company to whom credentials are assigned.
          nullable: true
          readOnly: true
    BackupServerCredentialsLinuxInput:
      required:
        - username
      type: object
      properties:
        username:
          minLength: 1
          pattern: ^\S+$
          type: string
          description: User name.
        password:
          type: string
          description: Password.
          format: password
          nullable: true
        description:
          maxLength: 256
          type: string
          description: Description of credentials.
          nullable: true
        mappedOrganizationUid:
          type: string
          description: UID of a company to whom credentials must be assigned.
          format: uuid
          nullable: true
        sshPort:
          type: integer
          description: SSH port used to connect to a Linux server.
          format: int32
          default: 22
        autoElevated:
          type: boolean
          description: Indicates whether the account that owns credentials has permissions of a root user.
          default: false
        addToSudoers:
          type: boolean
          description: Indicates whether the account that owns credentials is added to the sudoers file.
          default: false
        useSu:
          type: boolean
          description: Indicates whether the `su` command is used for Linux distributions where the `sudo` command is not available.
          default: false
        privateKey:
          type: string
          description: Private key.
          format: password
          nullable: true
        passphrase:
          type: string
          description: Passphrase for the private key.
          format: password
          nullable: true
        rootPassword:
          maxLength: 4096
          type: string
          description: Password of a root account.
          format: password
          nullable: true
      nullable: true
    BackupServerEncryptionPassword:
      required:
        - hint
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a Veeam Backup & Replication server encryption password.
          format: uuid
          readOnly: true
        uniqueId:
          maxLength: 256
          type: string
          description: Unique ID assigned to a Veeam Backup & Replication server encryption password.
          nullable: true
        hint:
          maxLength: 405
          minLength: 1
          pattern: '^[^|]*$'
          type: string
          description: Hint for a Veeam Backup & Replication server encryption password.
        modificationTime:
          type: string
          description: Date and time when a Veeam Backup & Replication server encryption password was created or changed.
          format: date-time
          nullable: true
          readOnly: true
        mappedOrganizationUid:
          type: string
          description: UID of a company to whom a Veeam Backup & Replication server encryption password is assigned.
          format: uuid
          nullable: true
        mappedOrganizationName:
          type: string
          description: Name of a company to whom a Veeam Backup & Replication server encryption password is assigned.
          nullable: true
          readOnly: true
    BackupServerEncryptionPasswordInput:
      required:
        - password
        - hint
      type: object
      properties:
        password:
          maxLength: 1024
          type: string
          description: Veeam Backup & Replication encryption password.
          format: password
        uniqueId:
          maxLength: 256
          type: string
          description: Unique ID assigned to a Veeam Backup & Replication server encryption password.
          nullable: true
        hint:
          maxLength: 405
          minLength: 1
          pattern: '^[^|]*$'
          type: string
          description: Hint for a Veeam Backup & Replication server encryption password.
        mappedOrganizationUid:
          type: string
          description: UID of a company to whom a Veeam Backup & Replication server encryption password is assigned.
          format: uuid
          nullable: true
        mappedOrganizationName:
          type: string
          description: Name of a company to whom a Veeam Backup & Replication server encryption password is assigned.
          nullable: true
    BackupServerEmailNotificationSettings:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether email notifications are enabled.
        recipients:
          uniqueItems: true
          type: array
          items:
            type: string
          description: Array of email addresses of notification recipients.
          nullable: true
        notificationType:
          $ref: '#/components/schemas/BackupServerEmailNotificationType'
        customNotificationSettings:
          $ref: '#/components/schemas/BackupServerEmailCustomNotificationType'
      description: Email notification settings.
      nullable: true
    BackupServerEmailNotificationType:
      enum:
        - UseGlobalNotificationSettings
        - UseCustomNotificationSettings
      type: string
      description: Type of email notification settings applied to a current job.
      default: UseGlobalNotificationSettings
      x-ms-enum:
        name: BackupServerEmailNotificationType
    BackupServerEmailCustomNotificationType:
      type: object
      properties:
        subject:
          type: string
          description: "Notification subject. \n>You can use the following variables in the subject:\n>`%Time%` — completion time\n>`%JobName%` — job name\n>`%JobResult%` — job result\n>`%ObjectCount%` — number of VMs in the job\n>`%Issues%` — number of VMs in the job that have finished with the Warning or Failed status\n"
          default: '[%JobResult%] %JobName% (%ObjectCount% objects) %Issues%'
        notifyOnSuccess:
          type: boolean
          description: Indicates whether email notifications are sent when a job completes successfully.
          default: true
        notifyOnWarning:
          type: boolean
          description: Indicates whether email notifications are sent when a job completes with warnings.
          default: true
        notifyOnError:
          type: boolean
          description: Indicates whether email notifications are sent when a job fails.
          default: true
        SuppressNotificationUntilLastRetry:
          type: boolean
          description: Indicates whether email notifications are sent about the final job status only.
          default: true
      description: Custom notification settings.
      nullable: true
    BackupServerNotificationVmAttributeSettings:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether information about successfully performed backup is written to a VM attribute.
        notes:
          type: string
          description: Name of a VM attribute.
          nullable: true
        appendToExistingValue:
          type: boolean
          description: Indicates whether information about successfully performed backup is appended to the existing value of the attribute added by the user.
          default: true
      description: VM attribute settings.
      nullable: true
    BackupServerBackupJobAdvancedSettingsVSphere:
      type: object
      properties:
        enableVMWareToolsQuiescence:
          type: boolean
          description: Indicates whether VMware Tools quiescence is enabled for freezing the VM file system and application data.
          default: false
        changedBlockTracking:
          $ref: '#/components/schemas/BackupServerVSphereChangedBlockTrackingSettings'
      description: VMware vSphere settings.
      nullable: true
      x-veeam-create-by-default: true
    BackupServerVSphereChangedBlockTrackingSettings:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether CBT is enabled.
          default: true
        enableCbtAutomatically:
          type: boolean
          description: "Indicates whether CBT is enabled for all processed VMs even if CBT is disabled in VM configuration.\n>CBT is used for VMs with virtual hardware version 7 or later.\n>VMs must not have existing snapshots.\n"
          default: true
        resetCbtOnActiveFull:
          type: boolean
          description: Indicates whether CBT is reset before creating active full backups.
          default: true
      description: Changed block tracking settings.
      nullable: true
      x-veeam-create-by-default: true
    BackupServerBackupJobPrimaryStorageIntegrationSettings:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether Backup from Storage Snapshots is enabled.
          default: true
        limitProcessedVm:
          type: boolean
          description: Indicates whether the number of processed VMs for one storage snapshot is limited.
          default: false
        limitProcessedVmCount:
          maximum: 10000
          minimum: 1
          type: integer
          description: Maximum number of processed VMs for one storage snapshot.
          format: int32
          default: 10
        failoverToStandardBackup:
          type: boolean
          description: Indicates whether failover to regular VM snapshot processing is enabled in case Veeam Backup & Replication fails to create storage snapshot.
          default: false
      description: Backup from Storage Snapshots settings.
      nullable: true
      x-veeam-create-by-default: true
    BackupServerJobScriptsSettings:
      type: object
      properties:
        preCommand:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerScriptCommand'
          description: Script executed before a backup job.
          nullable: true
        postCommand:
          type: object
          allOf:
            - $ref: '#/components/schemas/BackupServerScriptCommand'
          description: Script executed after a backup job.
          nullable: true
        periodicityType:
          $ref: '#/components/schemas/BackupServerScriptPeriodicityType'
        runScriptEvery:
          maximum: 99
          minimum: 1
          type: integer
          description: Number of backup job sessions after which the scripts must be executed.
          format: int32
          nullable: true
        dayOfWeek:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/DaysOfWeek'
          description: Days of the week when the scripts must be executed.
          nullable: true
      description: Script settings.
      nullable: true
    BackupServerScriptCommand:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether script execution is enabled.
        command:
          type: string
          description: Path to a script.
          nullable: true
    BackupServerScriptPeriodicityType:
      enum:
        - Days
        - BackupSessions
      type: string
      description: Type of script execution periodicity.
      default: BackupSessions
      x-ms-enum:
        name: BackupServerScriptPeriodicityType
    BackupServerBackupJobGuestProcessing:
      type: object
      properties:
        appAwareProcessing:
          $ref: '#/components/schemas/BackupServerBackupJobApplicationAwareProcessing'
        guestFSIndexing:
          $ref: '#/components/schemas/BackupServerBackupJobGuestFileSystemIndexing'
        guestInteractionProxies:
          $ref: '#/components/schemas/BackupServerBackupJobGuestInteractionProxiesSettings'
        guestCredentials:
          $ref: '#/components/schemas/BackupServerBackupJobGuestOsCredentials'
      description: Guest processing settings.
      x-veeam-create-by-default: true
    BackupServerCloudDirectorBackupJobGuestProcessing:
      type: object
      properties:
        appAwareProcessing:
          $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobApplicationAwareProcessing'
        guestFSIndexing:
          $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobGuestFileSystemIndexing'
        guestInteractionProxies:
          $ref: '#/components/schemas/BackupServerBackupJobGuestInteractionProxiesSettings'
        guestCredentials:
          $ref: '#/components/schemas/BackupServerBackupJobGuestOsCredentials'
      description: Guest processing settings.
      x-veeam-create-by-default: true
    BackupServerBackupJobGuestInteractionProxiesSettings:
      required:
        - autoSelection
      type: object
      properties:
        autoSelection:
          type: boolean
          description: Indicates whether Veeam Backup & Replication automatically selects the guest interaction proxy.
        proxyIds:
          uniqueItems: true
          type: array
          items:
            type: string
            format: uuid
          description: Array of UIDs assigned to servers that you want to use as interaction proxies.
          nullable: true
      description: Interaction proxy settings.
      nullable: true
    BackupServerCloudDirectorBackupJobApplicationAwareProcessing:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether application-aware processing is enabled.
          default: false
        appSettings:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobApplicationSettings'
          description: Array of VMware Cloud Director objects and their application settings.
          nullable: true
      description: Application-aware processing settings.
      x-veeam-create-by-default: true
    BackupServerBackupJobApplicationAwareProcessing:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether application-aware processing is enabled.
          default: false
        appSettings:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerBackupJobApplicationSettings'
          description: Array of VMware vSphere objects and their application settings.
          nullable: true
      description: Application-aware processing settings.
      x-veeam-create-by-default: true
    BackupServerCloudDirectorBackupJobApplicationSettings:
      required:
        - vmObject
      type: object
      properties:
        vmObject:
          $ref: '#/components/schemas/BackupServerCloudDirectorObject'
        vss:
          $ref: '#/components/schemas/BackupServerApplicationSettingsVSS'
        usePersistentGuestAgent:
          type: boolean
          description: Indicates whether persistent guest agents are used on protected VMs for application-aware processing.
          default: false
        transactionLogs:
          $ref: '#/components/schemas/BackupServerTransactionLogsSettings'
        sql:
          $ref: '#/components/schemas/BackupServerBackupJobSQLSettings'
        oracle:
          $ref: '#/components/schemas/BackupServerBackupJobOracleSettings'
        exclusions:
          $ref: '#/components/schemas/BackupServerBackupJobBackupFSExclusions'
        scripts:
          $ref: '#/components/schemas/BackupServerBackupJobScriptSettings'
      nullable: true
    BackupServerBackupJobApplicationSettings:
      required:
        - vmObject
      type: object
      properties:
        vmObject:
          $ref: '#/components/schemas/BackupServerVmwareObject'
        vss:
          $ref: '#/components/schemas/BackupServerApplicationSettingsVSS'
        usePersistentGuestAgent:
          type: boolean
          description: Indicates whether persistent guest agents are used on protected VMs for application-aware processing.
          default: false
        transactionLogs:
          $ref: '#/components/schemas/BackupServerTransactionLogsSettings'
        sql:
          $ref: '#/components/schemas/BackupServerBackupJobSQLSettings'
        oracle:
          $ref: '#/components/schemas/BackupServerBackupJobOracleSettings'
        exclusions:
          $ref: '#/components/schemas/BackupServerBackupJobBackupFSExclusions'
        scripts:
          $ref: '#/components/schemas/BackupServerBackupJobScriptSettings'
      nullable: true
    BackupServerVmwareObject:
      required:
        - name
        - type
        - hostName
      type: object
      properties:
        hostName:
          type: string
          description: Name of a VMware vSphere server that hosts the object.
        name:
          type: string
          description: Name of the VMware vSphere object.
        type:
          $ref: '#/components/schemas/BackupServerVmwareInventoryType'
        objectId:
          type: string
          description: URN assigned to a VMware vSphere object.
          nullable: true
      description: VMware vSphere object.
    BackupServerCloudDirectorObject:
      required:
        - name
        - type
        - hostName
      type: object
      properties:
        hostName:
          type: string
          description: Name of a VMware Cloud Director server that manages an object.
        name:
          type: string
          description: Name of an object.
        type:
          $ref: '#/components/schemas/BackupServerCloudDirectorInventoryType'
        objectId:
          type: string
          description: URN of an object.
          nullable: true
        size:
          type: string
          description: Size of an object.
          nullable: true
          readOnly: true
        vcdOrganizationName:
          type: string
          description: Name of a VMware Cloud Director organization.
          nullable: true
          readOnly: true
        vcdOrganizationUid:
          type: string
          description: UID assigned to a VMware Cloud Director server.
          format: uuid
          nullable: true
          readOnly: true
      description: VMware Cloud Director object.
    BackupServerApplicationSettingsVSS:
      enum:
        - requireSuccess
        - ignoreFailures
        - disabled
      type: string
      description: Behavior scenario for application-aware processing.
      default: requireSuccess
      x-ms-enum:
        name: BackupServerApplicationSettingsVSS
    BackupServerTransactionLogsSettings:
      enum:
        - process
        - copyOnly
      type: string
      description: Indicates whether Veeam Backup & Replication must process application logs or create copy-only backups.
      default: process
      x-ms-enum:
        name: BackupServerTransactionLogsSettings
    BackupServerBackupJobSQLSettings:
      required:
        - logsProcessing
      type: object
      properties:
        logsProcessing:
          $ref: '#/components/schemas/BackupServerSQLLogsProcessing'
        backupMinutesCount:
          type: integer
          description: 'Frequency of transaction log backup, in minutes.'
          format: int32
          default: 15
        retainLogBackups:
          $ref: '#/components/schemas/BackupServerBackupJobRetainLogBackupsType'
        keepDaysCount:
          type: integer
          description: Number of days to keep transaction logs.
          format: int32
          default: 15
        logShippingServers:
          $ref: '#/components/schemas/BackupServerBackupJobLogShippingServers'
      description: Microsoft SQL Server transaction log settings.
      nullable: true
    BackupServerSQLLogsProcessing:
      enum:
        - truncate
        - preserve
        - backup
        - neverTruncate
      type: string
      description: Type of transaction log processing.
      default: truncate
      x-ms-enum:
        name: BackupServerSQLLogsProcessing
    BackupServerBackupJobLogShippingServers:
      required:
        - autoSelection
      type: object
      properties:
        autoSelection:
          type: boolean
          description: Indicates whether Veeam Backup & Replication selects an optimal log shipping server automatically.
          default: false
        shippingServerIds:
          type: array
          items:
            type: string
            format: uuid
          description: Array of UID assigned to servers used to transport transaction logs.
          nullable: true
      description: Log shipping servers used to transport transaction logs.
      nullable: true
    BackupServerBackupJobRetainLogBackupsType:
      enum:
        - untilBackupDeleted
        - keepOnlyDays
      type: string
      description: Type of log retention policy.
      default: untilBackupDeleted
      x-ms-enum:
        name: BackupServerBackupJobRetainLogBackupsType
    BackupServerBackupJobOracleSettings:
      required:
        - archiveLogs
        - useGuestCredentials
      type: object
      properties:
        useGuestCredentials:
          type: boolean
          description: Indicates whether Veeam Backup & Replication uses credentials specified in the guest processing settings to access Oracle database.
        credentialsId:
          type: string
          description: UID assigned to a credentials record that is used to access Oracle database in case the `useGuestCredentials` property has the `false` value.
          format: uuid
          nullable: true
        archiveLogs:
          $ref: '#/components/schemas/BackupServerBackupJobBackupOracleLogsSettings'
        deleteHoursCount:
          type: integer
          description: "Time period during which archived logs must be kept, in hours.\n>Required if the `archiveLogs` property has the `deleteExpiredHours` value.\n"
          format: int32
          default: 24
        deleteGBsCount:
          type: integer
          description: "Archive log size threshold, in GB.\n>Required if the `archiveLogs` praperty has the `deleteExpiredGBs` value.\n"
          format: int32
          default: 15
        backupLogs:
          type: boolean
          description: Indicates whether archived logs must be backed up.
          default: false
        backupMinutesCount:
          type: integer
          description: 'Frequency of archived log backup, in minutes.'
          format: int32
          default: 15
        retainLogBackups:
          $ref: '#/components/schemas/BackupServerBackupJobRetainLogBackupsType'
        keepDaysCount:
          type: integer
          description: Number of days during which archived log backups must be stored.
          format: int32
          default: 15
        logShippingServers:
          $ref: '#/components/schemas/BackupServerBackupJobLogShippingServers'
      description: Oracle archived log settings.
      nullable: true
    BackupServerBackupJobBackupOracleLogsSettings:
      enum:
        - preserve
        - deleteExpiredHours
        - deleteExpiredGBs
      type: string
      description: Type of archived log processing.
      x-ms-enum:
        name: BackupServerBackupJobBackupOracleLogsSettings
    BackupServerBackupJobBackupFSExclusions:
      required:
        - exclusionPolicy
      type: object
      properties:
        exclusionPolicy:
          $ref: '#/components/schemas/BackupServerBackupJobExclusionPolicy'
        itemsList:
          type: array
          items:
            type: string
          description: "Array of included or excluded files and folders.\n>Full paths to files and folders, environmental variables and file masks with the asterisk (*) and question mark (?) characters can be used.\n"
          nullable: true
      description: VM guest OS file exclusion.
      nullable: true
    BackupServerBackupJobExclusionPolicy:
      enum:
        - disabled
        - excludeOnly
        - includeOnly
      type: string
      description: Exclusion type.
      x-ms-enum:
        name: BackupServerBackupJobExclusionPolicy
    BackupServerBackupJobScriptSettings:
      required:
        - scriptProcessingMode
      type: object
      properties:
        scriptProcessingMode:
          $ref: '#/components/schemas/BackupServerBackupJobScriptProcessingMode'
        windowsScripts:
          $ref: '#/components/schemas/BackupServerBackupJobWindowsScript'
        linuxScripts:
          $ref: '#/components/schemas/BackupServerBackupJobLinuxScript'
      description: Pre-freeze and post-thaw scripts.
      nullable: true
    BackupServerBackupJobScriptProcessingMode:
      enum:
        - disableExec
        - ignoreExecFailures
        - requireSuccess
      type: string
      description: Scenario for scripts execution.
      default: disableExec
      x-ms-enum:
        name: BackupServerBackupJobScriptProcessingMode
    BackupServerBackupJobWindowsScript:
      type: object
      properties:
        preFreezeScript:
          type: string
          description: Path to a pre-freeze script.
          nullable: true
        postThawScript:
          type: string
          description: Path to a post-thaw script.
          nullable: true
      description: Paths to pre-freeze and post-thaw scripts for Microsoft Windows VMs.
      nullable: true
    BackupServerBackupJobLinuxScript:
      type: object
      properties:
        preFreezeScript:
          type: string
          description: Path to a pre-freeze script.
          nullable: true
        postThawScript:
          type: string
          description: Path to a post-thaw script.
          nullable: true
      description: Paths to pre-freeze and post-thaw scripts for Linux VMs.
      nullable: true
    BackupServerCloudDirectorBackupJobGuestFileSystemIndexing:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether file indexing is enabled.
          default: false
        indexingSettings:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerCloudDirectorBackupJobIndexingSettings'
          description: Array of VMs with guest OS file indexing options.
          nullable: true
      description: Guest OS file indexing.
      x-veeam-create-by-default: true
    BackupServerBackupJobGuestFileSystemIndexing:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether file indexing is enabled.
          default: false
        indexingSettings:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerBackupJobIndexingSettings'
          description: Array of VMs with guest OS file indexing options.
          nullable: true
      description: Guest OS file indexing.
      x-veeam-create-by-default: true
    BackupServerCloudDirectorBackupJobIndexingSettings:
      required:
        - vmObject
      type: object
      properties:
        vmObject:
          $ref: '#/components/schemas/BackupServerCloudDirectorObject'
        windowsIndexing:
          $ref: '#/components/schemas/BackupServerBackupJobObjectIndexing'
        linuxIndexing:
          $ref: '#/components/schemas/BackupServerBackupJobObjectIndexing'
      description: VM with guest OS file indexing options.
    BackupServerBackupJobIndexingSettings:
      required:
        - vmObject
      type: object
      properties:
        vmObject:
          $ref: '#/components/schemas/BackupServerVmwareObject'
        windowsIndexing:
          $ref: '#/components/schemas/BackupServerBackupJobObjectIndexing'
        linuxIndexing:
          $ref: '#/components/schemas/BackupServerBackupJobObjectIndexing'
      description: VM with guest OS file indexing options.
    BackupServerBackupJobObjectIndexing:
      required:
        - guestFSIndexingMode
      type: object
      properties:
        guestFSIndexingMode:
          $ref: '#/components/schemas/BackupServerBackupJobGuestFSIndexingMode'
        indexingList:
          type: array
          items:
            type: string
          description: "Array of folders.\n>Environmental variables and full paths to folders can be used.\n"
          nullable: true
      description: Guest OS indexing options for a VM.
      nullable: true
    BackupServerBackupJobGuestFSIndexingMode:
      enum:
        - disable
        - indexAll
        - indexAllExcept
        - indexOnly
      type: string
      description: Indexing mode.
      x-ms-enum:
        name: BackupServerBackupJobGuestFSIndexingMode
    BackupServerBackupJobGuestOsCredentials:
      required:
        - credentialsId
        - credentialsType
      type: object
      properties:
        credentialsId:
          type: string
          description: UID assigned to a credentials record that is used to access Microsoft Windows VMs.
          format: uuid
        credentialsType:
          $ref: '#/components/schemas/BackupServerCredentialsType'
        credentialsPerMachine:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/BackupServerBackupJobGuestOsCredentialsPerMachine'
          description: Array of individual credentials for VMs.
          nullable: true
      description: VM custom credentials.
      nullable: true
    BackupServerCredentialsType:
      enum:
        - Unknown
        - Standard
        - Linux
      type: string
      description: Credentials type.
      x-extensible-enum: true
      x-ms-enum:
        name: BackupServerCredentialsType
    BackupServerBackupJobGuestOsCredentialsPerMachine:
      required:
        - vmObject
      type: object
      properties:
        windowsCredentialsId:
          type: string
          description: UID assigned to a credentials record that is used to access Microsoft Windows VM.
          format: uuid
          nullable: true
        linuxCredentialsId:
          type: string
          description: UID assigned to a credentials record that is used to access Linux VM.
          format: uuid
          nullable: true
        vmObject:
          $ref: '#/components/schemas/BackupServerVmwareObject'
      description: Individual VM credentials.
    BackupServerBackupJobSchedule:
      type: object
      properties:
        runAutomatically:
          type: boolean
          description: Indicates whether job scheduling is enabled.
          default: false
        daily:
          $ref: '#/components/schemas/BackupServerBackupJobScheduleDaily'
        monthly:
          $ref: '#/components/schemas/BackupServerBackupJobScheduleMonthly'
        periodically:
          $ref: '#/components/schemas/BackupServerBackupJobSchedulePeriodically'
        continuously:
          $ref: '#/components/schemas/BackupServerBackupJobScheduleBackupWindow'
        afterThisJob:
          $ref: '#/components/schemas/BackupServerBackupJobScheduleAfterThisJob'
        retry:
          $ref: '#/components/schemas/BackupServerBackupJobScheduleRetry'
        backupWindow:
          $ref: '#/components/schemas/BackupServerBackupJobScheduleBackupWindow'
      description: Job scheduling settings.
      x-veeam-create-by-default: true
    BackupServerBackupJobScheduleDaily:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether daily schedule is enabled.
          default: false
        localTime:
          type: string
          description: Local time when a job must start.
          format: time-of-day
          nullable: true
        dailyKind:
          $ref: '#/components/schemas/BackupServerBackupJobDailyKinds'
        days:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/DaysOfWeekNullable'
          description: Days of the week when the job must start.
          nullable: true
      description: Daily job scheduling settings.
      nullable: true
    BackupServerBackupJobDailyKinds:
      enum:
        - Everyday
        - WeekDays
        - SelectedDays
      type: string
      description: Type of daily job scheduling.
      nullable: true
      x-ms-enum:
        name: BackupServerBackupJobDailyKinds
    BackupServerBackupJobScheduleMonthly:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether monthly schedule is enabled.
          default: false
        localTime:
          type: string
          description: Local time when a job must start.
          format: time-of-day
          nullable: true
        dayOfWeek:
          $ref: '#/components/schemas/DaysOfWeekNullable'
        dayNumberInMonth:
          $ref: '#/components/schemas/BackupServerBackupJobDayNumberInMonth'
        dayOfMonth:
          maximum: 32
          minimum: 1
          type: integer
          description: Numerical value of the day of the month on which a job must start.
          format: int32
          nullable: true
        months:
          uniqueItems: true
          type: array
          items:
            $ref: '#/components/schemas/Month'
          description: Array of months when a job must start.
          nullable: true
      description: Monthly job scheduling settings.
      nullable: true
    BackupServerBackupJobSchedulePeriodically:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether periodic job schedule is enabled.
          default: false
        periodicallyKind:
          $ref: '#/components/schemas/BackupServerBackupJobPeriodicallyKindsNullable'
        frequency:
          maximum: 1440
          minimum: 1
          type: integer
          description: Number of time units that define schedule periods.
          format: int32
          nullable: true
        backupWindow:
          $ref: '#/components/schemas/BackupServerBackupJobWindowSetting'
        startTimeWithinAnHour:
          maximum: 59
          minimum: 0
          type: integer
          description: 'Start time within an hour, in minutes.'
          format: int32
          nullable: true
      description: Periodic job scheduling options.
      nullable: true
    BackupServerBackupJobPeriodicallyKindsNullable:
      enum:
        - Hours
        - Minutes
        - Seconds
        - Days
      type: string
      description: Time unit for periodic job scheduling.
      nullable: true
      x-ms-enum:
        name: BackupServerBackupJobPeriodicallyKinds
    BackupServerBackupJobWindowSetting:
      required:
        - days
      type: object
      properties:
        days:
          type: array
          items:
            $ref: '#/components/schemas/BackupServerBackupJobWindowDayHours'
      description: Array of daily schemes that define backup window.
      nullable: true
    BackupServerBackupJobWindowDayHours:
      required:
        - day
        - hours
      type: object
      properties:
        day:
          $ref: '#/components/schemas/DaysOfWeek'
        hours:
          type: string
          description: String that represents 24 hours where `1` is an hour when job run is permitted and *0* is an hour when job run is denied.
      description: Daily scheme.
    BackupServerBackupJobScheduleBackupWindow:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether backup window is enabled.
          default: false
        backupWindow:
          $ref: '#/components/schemas/BackupServerBackupJobWindowSetting'
      description: Backup window settings.
      nullable: true
    BackupServerBackupJobScheduleAfterThisJob:
      required:
        - isEnabled
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether job chaining is enabled.
        jobName:
          maxLength: 125
          minLength: 1
          type: string
          description: Name of a preceding job.
          nullable: true
      description: Job chaining settings.
      nullable: true
    BackupServerBackupJobScheduleRetry:
      type: object
      properties:
        isEnabled:
          type: boolean
          description: Indicates whether job retries are enabled.
          default: false
          nullable: true
        retryCount:
          maximum: 999
          minimum: 1
          type: integer
          description: "Number of retries set for the job.\n>Must be greater than zero.\n"
          format: int32
          default: 3
          nullable: true
        awaitMinutes:
          maximum: 999
          minimum: 1
          type: integer
          description: "Time interval between job retries, in minutes.\n>Must be greater than zero.\n"
          format: int32
          default: 10
          nullable: true
      description: Job retry settings.
      nullable: true
    ManagementAgentCredentials:
      required:
        - username
        - password
      type: object
      properties:
        username:
          maxLength: 128
          minLength: 1
          pattern: '^[^\\/:*?"<>|]+\\[^\\/\[\]:;|=,+*?<>@"]+$'
          type: string
          description: Username in the `DOMAIN\username` format.
        password:
          maxLength: 256
          minLength: 1
          type: string
          description: Password.
          format: password
    ActivityLog:
      type: object
      properties:
        message:
          type: string
          description: Description of an activity.
          readOnly: true
        activityLogType:
          $ref: '#/components/schemas/ActivityLogType'
        activityKind:
          $ref: '#/components/schemas/ActivityLogKind'
        date:
          type: string
          description: Date and time when an activity was performed.
          format: date-time
          readOnly: true
        userUid:
          type: string
          description: UID assigned to a user that initiated an activity.
          format: uuid
          nullable: true
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization.
          format: uuid
          nullable: true
          readOnly: true
    ActivityLogKind:
      enum:
        - Internal
        - External
      type: string
      description: Type of an activity.
      readOnly: true
    ManagementAgentTask:
      type: object
      properties:
        instanceUid:
          type: string
          description: UID assigned to a management agent task.
          format: uuid
          readOnly: true
        taskType:
          $ref: '#/components/schemas/ManagementAgentTaskType'
        status:
          $ref: '#/components/schemas/ManagementAgentTaskStatus'
        description:
          type: string
          description: Description of a management agent task.
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
          readOnly: true
        startTime:
          type: string
          description: Start date and time of a management agent task.
          format: date-time
          nullable: true
          readOnly: true
        endTime:
          type: string
          description: End date and time of a management agent task.
          format: date-time
          nullable: true
          readOnly: true
    ManagementAgentTaskStatus:
      enum:
        - Unknown
        - Success
        - Running
        - Scheduled
        - Canceled
        - Failed
      type: string
      description: Status of a management agent task.
      readOnly: true
    ManagementAgentTaskType:
      enum:
        - Unknown
        - BackupAgentDeployment
        - BackupAgentRemoval
        - BackupAgentUiModeChange
        - BackupAgentJobStop
        - BackupAgentJobStart
        - BackupAgentJobRemoval
        - BackupAgentSettingsChange
        - BackupAgentJobChange
        - BackupAgentActivationStatusChange
        - BackupAgentServiceRestart
        - BackupAgentCbtDriverDeployment
        - BackupAgentCbtDriverRemoval
        - BackupRepositoryReconfiguration
        - ComputerReboot
        - CloudGatewayListUpdate
        - DataCollectionJob
        - FilesUpload
        - FilesDownload
        - FailoverPlanExecution
        - ManagementAgentUpdate
        - ManagementAgentVersionCheck
        - ManagementAgentTaskStart
        - ManagementAgentMasterRoleRemoval
        - ManagementAgentMasterRoleAssignment
        - ManagementAgentConnectionAttempt
        - ManagementAgentPatchDeployment
        - ManagementAgentRemoval
        - ManagementAgentConnectionSettingsUpdate
        - NewBackupServerIdCreation
        - RemoteComputerDiscovery
        - TasksQueueCleanUp
        - VBRJobActionExecution
        - VBRDeployment
        - VBRUpgrade
        - VBRPatching
        - VBRIsoPredownload
        - BackupAgentUpgrade
        - BackupAgentPatch
      type: string
      description: Type of a management agent task.
      readOnly: true
      x-extensible-enum: true
    ActivityLogType:
      enum:
        - Unknown
        - LoginSuccessful
        - LoginFailed
        - CompanyCreated
        - CompanyModified
        - CompanyDeleted
        - ManagementAgentDisconnected
        - ManagementAgentConnected
        - ManagementAgentDeleted
        - PortalBrandingModified
        - CompanyUserRoleModified
        - CompanyUserModified
        - CompanyUserCreated
        - CompanyUserRemoved
        - CompanyLocationModified
        - CompanyLocationCreated
        - CompanyLocationRemoved
        - DiscoveryRuleModified
        - DiscoveryRuleCreated
        - DiscoveryRuleRemoved
        - CompanyUserLocationCreated
        - CompanyUserLocationRemoved
        - CompanyUserStatusUpdated
        - CompanyStatusUpdated
        - BackupPolicyModified
        - BackupPolicyCreated
        - BackupPolicyRemoved
        - LicenseInstalled
        - LicenseUpdated
        - ProductUsageStatisticsSent
        - UserRecordCreated
        - UserRecordRemoved
        - UserRecordModified
        - UserRecordEnabled
        - UserRecordDisabled
        - CompanyRestored
        - ResellerCreated
        - ResellerModified
        - ResellerDeleted
        - ResellerStatusUpdated
        - UserLoginTypeCreated
        - UserLoginTypeRemoved
        - UserTokenRevoked
        - UserRecordRecreated
        - CompanyRESTAPIAccessModified
        - ResellerRESTAPIAccessModified
        - CompanyMFAPolicyModified
        - CompanyMFAPolicyEnforcementUpdated
        - ProviderUserMFAPolicyModified
        - ClientUserMFAPolicyModified
        - SSOLoginFailed
        - SSOCompanyMatchingFailed
        - SsoLoginSuccesful
        - SSOUserRoleUpdate
        - SsoIdentityProviderAdded
        - SsoIdentityProviderUpdated
        - SsoIdentityProviderRemoved
        - SsoIdentityProviderRuleAdded
        - SsoIdentityProviderRuleUpdated
        - SsoIdentityProviderRuleRemoved
        - SsoIdentityProviderRuleStatusUpdated
        - SsoIdentityProviderStatusUpdated
        - SSOIdentityProviderValidationFailed
        - LicenseAssigned
        - LicenseRevoked
        - VCSPPulseTenantCreated
        - VCSPPulseTenantMapped
        - VCSPPulseTenantUnmapped
        - LicenseUsageReportFinalized
        - UserImpersonationSuccessful
        - DeploymentTaskRecordReset
        - ManagementAgentRegistered
        - ManagementAgentRejected
        - ManagementAgentAssigned
        - ManagementAgentAccepted
        - CompanyAuthenticationTokenReset
        - AgentPackagesDownloaded
        - ManagementAgentCertificateChanged
        - RestorePerformed
        - LicenseModified
        - PublicCloudApplianceDeploymentStarted
        - PublicCloudApplianceRegistrationStarted
        - PublicCloudApplianceDeleted
        - PublicCloudAccountCreated
        - PublicCloudAccountChanged
        - PublicCloudAccountDeleted
        - PublicCloudApplianceMapped
        - PublicCloudApplianceUnmapped
        - BackupJobStarted
        - BackupJobStopped
        - BackupJobCreated
        - BackupJobModified
        - BackupJobDeleted
        - BackupJobAssigned
        - BackupJobRevoked
        - BackupJobEnabled
        - BackupJobDisabled
        - BackupJobRetried
        - BackupUserCredentialsAdded
        - BackupUserCredentialsModified
        - BackupUserCredentialsRemoved
        - vSphereTagAssigned
        - vSphereTagRevoked
        - VCDOrganizationMapped
        - 'VCDOrganizationUnmapped,'
        - BackupServerResourceAdded
        - BackupServerResourceRemoved
        - BackupRepositoryAdded
        - SupportCaseCreated
        - SupportCaseAttachmentUploaded
        - VB365JobCreated
        - VB365CopyJobCreated
        - VB365JobModified
        - VB365JobDeleted
        - VB365JobStarted
        - VB365JobStopped
        - VB365JobEnabled
        - VB365JobDisabled
        - VB365OrganizationCreated
        - VB365OrganizationModified
        - VB365OrganizationDeleted
        - VB365OrganizationMapped
        - VB365OrganizationUnmapped
        - AgentStoredCredentialsChanged
        - VbrIsoPredownloadStarted
        - VbrIsoPredownloadCancelled
        - BackupServerEncryptionPasswordAdded
        - BackupServerEncryptionPasswordModified
        - BackupServerEncryptionPasswordDeleted
        - VbrUidRegenerated
        - VOneUidRegenerated
        - ProxySessionOpened
        - ProxySessionClosed
        - TenantCreated
        - TenantModified
        - TenantRemoved
        - TenantEnabled
        - TenantDisabled
        - TenantAssigned
        - TenantUnassigned
      type: string
      description: Activity variation.
      readOnly: true
      x-extensible-enum: true
    PermissionClaims:
      enum:
        - PublicCloudJobCreate
        - PublicCloudJobEdit
        - PublicCloudJobDelete
        - PublicCloudJobStartStop
        - PublicCloudJobEnableDisable
        - HostedVbm365JobCreate
        - HostedVbm365JobEdit
        - HostedVbm365JobDelete
        - HostedVbm365JobStartStop
        - HostedVbm365JobEnableDisable
        - HostedVbm365JobScopeWrite
        - HostedVbm365JobRepositoryWrite
        - HostedVbm365JobScheduleWrite
        - HostedVbrJobCreate
        - HostedVbrJobEdit
        - HostedVbrJobDelete
        - HostedVbrJobStartStop
        - HostedVbrJobEnableDisable
        - HostedVbrJobScopeWrite
        - HostedVbrJobStorageWrite
        - HostedVbrJobRetentionWrite
        - HostedVbrJobGuestProcessingWrite
        - HostedVbrJobScheduleWrite
      type: string
      x-ms-enum:
        name: PermissionClaims
    EntityPermissions:
      required:
        - claims
      type: object
      properties:
        claims:
          type: array
          items:
            $ref: '#/components/schemas/PermissionClaims'
          description: Array of permission claims assigned to a Veeam Service Provider Console entity.
    ProxyProductInformation:
      type: object
      properties:
        proxyProduct:
          $ref: '#/components/schemas/ProxyProduct'
        proxyProductUrlRepresentation:
          type: string
          description: Part of URL path that must be used to proxy requests to a Veeam product.
          readOnly: true
    ProxyProduct:
      enum:
        - VeeamBackupReplication
        - VeeamBackupMicrosoft365
        - VeeamONE
      type: string
      description: Veeam product that accepts proxied requests.
      readOnly: true
    ProxySession:
      type: object
      properties:
        userUid:
          type: string
          description: UID of a user that created a proxy session.
          format: uuid
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
          readOnly: true
        product:
          $ref: '#/components/schemas/ProxyProduct'
        creationTime:
          type: string
          description: Date and time when a proxy session was created.
          format: date-time
          readOnly: true
        lastActionTime:
          type: string
          description: Date and time of the latest action performed inside a proxy session.
          format: date-time
          readOnly: true
    DiscoverActiveDirectoryTreeInput:
      type: object
      properties:
        discoveryRuleUid:
          type: string
          description: UID assigned to a discovery rule.
          format: uuid
          nullable: true
        serviceAccount:
          type: object
          allOf:
            - $ref: '#/components/schemas/DiscoveryRuleCredentials'
          description: "Credentials of an account with Local Administrator permissions on discovered computers.\n> The null value indicates that management agent credentials will be used as service account credentials.\n"
          nullable: true
    ActiveDirectoryTreeNode:
      type: object
      properties:
        id:
          type: string
          description: ID assigned to an organizational unit.
          readOnly: true
        name:
          type: string
          description: Name of an organizational unit.
          readOnly: true
        children:
          type: array
          items:
            $ref: '#/components/schemas/ActiveDirectoryTreeNode'
          description: Array of child organizational units.
          nullable: true
          readOnly: true
        type:
          $ref: '#/components/schemas/ActiveDirectoryTreeNodeType'
        leaf:
          type: boolean
          description: Indicates whether an organizational unit has child objects.
          readOnly: true
    ActiveDirectoryTreeNodeType:
      enum:
        - CommonName
        - OrganizationalUnit
        - DomainComponent
      type: string
      description: Type of an organizational unit.
      readOnly: true
    JobSessionHeatmap:
      type: object
      properties:
        successJobsCount:
          type: integer
          description: Number of successful job sessions.
          format: int32
          readOnly: true
        warningJobsCount:
          type: integer
          description: Number of job sessions that ended with warnings.
          format: int32
          readOnly: true
        failJobsCount:
          type: integer
          description: Number of failed job sessions.
          format: int32
          readOnly: true
        dataPerDays:
          type: array
          items:
            $ref: '#/components/schemas/JobSessionHeatmapDailyData'
          description: Detailed information on job sessions on each day.
          nullable: true
          readOnly: true
    JobSessionHeatmapDailyData:
      type: object
      properties:
        date:
          type: string
          description: Date.
          format: date
          readOnly: true
        sessions:
          type: array
          items:
            $ref: '#/components/schemas/JobSessionHeatmapSession'
          description: Array of job sessions.
          nullable: true
          readOnly: true
    JobSessionHeatmapSession:
      type: object
      properties:
        jobName:
          type: string
          description: Name of a job.
          readOnly: true
        serverName:
          type: string
          description: Name of a server on which a job is configured.
          readOnly: true
        managementAgentUid:
          type: string
          description: UID assigned to a management agent.
          format: uuid
          readOnly: true
        locationName:
          type: string
          description: Name of a location to which a job belongs.
          readOnly: true
        locationUid:
          type: string
          description: UID assigned to a location to which a job belongs.
          format: uuid
          readOnly: true
        organizationName:
          type: string
          description: Name of an organization to which a job belongs.
          readOnly: true
        organizationUid:
          type: string
          description: UID assigned to an organization to which a job belongs.
          format: uuid
          readOnly: true
        startTime:
          type: string
          description: Date and time when a job session started.
          format: date-time
          readOnly: true
        endTime:
          type: string
          description: Date and time when a job session ended.
          format: date-time
          readOnly: true
        duration:
          type: integer
          description: 'Time taken to complete a job session, in seconds.'
          format: int32
          readOnly: true
        sessionUid:
          type: string
          description: UID assigned to a job session.
          format: uuid
          readOnly: true
        failureMessage:
          type: string
          description: Information on job sessions that finished with errors and warnings.
          nullable: true
          readOnly: true
        timeShiftMinutes:
          type: integer
          description: 'Offset from the local time of a job session, in minutes.'
          format: int32
          readOnly: true
        result:
          $ref: '#/components/schemas/JobSessionHeatmapJobResult'
        jobType:
          $ref: '#/components/schemas/JobSessionHeatmapJobType'
        workloadType:
          $ref: '#/components/schemas/JobSessionHeatmapWorkloadType'
        platformType:
          $ref: '#/components/schemas/JobSessionHeatmapPlatformType'
    JobSessionHeatmapJobType:
      enum:
        - Unknown
        - Backup
        - Replication
        - BackupCopy
        - BackupToTape
        - FfileToTape
        - Copy
        - SureBackup
        - Snapshot
        - RemoteSnapshot
        - Archive
      type: string
      description: Type of a job.
      readOnly: true
    JobSessionHeatmapWorkloadType:
      enum:
        - Unknown
        - Vm
        - Computer
        - FileShare
        - ObjectStorage
        - Logs
        - User
        - File
        - CloudVM
        - CloudFileShare
        - CloudDatabase
        - CloudNetwork
      type: string
      description: Type of workloads processed by a job session.
      readOnly: true
    JobSessionHeatmapPlatformType:
      enum:
        - Unknown
        - Physical
        - VSphere
        - VCD
        - HyperV
        - AHV
        - Aws
        - Azure
        - Google
        - Microsoft365
        - RHV
        - ProxmoxVe
        - ScaleComputing
      type: string
      description: Platform of processed workloads.
      readOnly: true
    JobSessionHeatmapJobResult:
      enum:
        - Unknown
        - Success
        - Warning
        - Failed
      type: string
      description: Result of a job session.
      readOnly: true
    EnableDisablePluginRequest:
      type: object
      properties:
        enabled:
          type: boolean
          description: Defines whether a plugin is enabled.
          default: true
    AssignPluginApiKeyRequest:
      type: object
      properties:
        apiKey:
          type: string
          description: API key that must be assigned to a plugin.
          nullable: true
    UpdatePluginOrganizationRulesRequest:
      type: object
      properties:
        allowOrganizationIds:
          type: array
          items:
            type: string
            default: ''
          description: Array of IDs assigned to organizations that are permitted to access plugin.
          nullable: true
        denyOrganizationIds:
          type: array
          items:
            type: string
            default: ''
          description: Array of IDs assigned to organizations that are not permitted to access plugin.
          nullable: true
        allowOrganizationsByDefault:
          type: boolean
          description: "Defines whether all other organizations are permitted to access plugin by default.\n> Provide the `null` value to keep the current settings.\n"
          nullable: true
    UpdatePluginAgentRulesRequest:
      type: object
      properties:
        allowAgemtIds:
          type: array
          items:
            type: string
            default: ''
          description: Array of IDs assigned to management agents that are permitted to access plugin.
          nullable: true
        denyAgentIds:
          type: array
          items:
            type: string
            default: ''
          description: Array of IDs assigned to management agents that are not permitted to access plugin.
          nullable: true
        allowAgentsByDefault:
          type: boolean
          description: "Defines whether all other management agents are permitted to access plugin by default.\n> Provide the `null` value to keep the current settings.\n"
          nullable: true
    PluginInfo:
      type: object
      properties:
        pluginId:
          type: string
          description: ID assigned to a plugin.
          format: uuid
          readOnly: true
        name:
          type: string
          description: Name of a plugin.
          readOnly: true
        icon:
          type: string
          description: Path to a plugin icon file.
          readOnly: true
        description:
          type: string
          description: Description of a plugin.
          readOnly: true
        version:
          type: string
          description: Version of a plugin.
          readOnly: true
        availableVersions:
          type: array
          items:
            type: string
            readOnly: true
          description: Array of available plugin versions.
          readOnly: true
        enabled:
          type: boolean
          description: Indicates whether a plugin is enabled.
          readOnly: true
        hasApiKey:
          type: boolean
          description: Indicates whether API key is assigned to a plugin.
          readOnly: true
        supportedFeatures:
          type: array
          items:
            $ref: '#/components/schemas/PluginFeature'
          description: Array of supported plugin features.
          readOnly: true
        agentPermissionRules:
          type: object
          properties:
            rules:
              type: array
              items:
                $ref: '#/components/schemas/PluginPermissionRule'
              description: Array of plugin access rules configured for management agents.
              readOnly: true
            agentsAreAllowedByDefault:
              type: boolean
              description: Indicates whether all other management agents are permitted to access plugin by default.
              readOnly: true
          description: Plugin access rules configured for management agents.
          readOnly: true
        organizationPermissionRules:
          type: object
          properties:
            rules:
              type: array
              items:
                $ref: '#/components/schemas/PluginPermissionRule'
              description: Array of plugin access rules configured for organizations.
              readOnly: true
            organizationsAreAllowedByDefault:
              type: boolean
              description: Indicates whether all other organizations are permitted to access plugin by default.
              readOnly: true
          description: Plugin access rules configured for organizations.
          readOnly: true
    PluginPermissionRule:
      type: object
      properties:
        id:
          type: string
          description: ID assigned to an organization or management agent.
          readOnly: true
        allowed:
          type: boolean
          description: Indicates whether an organization or management agent is allowed to access a plugin.
          readOnly: true
      readOnly: true
    PluginVersionInfo:
      type: object
      properties:
        pluginId:
          type: string
          description: ID assigned to a plugin.
          format: uuid
          readOnly: true
        version:
          type: string
          description: Plugin version.
          readOnly: true
    PluginFeature:
      enum:
        - RestApiKey
        - Agent
        - HealthMonitoring
        - ReadinessCheck
        - DataPurge
        - LogsDownload
        - LeasedDatabase
      type: string
    PluginUserLoginData:
      type: object
      properties:
        logged:
          type: boolean
          description: Indicates whether user account is logged in.
          readOnly: true
        user:
          type: object
          allOf:
            - $ref: '#/components/schemas/User'
          readOnly: true
        serviceTimeZone:
          type: object
          properties:
            id:
              type: string
              description: ID assigned to a time zone.
              readOnly: true
            description:
              type: string
              description: Description of a time zone.
              readOnly: true
            utcOffsetInMinutes:
              type: integer
              description: 'Time zone UTC offset, in minutes.'
              format: int32
              readOnly: true
          readOnly: true
        version:
          type: string
          description: Plugin version.
          readOnly: true
        sessionExpirationTime:
          type: integer
          description: 'Session expiration time, in seconds.'
          format: int32
          readOnly: true
        tokenProlongationPeriod:
          type: integer
          description: 'Token prolongation period, in seconds.'
          format: int32
          readOnly: true
        formats:
          $ref: '#/components/schemas/PluginUserLoginDataFormats'
        colorScheme:
          type: string
          description: Color scheme of Veeam Service Provider Console Administrator Portal.
          readOnly: true
        portalName:
          type: string
          description: Name of Veeam Service Provider Console Administrator Portal.
          readOnly: true
    PluginUserLoginDataFormats:
      type: object
      properties:
        netShortTime:
          type: string
          description: Custom format string for short time in the .NET format.
          readOnly: true
        netLongTime:
          type: string
          description: Custom format string for long time in the .NET format.
          readOnly: true
        netShortDate:
          type: string
          description: Custom format string for short date in the .NET format.
          readOnly: true
        shortTime:
          type: string
          description: Custom format string for short time in the PHP format.
          readOnly: true
        longTime:
          type: string
          description: Custom format string for long time in the PHP format.
          readOnly: true
        shortDate:
          type: string
          description: Custom format string for short date in the PHP format.
          readOnly: true
      readOnly: true
    PluginCharge:
      type: object
      properties:
        pluginId:
          type: string
          description: ID assigned to a plugin.
          format: uuid
          readOnly: true
        chargeUid:
          type: string
          description: UID assigned to an external plugin charge rate.
          format: uuid
          readOnly: true
        displayName:
          type: string
          description: Name of an external plugin charge rate.
          readOnly: true
        categoryId:
          type: string
          description: ID assigned to a external plugin charge rate category.
          readOnly: true
        categoryDisplayName:
          type: string
          description: Name of an external plugin charge rate category.
          readOnly: true
        measureCategory:
          $ref: '#/components/schemas/MeasureCategory'
    OAuth2Result:
      type: object
      properties:
        access_token:
          type: string
          description: Access token.
          nullable: true
          readOnly: true
        token_type:
          type: string
          description: Token type.
          nullable: true
          readOnly: true
        refresh_token:
          type: string
          description: Refresh token.
          nullable: true
          readOnly: true
        mfa_token:
          type: string
          description: MFA token.
          nullable: true
          readOnly: true
        encrypted_code:
          type: string
          description: Encrypted authorization code.
          nullable: true
          readOnly: true
        expires_in:
          type: integer
          description: Date and time when an access token will expire.
          format: int32
          readOnly: true
    OAuth2Error:
      type: object
      properties:
        error:
          enum:
            - invalid_request
            - invalid_client
            - invalid_grant
            - unauthorized_client
            - unsupported_grant_type
            - invalid_scope
          type: string
          description: Error type.
          readOnly: true
          x-name: OAuth2ErrorCode
        error_description:
          type: string
          description: Error description.
          readOnly: true
        error_uri:
          type: string
          description: Error URI.
          nullable: true
          readOnly: true
      example:
        error: invalid_request
        error_description: 'Cannot complete login due to incorrect username or password, or no sufficient rights.'
        error_uri: 
    ResellerExpand:
      enum:
        - Organization
      type: string
      x-ms-enum:
        name: ResellerExpand
    IdentityProviderRoleMappingRuleExpand:
      enum:
        - IdentityProvider
      type: string
      x-ms-enum:
        name: IdentityProviderRoleMappingRuleExpand
    CompanyExpand:
      enum:
        - Organization
      type: string
      x-ms-enum:
        name: CompanyExpand
    ProviderExpand:
      enum:
        - Organization
      type: string
      x-ms-enum:
        name: ProviderExpand
    WindowsDiscoveryRuleExpand:
      enum:
        - DiscoveryRule
      type: string
      x-ms-enum:
        name: WindowsDiscoveryRuleExpand
    WindowsNetworkBasedDiscoveryRuleExpand:
      enum:
        - DiscoveryRule
        - WindowsDiscoveryRule
      type: string
      x-ms-enum:
        name: WindowsNetworkBasedDiscoveryRuleExpand
    WindowsActiveDirectoryBasedDiscoveryRuleExpand:
      enum:
        - DiscoveryRule
        - WindowsDiscoveryRule
      type: string
      x-ms-enum:
        name: WindowsActiveDirectoryBasedDiscoveryRuleExpand
    WindowsCustomDiscoveryRuleExpand:
      enum:
        - DiscoveryRule
        - WindowsDiscoveryRule
      type: string
      x-ms-enum:
        name: WindowsCustomDiscoveryRuleExpand
    LinuxDiscoveryRuleExpand:
      enum:
        - DiscoveryRule
      type: string
      x-ms-enum:
        name: LinuxDiscoveryRuleExpand
    LinuxNetworkBasedDiscoveryRuleExpand:
      enum:
        - DiscoveryRule
        - LinuxDiscoveryRule
      type: string
      x-ms-enum:
        name: LinuxNetworkBasedDiscoveryRuleExpand
    LinuxCustomDiscoveryRuleExpand:
      enum:
        - DiscoveryRule
        - LinuxDiscoveryRule
      type: string
      x-ms-enum:
        name: LinuxCustomDiscoveryRuleExpand
    BackupRepositoryExpand:
      enum:
        - BackupRepositoryInfo
      type: string
      x-ms-enum:
        name: BackupRepositoryExpand
    BackupServerBackupVmJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerBackupVmJobExpand
    BackupServerReplicationVmJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerReplicationVmJobExpand
    BackupServerCdpReplicationJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerCdpReplicationJobExpand
    BackupServerBackupCopyJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerBackupCopyJobExpand
    BackupServerFileShareJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerFileShareJobExpand
    BackupServerFileShareCopyJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerFileShareCopyJobExpand
    BackupServerObjectStorageBackupJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerObjectStorageBackupJobExpand
    BackupServerObjectStorageBackupCopyJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerObjectStorageBackupCopyJobExpand
    BackupServerSimpleBackupCopyJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerSimpleBackupCopyJobExpand
    BackupServerVmCopyJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerVmCopyJobExpand
    BackupServerFileCopyJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerFileCopyJobExpand
    BackupServerFileTapeJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerFileTapeJobExpand
    BackupServerBackupTapeJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerBackupTapeJobExpand
    BackupServerAgentJobExpand:
      enum:
        - BackupServerJob
      type: string
      x-ms-enum:
        name: BackupServerAgentJobExpand
    Vb365OrganizationBaseExpand:
      enum:
        - OrganizationDetails
        - Vb365Server
      type: string
      x-ms-enum:
        name: Vb365OrganizationBaseExpand
    Vb365Microsoft365OrganizationExpand:
      enum:
        - OrganizationBase
      type: string
      x-ms-enum:
        name: Vb365Microsoft365OrganizationExpand
  parameters:
    managementAgentUid_path:
      name: managementAgentUid
      in: path
      description: Management agent UID.
      required: true
      schema:
        type: string
        format: uuid
    backupServerUid_path:
      name: backupServerUid
      in: path
      description: Veeam Backup & Replication server UID.
      required: true
      schema:
        type: string
        format: uuid
    organizationUid_path:
      name: organizationUid
      in: path
      description: Organization UID.
      required: true
      schema:
        type: string
        format: uuid
    companyUid_path:
      name: companyUid
      in: path
      description: Company UID.
      required: true
      schema:
        type: string
        format: uuid
    companyUid_query:
      name: companyUid
      in: query
      description: Company UID.
      required: true
      schema:
        type: string
        format: uuid
    siteUid_path:
      name: siteUid
      in: path
      description: Veeam Cloud Connect site UID.
      required: true
      schema:
        type: string
        format: uuid
    tenantUid_path:
      name: tenantUid
      in: path
      description: Veeam Cloud Connect tenant UID.
      required: true
      schema:
        type: string
        format: uuid
    resellerUid_path:
      name: resellerUid
      in: path
      description: Reseller UID.
      required: true
      schema:
        type: string
        format: uuid
    backupAgentUid_path:
      name: backupAgentUid
      in: path
      description: Veeam backup agent UID.
      required: true
      schema:
        type: string
        format: uuid
    activeFullBackup_query:
      name: activeFullBackup
      in: query
      description: Flag whether Active full backup should be done instead of incremental backup.
      schema:
        type: boolean
    backupAgentUid_Windows_path:
      name: backupAgentUid
      in: path
      description: Veeam Agent for Microsoft Windows UID.
      required: true
      schema:
        type: string
        format: uuid
    backupAgentUid_Mac_path:
      name: backupAgentUid
      in: path
      description: Veeam Agent for Mac UID.
      required: true
      schema:
        type: string
        format: uuid
    backupAgentUid_Linux_path:
      name: backupAgentUid
      in: path
      description: Veeam Agent for Linux UID.
      required: true
      schema:
        type: string
        format: uuid
    vcdOrganizationUid_path:
      name: vcdOrganizationUid
      in: path
      description: VMware Cloud Director organization UID.
      required: true
      schema:
        type: string
        format: uuid
    vcdServerUid_path:
      name: vcdServerUid
      in: path
      description: VMware Cloud Director server UID.
      required: true
      schema:
        type: string
        format: uuid
    backupAgentJobUid_path:
      name: backupAgentJobUid
      in: path
      description: Veeam backup agent job UID.
      required: true
      schema:
        type: string
        format: uuid
    backupAgentJobUid_Windows_path:
      name: backupAgentJobUid
      in: path
      description: Veeam Agent for Microsoft Windows job UID.
      required: true
      schema:
        type: string
        format: uuid
    backupAgentJobUid_Linux_path:
      name: backupAgentJobUid
      in: path
      description: Veeam Agent for Linux job UID.
      required: true
      schema:
        type: string
        format: uuid
    backupAgentJobUid_Mac_path:
      name: backupAgentJobUid
      in: path
      description: Veeam Agent for Mac job UID.
      required: true
      schema:
        type: string
        format: uuid
    backupResourceUid_path:
      name: backupResourceUid
      in: path
      description: UID assigned to a backup resource.
      required: true
      schema:
        type: string
        format: uuid
    replicationResourceUid_path:
      name: replicationResourceUid
      in: path
      description: UID assigned to a replication resource.
      required: true
      schema:
        type: string
        format: uuid
    pluginId_path:
      name: pluginId
      in: path
      description: ID assigned to a plugin.
      required: true
      schema:
        type: string
        format: uuid
tags:
  - name: Preview Operations
    description: Operations that are not fully supported yet and are available for evaluation purposes.
  - name: About
    description: This resource contains information about currently installed Veeam Service Provider Console version.
  - name: Accounts
    description: This resource collection represents user accounts in Veeam Service Provider Console infrastructure.
  - name: Alarms
    description: This resource collection represents Veeam Service Provider Console alarms.
  - name: AsyncActions
    description: This resource collection represent Veeam Service Provider Console REST API async actions.
  - name: Authentication
    description: This resource collection allows to authenticate to Veeam Service Provider Console REST API.
  - name: Backup Agent Jobs
    description: This resource collection represents jobs configured for Veeam backup agents in the Veeam Service Provider Console infrastructure.
  - name: Backup Agents
    description: This resource collection represents Veeam backup agents in Veeam Service Provider Console infrastructure components.
  - name: Backup Policies
    description: This resource collection represents backup policies configured in Veeam Service Provider Console.
  - name: Backup Server Failover Plans
    description: This resource collection represents failover plans.
  - name: Backup Server Jobs
    description: This resource collection represents jobs configured on managed Veeam Backup & Replication servers.
  - name: Backup Server Public Cloud Policies
    description: This resource collection represents Veeam Backup for Public Clouds policies.
  - name: Backup Servers
    description: This resource collection represents managed Veeam Backup & Replication servers.
  - name: Billing
    description: This resource collection represents provided services and their costs.
  - name: Cloud Connect
    description: This resource collection represents sites and their infrastructure components.
  - name: Companies
    description: This resource collection represents companies managed in Veeam Service Provider Console.
  - name: Configuration
    description: This resource collection represents security certificate installed on Veeam Service Provider Console server.
  - name: Containers
    description: This resource collection represents organization containers.
  - name: Deployment
    description: This resource collection represents deployment tasks.
  - name: Discovery
    description: This resource collection represents discovery rules and discovered computers.
  - name: Enterprise Manager
    description: This resource collection represents managed Veeam Backup Enterprise Manager Servers.
  - name: Event Logs
    description: This resource collection represents event log entries.
  - name: Licensing
    description: This resource collection represents licenses in Veeam Service Provider Console.
  - name: Locations
    description: This resource collection represents organization locations.
  - name: Management Agents
    description: This resource collection represents management agents installed on Veeam Service Provider Console infrastructure components.
  - name: Misc
    description: This resource collection represents useful miscellaneous data.
  - name: Organizations
    description: 'This resource collection represent organizations in Veeam Service Provider Console. Organizations include service provider, resellers and companies.'
  - name: Protected Public Cloud Workloads
    description: This resource collection represents protected Veeam Backup for Public Clouds workloads managed in Veeam Service Provider Console.
  - name: Protected Workloads
    description: This resource collection represents workloads managed in Veeam Service Provider Console.
  - name: Provider
    description: This resource collection represents information on service provider.
  - name: Public Cloud
    description: This resource collection represents public cloud entities connected to Veeam Service Provider Console.
  - name: Public Cloud AWS
    description: This resource collection represents AWS entities connected to Veeam Service Provider Console.
  - name: Public Cloud Azure
    description: This resource collection represents Microsoft Azure entities connected to Veeam Service Provider Console.
  - name: Pulse
    description: This resource collection represents VCSP Pulse integration support.
  - name: Resellers
    description: This resource collection represents resellers.
  - name: Single Sign On
    description: This resource collection represents Single Sign-on parameters.
  - name: Subscription Plans
    description: This resource collection represents subscription plans configured in Veeam Service Provider Console.
  - name: Veeam Backup for Microsoft 365 Server
    description: This resource collection represents information on Veeam Backup for Microsoft 365 integration.
  - name: Veeam ONE Server
    description: This resource collection represents information on Veeam ONE integration.
  - name: Plugins
    description: This resource collection represents plugins for Veeam Service Provider Console.