Veeam Credentials API
The Credentials section defines paths and operations for managing credentials records that are added to the backup server.
The Credentials section defines paths and operations for managing credentials records that are added to the backup server.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/veeam-credentials-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.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.
servers:
- url: https://localhost:9419
description: Base URL declared by the provider in apis.yml (roadmap#122).
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:
AzureComputeCredentialsExistingAccountSpec:
description: Existing Azure Active Directory application.
properties:
deployment:
$ref: '#/components/schemas/AzureComputeCloudCredentialsDeploymentModel'
subscription:
$ref: '#/components/schemas/AzureComputeCloudCredentialsSubscriptionSpec'
required:
- deployment
- subscription
type: object
CloudDeviceCodeSpec:
allOf:
- discriminator:
mapping:
AzureCompute: '#/components/schemas/AzureComputeCloudDeviceCodeSpec'
propertyName: type
oneOf:
- $ref: '#/components/schemas/AzureComputeCloudDeviceCodeSpec'
- $ref: '#/components/schemas/BaseCloudDeviceCodeSpec'
BaseCloudHelperApplianceModel:
properties:
type:
$ref: '#/components/schemas/ECloudCredentialsType'
type: object
CredentialsPasswordChangeSpec:
properties:
password:
description: New password.
type: string
required:
- password
type: object
CredentialsModel:
allOf:
- discriminator:
mapping:
Linux: '#/components/schemas/LinuxCredentialsModel'
Standard: '#/components/schemas/StandardCredentialsModel'
propertyName: type
oneOf:
- $ref: '#/components/schemas/StandardCredentialsModel'
- $ref: '#/components/schemas/LinuxCredentialsModel'
- $ref: '#/components/schemas/BaseCredentialsModel'
AzureLinuxHelperApplianceSpec:
allOf:
- $ref: '#/components/schemas/BaseCloudHelperApplianceSpec'
properties:
SSHPort:
description: Port over which Veeam Backup & Replication communicates with the helper appliance.
type: integer
location:
description: Storage account location where you want to configure the helper appliance.
type: string
resourceGroup:
description: Resource group associated with the helper appliance.
type: string
storageAccount:
description: Name of the Azure storage account whose resources are used to store the helper appliance.
type: string
subnet:
description: Subnet for the helper appliance.
type: string
subscriptionId:
description: ID that Veeam Backup & Replication assigned to the Azure subscription.
format: uuid
type: string
virtualNetwork:
description: Network to which the helper appliance is connected.
type: string
required:
- subscriptionId
type: object
CredentialsSpec:
allOf:
- discriminator:
mapping:
Linux: '#/components/schemas/LinuxCredentialsSpec'
Standard: '#/components/schemas/StandardCredentialsSpec'
propertyName: type
oneOf:
- $ref: '#/components/schemas/StandardCredentialsSpec'
- $ref: '#/components/schemas/LinuxCredentialsSpec'
- $ref: '#/components/sche
# --- truncated at 32 KB (61 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/veeam/refs/heads/main/openapi/veeam-credentials-api-openapi.yml