How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Veeam Credentials API

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

Veeam Credentials API is one of 55 APIs that Veeam publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Credentials. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 21 operations across 13 paths, and defines 66 schemas. It is described by OpenAPI 3.0.0, at version 1.0-rev0.

Requests are made against the base URL https://localhost:9419.

21 operations 13 paths 66 schemas 3 DELETE6 GET10 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0-rev0
Base URL
https://localhost:9419
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Veeam Credentials API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Bearer). By default, every request must be authenticated.

  • Bearer — Bearer \

Paths & Operations 21

Across 13 paths, the API surfaces 21 operations — 3 DELETE, 6 GET, 10 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Credentials 21

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

GET
/api/v1/cloudCredentials
Get All Cloud Credentials
GetAllCloudCreds 7 params → 200401403500
POST
/api/v1/cloudCredentials
Add Cloud Credentials Record
CreateCloudCreds 1 param body → 201400401403500
POST
/api/v1/cloudCredentials/appRegistration
Get Verification Code
RequestAppRegistrationByDeviceCode 1 param body → 201400401403500
POST
/api/v1/cloudCredentials/appRegistration/{verificationCode}
Register Azure AD Application
FinishAppRegistrationByDeviceCode 2 params → 201400401403500
DELETE
/api/v1/cloudCredentials/{id}
Remove Cloud Credentials Record
DeleteCloudCreds 2 params → 204401403404500
GET
/api/v1/cloudCredentials/{id}
Get Cloud Credentials Record
GetCloudCreds 2 params → 200401403404500
PUT
/api/v1/cloudCredentials/{id}
Edit Cloud Credentials Record
UpdateCloudCreds 2 params body → 200400401403404500
POST
/api/v1/cloudCredentials/{id}/changeCertificate
Change Certificate
ChangeCloudCertificate 2 params body → 201400401403500
POST
/api/v1/cloudCredentials/{id}/changeSecretKey
Change Secret Key
ChangeCloudCredsSecretKey 2 params body → 201400401403500
GET
/api/v1/cloudCredentials/{id}/helperAppliances
Get All Helper Appliances
GetAllCredsHelperAppliances 2 params → 200400401403500
POST
/api/v1/cloudCredentials/{id}/helperAppliances
Add or Edit Helper Appliance
CreateCloudCredsHelperAppliance 2 params body → 201400401403500
DELETE
/api/v1/cloudCredentials/{id}/helperAppliances/{applianceId}
Remove Helper Appliance
DeleteCloudCredsHelperAppliance 3 params → 204401403404500
GET
/api/v1/cloudCredentials/{id}/helperAppliances/{applianceId}
Get Helper Appliance
GetCloudCredsHelperAppliance 3 params → 200400401403500
GET
/api/v1/credentials
Get All Credentials
GetAllCreds 6 params → 200401403500
POST
/api/v1/credentials
Add Credentials Record
CreateCreds 1 param body → 201400401403500
DELETE
/api/v1/credentials/{id}
Remove Credentials Record
DeleteCreds 2 params → 204401403404500
GET
/api/v1/credentials/{id}
Get Credentials Record
GetCreds 2 params → 200401403404500
PUT
/api/v1/credentials/{id}
Edit Credentials Record
UpdateCreds 2 params body → 200400401403404500
POST
/api/v1/credentials/{id}/changepassword
Change Password
ChangePasswordForCreds 2 params body → 200400401403404500
POST
/api/v1/credentials/{id}/changeprivatekey
Change Linux Private Key
ChangePrivateKeyForCreds 2 params body → 200400401403404500
POST
/api/v1/credentials/{id}/changerootpassword
Change Linux Root Password
ChangeRootPasswordForCreds 2 params body → 200400401403404500

Schemas 66

The contract defines 66 schemas that model the data the API accepts and returns. The most detailed are SessionModel (13 properties), AzureLinuxHelperApplianceSpec (7 properties), CloudCredentialsFilters (6 properties), CredentialsFilters (5 properties). Each schema is shown below with its type and property counts.

StandardCredentialsSpec
BaseCredentialsModel
object
5 properties
CloudHelperApplianceResult
object
2 properties 2 required
EAzureComputeCredentialsCreationMode
string
Mode that defines whether you want to connect to Azure Active Directory using an existing or a newly created Azure Active Directory application.
EAzureComputeCredentialsDeploymentType
string
Deployment type (global Microsoft Azure or Microsoft Azure Stack Hub).
GoogleCloudCredentialsSpec
GoogleCloudCredentialsModel
AzureComputeCloudDeviceCodeSpec
AzureLinuxHelperApplianceModel
AzureComputeCloudCredentialsModel
Microsoft Azure compute account.
AzureLinuxHelperApplianceSpec
object
7 properties 1 required
CloudNativeApplicationModel
BaseCloudDeviceCodeSpec
object
1 property
CloudCredentialsResult
object
2 properties 2 required
Error
object
3 properties 2 required
CloudDeviceCodeModel
CertificateUploadSpec
object
Certificate settings (for certificate-based authentication).
3 properties 2 required
LinuxCredentialsModel
BaseCloudDeviceCodeModel
object
1 property
BaseCloudNativeApplicationModel
object
1 property
AzureComputeCloudCredentialsSpec
CloudCredentialsModel
BaseCloudHelperApplianceSpec
object
1 property
EmptySuccessResponse
object
Empty success response (200, 201, 204).
CredentialsModel
SessionModel
object
13 properties 7 required
AzureComputeCloudCredentialsDeploymentModel
object
Environment to restore workloads to.
2 properties 1 required
PaginationResult
object
Pagination settings.
4 properties 2 required
StandardCredentialsModel
ECertificateFileFormatType
string
Certificate file format.
AzureComputeCredentialsExistingAccountSpec
object
Existing Azure Active Directory application.
2 properties 2 required
CloudCredentialsFilters
object
6 properties
AmazonCloudCredentialsModel
EAzureRegionType
string
Region where your Microsoft Azure container is located.
BaseCredentialsSpec
object
4 properties
ESessionResult
string
Result status.
AzureComputeCloudCredentialsSubscriptionModel
object
Microsoft Azure tenant settings.
4 properties 2 required
CredentialsResult
object
2 properties 2 required
SessionResultModel
object
Session result.
3 properties 1 required
CloudCredentialsPasswordSpec
object
1 property 1 required
ECloudCredentialsType
string
Cloud credentials type.
CloudCredentialsSpec
CloudHelperApplianceModel
AzureComputeCloudCredentialsSubscriptionSpec
object
Microsoft Azure compute account. For password-based authentication, specify client secret. For certificate-based authentication, specify certificate and passwo…
4 properties 2 required
BaseCloudHelperApplianceModel
object
1 property
AzureStorageCloudCredentialsSpec
AzureComputeCloudDeviceCodeModel
AzureComputeCloudNativeApplicationModel
ECloudCredentialsFiltersOrderColumn
string
Sorts cloud credentials by one of the cloud credentials parameters.
LinuxCredentialsSpec
CloudDeviceCodeSpec
CredentialsSpec
BaseCloudCredentialsSpec
object
2 properties
AmazonCloudCredentialsSpec
AzureStorageCloudCredentialsModel
ESessionState
string
State of the session.
PrivateKeyChangeSpec
object
2 properties 1 required
CredentialsPasswordChangeSpec
object
1 property 1 required
ESessionType
string
Type of the session.
ECredentialsType
string
Credentials type.
AzureComputeCloudCredentialsSubscriptionInfo
object
3 properties 2 required
CredentialsFilters
object
5 properties
CloudHelperApplianceSpec
BaseCloudCredentialsModel
object
3 properties
AzureComputeCredentialsNewAccountSpec
object
New Azure Active Directory application.
2 properties 2 required
ECredentialsFiltersOrderColumn
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

veeam-credentials-api-openapi.yml Raw ↑

Other APIs Veeam publishes across the network.

Veeam Backup & Replication REST API
Veeam Backup Enterprise Manager REST API
Veeam Backup for Microsoft 365 REST API
Veeam ONE REST API
Veeam Backup for AWS REST API
Veeam Backup for Microsoft Azure REST API
Veeam Backup for Google Cloud REST API
Veeam Recovery Orchestrator REST API
Veeam Agents API
Veeam AmazonConnections API
Veeam Automation API
Veeam Backup Objects API
Where this information came from

This is an independent, third-party profile of Veeam Credentials API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.