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 Users API

The Users API from Veeam — 12 operation(s) for users.

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

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

This API exposes 15 operations across 12 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 1.0-rev0.

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

15 operations 12 paths 19 schemas 1 DELETE3 GET10 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

Veeam Users 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 15

Across 12 paths, the API surfaces 15 operations — 1 DELETE, 3 GET, 10 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 15
GET
/api/v1/users
Users get all
UsersGetAll 5 params → 200401403500
POST
/api/v1/users
Create user
CreateUser 1 param body → 201401403500
GET
/api/v1/users/{userId}
Users get by name
UsersGetByName 2 params → 200401403404500
PUT
/api/v1/users/{userId}
Update user
UpdateUser 2 params body → 200401403404500
DELETE
/api/v1/users/{userId}
Delete user
DeleteUser 2 params → 204401403404500
POST
/api/v1/users/validateName
Validate name
ValidateName 1 param body → 200401403500
POST
/api/v1/users/validateDescription
Validate description
ValidateDescription 1 param body → 200401403500
POST
/api/v1/users/validatePassword
Validate password
ValidatePassword 1 param body → 200401403500
POST
/api/v1/users/{userId}/enableMfa
Enable mfa
EnableMfa 2 params body → 200401403404500
POST
/api/v1/users/{userId}/disableMfa
Disable mfa
DisableMfa 2 params → 200401403404500
POST
/api/v1/users/{userId}/acceptMfa
Accept mfa
AcceptMfa 2 params body → 201401403404500
GET
/api/v1/users/isFirstLogin
Is first login
IsFirstLogin 1 param → 200400401403500
POST
/api/v1/users/checkInstanceId
Check instance
CheckInstance 1 param body → 200400401403500
POST
/api/v1/users/createDefaultUser
Create default user
CreateDefaultUser 1 param body → 201400401403409500
POST
/api/v1/users/export
Export users
ExportUsers 1 param → 200401500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Error (7 properties), UserMfaData (5 properties), User (5 properties), UsersFilters (4 properties). Each schema is shown below with its type and property counts.

UsersFilters
object
4 properties
UserCreateSpec
object
3 properties 3 required
UserNameValidationSpec
object
1 property 1 required
DefaultUserSpec
object
2 properties 2 required
UserMfaAccept
object
2 properties 2 required
IsFirstLoginResult
object
1 property 1 required
UsersSortColumns
string
CheckInstanceIdResult
object
1 property 1 required
Error
object
7 properties 4 required
Link
object
3 properties 3 required
UserMfaSetup
object
1 property
UserUpdateSpec
object
3 properties
CheckInstanceIdSpec
object
1 property 1 required
User
object
5 properties 4 required
UserMfaData
object
5 properties
UserDescriptionValidationSpec
object
1 property 1 required
UsersPage
object
3 properties 2 required
UserPasswordValidationSpec
object
1 property 1 required
ValidationMessage
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

veeam-users-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 Users 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.