Veeam Credentials API

The Credentials section defines paths and operations for managing credentials records that are added to the backup server.

OpenAPI Specification

veeam-credentials-api-openapi.yml Raw ↑
openapi: 3.0.0
info:
  version: 1.0-rev0
  title: Veeam Backup for AWS public API 1.0 Agents Credentials API
  description: The Agents section defines paths and operations for managing recovery tokens used for bare metal recovery.
security:
- Bearer: []
tags:
- description: The Credentials section defines paths and operations for managing credentials records that are added to the backup server.
  name: Credentials
paths:
  /api/v1/cloudCredentials:
    get:
      description: The HTTP GET request to the `/api/v1/cloudCredentials` path allows you to get an array of credentials records used to connect to cloud services.
      operationId: GetAllCloudCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: Number of cloud credentials records to skip.
        in: query
        name: skip
        schema:
          format: int32
          type: integer
        x-veeam-spec:
          $ref: '#/components/schemas/CloudCredentialsFilters'
      - description: Maximum number of cloud credentials records to return.
        in: query
        name: limit
        schema:
          format: int32
          type: integer
        x-veeam-spec:
          $ref: '#/components/schemas/CloudCredentialsFilters'
      - description: Sorts cloud credentials by one of the cloud credentials parameters.
        in: query
        name: orderColumn
        schema:
          $ref: '#/components/schemas/ECloudCredentialsFiltersOrderColumn'
        x-veeam-spec:
          $ref: '#/components/schemas/CloudCredentialsFilters'
      - description: Sorts cloud credentials in the ascending order by the `orderColumn` parameter.
        in: query
        name: orderAsc
        schema:
          type: boolean
        x-veeam-spec:
          $ref: '#/components/schemas/CloudCredentialsFilters'
      - description: Filters cloud credentials by the `nameFilter` pattern. The pattern can match any cloud credentials parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.
        in: query
        name: nameFilter
        schema:
          type: string
        x-veeam-spec:
          $ref: '#/components/schemas/CloudCredentialsFilters'
      - in: query
        name: typeFilter
        schema:
          $ref: '#/components/schemas/ECloudCredentialsType'
        x-veeam-spec:
          $ref: '#/components/schemas/CloudCredentialsFilters'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudCredentialsResult'
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get All Cloud Credentials
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ViewCloudCredentials
    post:
      description: The HTTP POST request to the `/api/v1/cloudCredentials` path allows you to add a credentials record used to connect to cloud services.
      operationId: CreateCloudCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudCredentialsSpec'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudCredentialsModel'
          description: Cloud credentials record has been created.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Add Cloud Credentials Record
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - CreateCloudCredentials
  /api/v1/cloudCredentials/appRegistration:
    post:
      description: The HTTP POST request to the `/api/v1/cloudCredentials/appRegistration` path allows you to get a single-use verification code required to register a new Azure Active Directory application.
      operationId: RequestAppRegistrationByDeviceCode
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudDeviceCodeSpec'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudDeviceCodeModel'
          description: Verification code has been received.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get Verification Code
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - CreateCloudCredentials
  /api/v1/cloudCredentials/appRegistration/{verificationCode}:
    post:
      description: The HTTP POST request to the `/api/v1/cloudCredentials/appRegistration/{verificationCode}` path allows you to register a new Azure Active Directory application using the specified `verificationCode`.
      operationId: FinishAppRegistrationByDeviceCode
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: Verification code. To obtain the code, use the [Get Verification Code](#tag/Credentials/operation/RequestAppRegistrationByDeviceCode) request.
        in: path
        name: verificationCode
        required: true
        schema:
          type: string
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudNativeApplicationModel'
          description: Azure Active Directory application has been registered.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Register Azure AD Application
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - CreateCloudCredentials
  /api/v1/cloudCredentials/{id}:
    delete:
      description: The HTTP DELETE request to the `/api/v1/cloudCredentials/{id}` path allows you to remove a cloud credentials record that has the specified `id`.
      operationId: DeleteCloudCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the cloud credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptySuccessResponse'
          description: Cloud credentials record has been removed.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Remove Cloud Credentials Record
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - DeleteCloudCredentials
    get:
      description: The HTTP GET request to the `/api/v1/cloudCredentials/{id}` path allows you to get a cloud credentials record that has the specified `id`.
      operationId: GetCloudCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the cloud credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudCredentialsModel'
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get Cloud Credentials Record
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ViewCloudCredentials
    put:
      description: The HTTP PUT request to the `/api/v1/cloudCredentials/{id}` path allows you to edit a cloud credentials record that has the specified `id`.
      operationId: UpdateCloudCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the cloud credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudCredentialsModel'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudCredentialsModel'
          description: Cloud credentials record has been updated.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Edit Cloud Credentials Record
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - UpdateCloudCredentials
  /api/v1/cloudCredentials/{id}/changeCertificate:
    post:
      description: The HTTP POST request to the `/api/v1/cloudCredentials/{id}/changeCertificate` path allows you to change a certificate used for authentication in your Azure Active Directory application associated with an Azure compute account that has the specified `id`.
      operationId: ChangeCloudCertificate
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the Azure compute account.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CertificateUploadSpec'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudCredentialsModel'
          description: Certificate has been changed.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Change Certificate
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ChangeCloudCertificate
  /api/v1/cloudCredentials/{id}/changeSecretKey:
    post:
      description: The HTTP POST request to the `/api/v1/cloudCredentials/{id}/changeSecretKey` path allows you to change a secret key of a cloud credentials record that has the specified `id`.
      operationId: ChangeCloudCredsSecretKey
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the cloud credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudCredentialsPasswordSpec'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudCredentialsModel'
          description: Secret key has been changed.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Change Secret Key
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ChangeCloudSecretKey
  /api/v1/cloudCredentials/{id}/helperAppliances:
    get:
      description: The HTTP GET request to the `/api/v1/cloudCredentials/{id}/helperAppliances` path allows you to get an array of Lunux-based helper appliances of a Microsoft Azure compute account that has the specified `id`.
      operationId: GetAllCredsHelperAppliances
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the Microsoft Azure compute account.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudHelperApplianceResult'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get All Helper Appliances
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ViewCredentials
    post:
      description: The HTTP POST request to the `/api/v1/cloudCredentials/{id}/helperAppliances` path allows you to create a new Lunux-based helper appliance or edit settings of an existing one for a Microsoft Azure compute account that has the specified `id`.
      operationId: CreateCloudCredsHelperAppliance
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the Microsoft Azure compute account.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CloudHelperApplianceSpec'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SessionModel'
          description: AzureApplianceDeploy session has been created. To check the progress, track the session `state`.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Add or Edit Helper Appliance
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - CreateCloudCredentials
  /api/v1/cloudCredentials/{id}/helperAppliances/{applianceId}:
    delete:
      description: The HTTP DELETE request to the `/api/v1/cloudCredentials/{id}/helperAppliances/{applianceId}` path allows you to remove a Lunux-based helper appliance with the `applianceId` of a Microsoft Azure compute account that has the specified `id`.
      operationId: DeleteCloudCredsHelperAppliance
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the Microsoft Azure compute account.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      - description: ID of the helper appliance.
        in: path
        name: applianceId
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptySuccessResponse'
          description: Helper appliance has been removed.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Remove Helper Appliance
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - DeleteCloudCredentials
    get:
      description: The HTTP GET request to the `/api/v1/cloudCredentials/{id}/helperAppliances/{applianceId}` path allows you to get a Lunux-based helper appliance with the `applianceId` of a Microsoft Azure compute account that has the specified `id`.
      operationId: GetCloudCredsHelperAppliance
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the Microsoft Azure compute account.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      - description: ID of the helper appliance.
        in: path
        name: applianceId
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CloudHelperApplianceModel'
          description: OK
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get Helper Appliance
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - UpdateCloudCredentials
  /api/v1/credentials:
    get:
      description: The HTTP GET request to the `/api/v1/credentials` path allows you to get an array of credentials records that are added to the backup server.
      operationId: GetAllCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: Number of credentials records to skip.
        in: query
        name: skip
        schema:
          format: int32
          type: integer
        x-veeam-spec:
          $ref: '#/components/schemas/CredentialsFilters'
      - description: Maximum number of credentials records to return.
        in: query
        name: limit
        schema:
          format: int32
          type: integer
        x-veeam-spec:
          $ref: '#/components/schemas/CredentialsFilters'
      - description: Sorts credentials by one of the credentials parameters.
        in: query
        name: orderColumn
        schema:
          $ref: '#/components/schemas/ECredentialsFiltersOrderColumn'
        x-veeam-spec:
          $ref: '#/components/schemas/CredentialsFilters'
      - description: Sorts credentials in the ascending order by the `orderColumn` parameter.
        in: query
        name: orderAsc
        schema:
          type: boolean
        x-veeam-spec:
          $ref: '#/components/schemas/CredentialsFilters'
      - description: Filters credentials by the `nameFilter` pattern. The pattern can match any credentials parameter. To substitute one or more characters, use the asterisk (*) character at the beginning and/or at the end.
        in: query
        name: nameFilter
        schema:
          type: string
        x-veeam-spec:
          $ref: '#/components/schemas/CredentialsFilters'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsResult'
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get All Credentials
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ViewCredentials
    post:
      description: The HTTP POST request to the `/api/v1/credentials` path allows you to add a credentials record.
      operationId: CreateCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsSpec'
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsModel'
          description: Account has been added.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Add Credentials Record
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - CreateCredentials
  /api/v1/credentials/{id}:
    delete:
      description: The HTTP DELETE request to the `/api/v1/credentials/{id}` path allows you to remove a credentials record that has the specified `id`.
      operationId: DeleteCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '204':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptySuccessResponse'
          description: Credentials record has been removed.
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Remove Credentials Record
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - DeleteCredentials
    get:
      description: The HTTP GET request to the `/api/v1/credentials/{id}` path allows you to get a credentials record that has the specified `id`.
      operationId: GetCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsModel'
          description: OK
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Get Credentials Record
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ViewCredentials
    put:
      description: The HTTP PUT request to the `/api/v1/credentials/{id}` path allows you to edit a credentials record that has the specified `id`.
      operationId: UpdateCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsModel'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CredentialsModel'
          description: Credentials record has been updated.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Edit Credentials Record
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - UpdateCredentials
  /api/v1/credentials/{id}/changepassword:
    post:
      description: The HTTP POST request to the `/api/v1/credentials/{id}/changepassword` path allows you to change a password of the credentials record that has the specified `id`.
      operationId: ChangePasswordForCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsPasswordChangeSpec'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptySuccessResponse'
          description: Password has been changed.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Change Password
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ChangeAccountPassword
  /api/v1/credentials/{id}/changeprivatekey:
    post:
      description: The HTTP POST request to the `/api/v1/credentials/{id}/changeprivatekey` path allows you to change a Linux private key of the credentials record that has the specified `id`.
      operationId: ChangePrivateKeyForCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PrivateKeyChangeSpec'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptySuccessResponse'
          description: Private key has been changed.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Change Linux Private Key
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ChangeLinuxPrivateKey
  /api/v1/credentials/{id}/changerootpassword:
    post:
      description: The HTTP POST request to the `/api/v1/credentials/{id}/changerootpassword` path allows you to change a Linux root password of the credentials record that has the specified `id`.
      operationId: ChangeRootPasswordForCreds
      parameters:
      - $ref: '#/components/parameters/apiVersionParam'
      - description: ID of the credentials record.
        in: path
        name: id
        required: true
        schema:
          format: uuid
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CredentialsPasswordChangeSpec'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EmptySuccessResponse'
          description: Root password has been changed.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
      summary: Change Linux Root Password
      tags:
      - Credentials
      x-veeam-authorize:
        claims:
        - ChangeLinuxRootPassword
components:
  schemas:
    StandardCredentialsSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCredentialsSpec'
      - properties:
          tag:
            description: Tag used to identify the credentials record.
            type: string
        type: object
    BaseCredentialsModel:
      properties:
        creationTime:
          description: Date and time when the credentials were created.
          format: date-time
          type: string
        description:
          description: Description of the credentials record.
          type: string
        id:
          description: ID of the credentials record.
          format: uuid
          type: string
        type:
          $ref: '#/components/schemas/ECredentialsType'
        username:
          description: User name.
          type: string
      type: object
    CloudHelperApplianceResult:
      properties:
        data:
          description: Array of Lunux-based helper appliances.
          items:
            $ref: '#/components/schemas/CloudHelperApplianceModel'
          type: array
        pagination:
          $ref: '#/components/schemas/PaginationResult'
      required:
      - data
      - pagination
      type: object
    EAzureComputeCredentialsCreationMode:
      description: Mode that defines whether you want to connect to Azure Active Directory using an existing or a newly created Azure Active Directory application.
      enum:
      - NewAccount
      - ExistingAccount
      type: string
    EAzureComputeCredentialsDeploymentType:
      description: Deployment type (global Microsoft Azure or Microsoft Azure Stack Hub).
      enum:
      - MicrosoftAzure
      - MicrosoftAzureStack
      type: string
    GoogleCloudCredentialsSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudCredentialsSpec'
      - properties:
          accessKey:
            description: Access ID of a Google HMAC key.
            type: string
          secretKey:
            description: Secret linked to the access ID.
            type: string
          tag:
            description: Tag used to identify the cloud credentials record.
            type: string
        required:
        - accessKey
        - secretKey
        type: object
    GoogleCloudCredentialsModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudCredentialsModel'
      - properties:
          accessKey:
            description: Access ID of a Google HMAC key.
            type: string
          tag:
            description: Tag used to identify the cloud credentials record.
            type: string
        required:
        - accessKey
        type: object
    AzureComputeCloudDeviceCodeSpec:
      allOf:
      - $ref: '#/components/schemas/BaseCloudDeviceCodeSpec'
      - properties:
          region:
            $ref: '#/components/schemas/EAzureRegionType'
        required:
        - region
        type: object
    AzureLinuxHelperApplianceModel:
      allOf:
      - $ref: '#/components/schemas/BaseCloudHelperApplianceModel'
      - description: Lunux-based helper appliance for Microsoft Azure account.
        properties:
          SSHPort:
            description: Port over which Veeam Backup & 

# --- truncated at 32 KB (60 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/veeam/refs/heads/main/openapi/veeam-credentials-api-openapi.yml