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

The Policies API from Veeam — 15 operation(s) for policies.

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

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

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

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

18 operations 15 paths 65 schemas 1 DELETE7 GET9 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 Policies 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 18

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

Policies 18
GET
/api/v1/policies
Policies get all
PoliciesGetAll 10 params → 200400401500
POST
/api/v1/policies
Create policy
CreatePolicy 1 param body → 201400401500
GET
/api/v1/policies/{policyId}
Policies get one by id
PoliciesGetOneById 2 params → 200401404500
PUT
/api/v1/policies/{policyId}
Update policy
UpdatePolicy 2 params body → 200400401404500
DELETE
/api/v1/policies/{policyId}
Delete policy
DeletePolicy 2 params → 200401404409500
GET
/api/v1/policies/{policyId}/selectedItems
Policies get selected items by id
PoliciesGetSelectedItemsById 6 params → 200400401404500
GET
/api/v1/policies/{policyId}/regions
Policies get regions by id
PoliciesGetRegionsById 6 params → 200400401404500
GET
/api/v1/policies/{policyId}/excludedItems
Policies get excluded items by id
PoliciesGetExcludedItemsById 6 params → 200400401404500
POST
/api/v1/policies/{policyId}/enable
Enable policy
EnablePolicy 2 params → 200401404500
POST
/api/v1/policies/{policyId}/disable
Disable policy
DisablePolicy 2 params → 200401404500
POST
/api/v1/policies/{policyId}/start
Start policy
StartPolicy 2 params → 202401404409500
POST
/api/v1/policies/{policyId}/stop
Stop policy
StopPolicy 2 params → 202401404500
GET
/api/v1/policies/{policyId}/export
Export policy
ExportPolicy 2 params → 200400401403404500
POST
/api/v1/policies/import
Import policy
ImportPolicy 1 param body → 202400401403404500
POST
/api/v1/policies/validate
Validate
Validate 1 param body → 200400401403500
POST
/api/v1/policies/orderPriorities
Policy order priority of policies
PolicyOrderPriorityOfPolicies 1 param body → 200400401403500
POST
/api/v1/policies/export
Export policies
ExportPolicies 1 param → 200401500
GET
/api/v1/policies/{policyId}/cost
Get policy cost
GetPolicyCost 2 params → 200401404500

Schemas 65

The contract defines 65 schemas that model the data the API accepts and returns. The most detailed are Policy (23 properties), PolicyExportModel (15 properties), PolicySpec (13 properties), CostEstimationsPage (10 properties). Each schema is shown below with its type and property counts.

PolicyExportModel
object
15 properties 5 required
PolicyBackupItemsExportModel
object
2 properties
PolicyPrioritySpec
object
2 properties 2 required
ScheduleSettings
object
8 properties 4 required
SessionLink
object
2 properties 1 required
CostEstimationItem
object
8 properties 5 required
PolicyBackupItems
object
2 properties
Policy
object
23 properties 8 required
SessionStatuses
string
DailySnapshotScheduleSettings
object
2 properties 2 required
WeeklyBackupScheduleSettings
object
2 properties 2 required
RegionsPage
object
3 properties 2 required
MonthlySchedule
object
1 property 1 required
MonthlyBackupScheduleSettings
object
2 properties 2 required
YearlyScheduleSettings
object
6 properties 4 required
BackupSettingsExportModel
object
1 property 1 required
PointsRetentionOptions
object
1 property 1 required
Months
string
MonthlyReplicaScheduleSettings
object
2 properties 2 required
PolicyItemsFilters
object
4 properties
TagSpec
object
2 properties 2 required
PolicyEmbeddedResources
object
6 properties
WeeklyReplicaScheduleSettings
object
2 properties 2 required
PolicyItemsPage
object
3 properties 2 required
DailySchedule
object
1 property 1 required
DayNumbersInMonth
string
Error
object
7 properties 4 required
ReplicaSettingsExportModel
object
3 properties 1 required
Link
object
3 properties 3 required
WeeklySnapshotScheduleSettings
object
2 properties 2 required
PoliciesPage
object
3 properties 2 required
DailyScheduleKinds
string
PeriodRetentionOptions
object
2 properties 2 required
ReplicaMapping
object
4 properties 3 required
RetrySettings
object
1 property 1 required
WeeklyScheduleSettings
object
4 properties 2 required
DailyScheduleSettings
object
6 properties 3 required
MonthlyScheduleSettings
object
7 properties 3 required
PolicyItemsSortColumns
string
DaysOfWeek
string
PoliciesFilters
object
9 properties
PoliciesPrioritySpec
object
1 property 1 required
PolicyItem
object
4 properties
PolicySnapshotSettings
object
3 properties
PolicySpec
object
13 properties 4 required
DailyReplicaScheduleSettings
object
2 properties 2 required
RetentionTypes
string
PolicyNotificationSettings
object
4 properties
PolicyItemDeletedFromAmazon
object
3 properties 3 required
RemoteMappingExportModel
object
4 properties 3 required
Region
object
3 properties 2 required
CostEstimationsPage
object
10 properties 7 required
PolicyReplicaSettings
object
3 properties 1 required
YearlyRetentionOptions
object
2 properties 2 required
PoliciesSortColumns
string
EmptySuccessResponse
object
Empty succes response ( 200, 201, 204 )
PolicySelectionTypes
string
PolicyBackupSettings
object
1 property
MonthlySnapshotScheduleSettings
object
2 properties 2 required
RegionsFilters
object
4 properties
WeeklySchedule
object
1 property 1 required
ValidationMessage
object
3 properties
DailyBackupScheduleSettings
object
2 properties 2 required
PolicyStatuses
string
RegionsSortColumns
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

veeam-policies-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 Policies 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.