Veeam Repositories API
The Repositories API from Veeam — 18 operation(s) for repositories.
Veeam Repositories API is one of 55 APIs that Veeam publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Repositories. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 29 operations across 18 paths, and defines 133 schemas. It is described by OpenAPI 3.0.0, at version 1.0-rev0.
Requests are made against the base URL https://localhost:9419.
29 operations
18 paths
133 schemas
3 DELETE9 GET12 POST5 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Veeam Repositories 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 29
Across 18 paths, the API surfaces 29 operations — 3 DELETE, 9 GET, 12 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.
Repositories 29
GET
/api/v1/repositories
POST
/api/v1/repositories
GET
/api/v1/repositories/{repositoryId}
PUT
/api/v1/repositories/{repositoryId}
DELETE
/api/v1/repositories/{repositoryId}
POST
/api/v1/repositories/{repositoryId}/rescan
POST
/api/v1/repositories/settings/validate
POST
/api/v1/repositories/{repositoryId}/checkPassword
POST
/api/v1/repositories/export
GET
/api/v1/backupInfrastructure/repositories
Get All Repositories
POST
/api/v1/backupInfrastructure/repositories
Add Repository
GET
/api/v1/backupInfrastructure/repositories/states
Get All Repository States
DELETE
/api/v1/backupInfrastructure/repositories/{id}
Remove Repository
GET
/api/v1/backupInfrastructure/repositories/{id}
Get Repository
PUT
/api/v1/backupInfrastructure/repositories/{id}
Edit Repository
GET
/api/v1/backupInfrastructure/repositories/{id}/accessPermissions
Get Repository Access Permissions
PUT
/api/v1/backupInfrastructure/repositories/{id}/accessPermissions
Edit Repository Access Permissions
GET
/api/v1/backupInfrastructure/scaleOutRepositories
Get All Scale-Out Backup Repositories
POST
/api/v1/backupInfrastructure/scaleOutRepositories
Add Scale-Out Backup Repository
DELETE
/api/v1/backupInfrastructure/scaleOutRepositories/{id}
Remove Scale-Out Backup Repository
GET
/api/v1/backupInfrastructure/scaleOutRepositories/{id}
Get Scale-Out Backup Repository
PUT
/api/v1/backupInfrastructure/scaleOutRepositories/{id}
Edit Scale-Out Backup Repository
GET
/api/v1/backupInfrastructure/scaleOutRepositories/{id}/accessPermissions
Get Scale-Out Backup Repository Access Permissions
PUT
/api/v1/backupInfrastructure/scaleOutRepositories/{id}/accessPermissions
Edit Scale-Out Backup Repository Access Permissions
POST
/api/v1/backupInfrastructure/scaleOutRepositories/{id}/disableMaintenanceMode
Disable Maintenance Mode
POST
/api/v1/backupInfrastructure/scaleOutRepositories/{id}/disableSealedMode
Disable Sealed Mode
POST
/api/v1/backupInfrastructure/scaleOutRepositories/{id}/enableMaintenanceMode
Enable Maintenance Mode
POST
/api/v1/backupInfrastructure/scaleOutRepositories/{id}/enableSealedMode
Enable Sealed Mode
POST
/api/v1/backupInfrastructure/scaleOutRepositories/{id}/evacuateBackups
Evacuate Backups from Performance Extent
Schemas 133
The contract defines 133 schemas that model the data the API accepts and returns. The most detailed are SessionModel (13 properties), Repository (10 properties), RepositoryStatesFilters (10 properties), RepositoriesFilters_2 (10 properties). Each schema is shown below with its type and property counts.
ERepositoryConnectionType
string
Repository connection type (direct or through a gateway server).
AmazonS3StorageModel
Amazon S3 storage.
Error
object
7 properties
4 required
RepositoryModel
RepositoriesSortColumns
string
NetworkRepositorySettingsModel
object
Repository settings.
5 properties
EConsumptionLimitKind
string
Measurement unit.
SessionLink
object
2 properties
1 required
S3CompatibleStorageAccountModel
object
Account used to access the S3 compatible storage.
4 properties
4 required
AzureArchiveStorageContainerModel
object
Azure Archive container where backup data is stored.
2 properties
2 required
LinuxLocalStorageSpec
Linux-based repository.
EPlacementPolicyType
string
Type of placement policy.
S3CompatibleStorageSpec
S3 compatible storage.
EAzureRegionType
string
Region where your Microsoft Azure container is located.
LinuxLocalRepositorySettingsModel
object
Repository settings.
7 properties
EAllowedBackupsType
string
Type of backup files that can be stored on the extent.
SessionResultModel
object
Session result.
3 properties
1 required
RepositoryUpdateSpec
object
6 properties
3 required
AzureBlobStorageSpec
Microsoft Azure Blob storage.
AmazonS3StorageAccountModel
object
Account used to access the Amazon S3 storage.
3 properties
3 required
ObjectStorageConnectionModel
object
Object storage connection settings.
2 properties
1 required
ERotatedDriveCleanupMode
string
Cleanup mode: Disabled — continue the backup chain on an inserted drive. ClearBackupFolder — delete existing backups belonging to the job. ClearRepositoryFolde…
NfsStorageModel
NFS backup repository.
BackupPlacementSettingsModel
object
2 properties
2 required
ScaleOutRepositoryModel
object
8 properties
4 required
BackupWindowDayHoursModel
object
Hourly scheme for a day.
2 properties
2 required
AzureArchiveStorageModel
Microsoft Azure Archive storage.
PerformanceExtentSpec
object
1 property
1 required
ESessionType
string
Type of the session.
RepositoriesResult
object
2 properties
2 required
VPowerNFSPortSettingsModel
object
Network ports used by the vPower NFS Service.
2 properties
ERepositoryFiltersOrderColumn
string
Sorts repositories by one of the repository parameters.
ERepositoryExtentStatusType
string
Performance extent status.
AzureBlobStorageContainerModel
object
Azure Blob storage container.
3 properties
2 required
Error_2
object
3 properties
2 required
AmazonS3StorageBucketModel
object
Amazon S3 bucket where backup data is stored.
6 properties
3 required
RepositoryStateModel
object
10 properties
7 required
AzureStorageProxyModel
object
Azure storage proxy appliance.
6 properties
1 required
ObjectStorageConsumptionLimitModel
object
Soft consumption limit for the storage. The limit can be exceeded temporarily.
3 properties
PerformanceTierModel
object
Performance tier.
2 properties
1 required
ArchiveTierModel
object
Archive tier.
4 properties
1 required
S3CompatibleStorageModel
S3 compatible storage.
EScaleOutRepositoryFiltersOrderColumn
string
WasabiCloudStorageAccountModel
object
Account used to access the Wasabi Cloud storage.
3 properties
3 required
IBMCloudStorageModel
IBM Cloud storage.
CapacityTierModel
object
Capacity tier.
8 properties
1 required
EmptySuccessResponse
object
Empty success response (200, 201, 204).
ERepositoryType
string
Repository type.
ScaleOutRepositorySpec
object
7 properties
3 required
MountServerSettingsModel
object
Settings for the mount server that is used for file-level and application items restore.
4 properties
3 required
RepositoryShareGatewayModel
object
Settings for the gateway server.
2 properties
1 required
AmazonS3GlacierStorageModel
Amazon S3 Glacier storage.
IBMCloudStorageAccountModel
object
Account used to access the IBM Cloud storage.
4 properties
4 required
AmazonS3StorageProxyApplianceModel
object
Amazon S3 proxy appliance.
5 properties
GoogleCloudStorageSpec
Google Cloud storage.
ERepositoryStatesFiltersOrderColumn
string
Orders repositories by the specified column.
BackupStorageSettingsEncryptionModel
object
Encryption of backup files.
3 properties
1 required
RepositoriesPage
object
3 properties
2 required
ESessionState
string
State of the session.
AmazonSnowballEdgeStorageBucketModel
object
Amazon S3 bucket.
3 properties
CapacityTierOverridePolicyModel
object
Policy that overrides the move policy if the scale-out backup repository is reaching its capacity.
2 properties
1 required
AzureDataBoxStorageModel
Microsoft Azure Data Box storage.
WindowsLocalStorageSpec
Microsoft Windows-based repository.
AzureDataBoxStorageAccountModel
object
Account used to access the Azure Data Box storage.
3 properties
2 required
PlacementPolicyModel
object
Backup file placement policy.
3 properties
1 required
EDayOfWeek
string
Day of the week.
Link
object
3 properties
3 required
RepositoryStatesFilters
object
Filters repositories by the specified parameters.
10 properties
ScaleOutExtentMaintenanceSpec
object
1 property
1 required
AzureArchiveStorageAccountModel
object
Account used to access the Azure Archive storage.
3 properties
3 required
BaseRepositoryModel
object
5 properties
WasabiCloudStorageModel
Wasabi Cloud storage.
RepositoryStatesResult
object
2 properties
2 required
RepositoryBehaviorFilters
object
1 property
S3CompatibleStorageBucketModel
object
Bucket where backup data is stored.
4 properties
2 required
BaseRepositorySpec
object
4 properties
LinuxLocalStorageModel
Linux-based repository.
PerformanceTierSpec
object
Performance tier.
2 properties
1 required
SmbStorageSpec
SMB backup repository.
AmazonS3IAStorageModel
object
Standard Infrequent Access.
2 properties
LinuxHardenedRepositorySettingsModel
object
Repository settings.
8 properties
Repository
object
10 properties
6 required
AmazonSnowballEdgeStorageAccountModel
object
AWS account used to access the AWS Snowball Edge storage.
4 properties
4 required
WasabiCloudStorageSpec
Wasabi Cloud storage.
CapacityExtentModel
object
1 property
1 required
ScaleOutRepositoriesResult
object
2 properties
2 required
PaginationResult
object
Pagination settings.
4 properties
2 required
SmbStorageModel
SMB backup repository.
RepositoryAdvancedSettingsModel
object
Advanced settings for the backup repository.
5 properties
NfsRepositoryShareSettingsModel
object
Share settings.
2 properties
1 required
ArchiveTierAdvancedSettingsModel
object
Advanced settings of the archive tier.
2 properties
RepositorySpec
AzureBlobStorageAccountModel
object
Account used to access the Azure Blob storage.
3 properties
3 required
GoogleCloudStorageAccountModel
object
Account used to access the Google Cloud storage.
3 properties
3 required
RepositoriesFilters
object
4 properties
WindowsLocalRepositorySettingsModel
object
Repository settings.
6 properties
AmazonS3GlacierStorageSpec
Amazon S3 Glacier storage.
WindowsLocalStorageModel
Microsoft Windows-based repository.
DeleteRepositoryFilters
object
1 property
AmazonS3StorageSpec
Amazon S3 storage.
PerformanceTierAdvancedSettingsModel
object
Advanced settings of the performance tier.
2 properties
RepositoryCreateSpec
object
8 properties
5 required
AzureDataBoxStorageSpec
Microsoft Azure Data Box storage.
RepositoryEmbedded
object
6 properties
RepositoriesFilters_2
object
10 properties
ObjectStorageImmutabilityModel
object
Object storage immutability.
2 properties
AzureDataBoxStorageContainerModel
object
Azure Data Box container where backup data is stored.
2 properties
EAmazonRegionType
string
AWS region type.
S3CompatibleProxyModel
object
Proxy appliance for the S3 compatible storage.
1 property
1 required
RepositoryPasswordValidationResult
object
1 property
1 required
ValidationMessage
object
3 properties
IBMCloudStorageBucketModel
object
IBM Cloud bucket where backup data is stored.
4 properties
2 required
AmazonSnowballEdgeStorageModel
AWS Snowball Edge storage.
BackupWindowSettingModel
object
Time scheme that defines permitted days and hours for the job to start.
1 property
1 required
IBMCloudStorageSpec
IBM Cloud storage.
AzureArchiveStorageSpec
Microsoft Azure Archive storage.
NfsStorageSpec
NFS backup repository.
RepositoryAccessPermissionsModel
object
Repository access permissions.
4 properties
2 required
SessionModel
object
13 properties
7 required
SmbRepositoryShareSettingsModel
object
Share settings.
3 properties
2 required
ERepositoryAccessType
string
Access type.
ESessionResult
string
Result status.
WasabiCloudStorageBucketModel
object
Wasabi bucket where backup data is stored.
4 properties
2 required
ScaleOutRepositoriesFilters
object
5 properties
RepositoryPasswordValidationSpec
object
1 property
1 required
AmazonS3GlacierStorageBucketModel
object
Amazon S3 Glacier bucket where backup data is stored.
5 properties
3 required
LinuxHardenedStorageModel
Linux hardened repository.
PerformanceExtentModel
object
3 properties
2 required
LinuxHardenedStorageSpec
Linux hardened repository.
GoogleCloudStorageModel
Google Cloud storage.
GoogleCloudStorageBucketModel
object
Google Cloud object storage bucket where backup data is stored.
4 properties
2 required
AmazonSnowballEdgeStorageSpec
AWS Snowball Edge storage.
AzureBlobStorageModel
Microsoft Azure Blob storage.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Veeam 12
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
#Repositories
Where this information came from
This is an independent, third-party profile of Veeam Repositories 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.