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 General Options API

The General Options section defines paths and operations for retrieving and editing general settings of Veeam Backup & Replication. NOTEIn the current version of the REST API, you can configure notification settings only.

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

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

This API exposes 2 operations across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 1.0-rev0.

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

2 operations 1 paths 5 schemas 1 GET1 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 General Options 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 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

General Options 2

The General Options section defines paths and operations for retrieving and editing general settings of Veeam Backup & Replication. NOTE In the current version of the REST API, yo…

GET
/api/v1/generalOptions
Get Notification Settings
GetGeneralOptions 1 param → 200401403404500
PUT
/api/v1/generalOptions
Edit Notification Settings
UpdateGeneralOptions 1 param body → 200400401403404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are GeneralOptionsEmailNotificationsModel (11 properties), GeneralOptionsNotificationsModel (8 properties), AdvancedSmtpOptionsModel (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

AdvancedSmtpOptionsModel
object
Advanced global email notification settings.
5 properties 4 required
GeneralOptionsModel
object
2 properties
GeneralOptionsNotificationsModel
object
Other notifications such as notifications on low disk space, support contract expiration, and available updates.
8 properties 8 required
GeneralOptionsEmailNotificationsModel
object
Global email notification settings and job notifications.
11 properties 11 required
Error
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

veeam-general-options-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 General Options 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.