- About Veeam Backup for Google Cloud REST API
- Overview
- Authorization
- Cloud Infrastructure
- getGet Infrastructure Objects
- postAdd Folder
- getGet Service Account Permissions To Folder
- putModify Service Account Permissions To Folder
- delRemove Folder
- postAdd Project
- getGet Service Account Permissions To Project
- putModify Service Account Permissions To Project
- delRemove Project
- postGenerate Permissions Script
- getGet Subfolders
- Cloud Spanner Instances
- Cloud Spanner Instance Backup Policies
- getGet Collection of Backup Policies
- postCreate Backup Policy
- postGenerate Permissions Script
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postSet Backup Policy Priority
- postCalculate Estimated Cost for Backup Policy
- postCalculate Estimated Cost for Modified Backup Policy
- getGet Backup Policy Status
- getGet Backup Policy Schedule
- getGet Backup Policy Sessions Data
- getGet Google Cloud Resources Protected by Backup Policy
- Cloud Spanner Instance Restore Points
- Cloud SQL Accounts
- Configuration Backup
- postCreate Configuration Backup
- postEnable Configuration Backup Schedule
- postDisable Configuration Backup Schedule
- getGet Configuration Backup Settings
- putModify Configuration Backup Settings
- getGet Configuration Backup Restore Points
- getGet Configuration Backup Restore Point Data
- delRemove Configuration Backup Restore Point
- postImport Configuration Backup File
- postStart Configuration Backup Export
- postCheck Status of Configuration Backup Export
- postDownload Configuration Backup File
- postCheck Imported Backup File
- General Settings
- Google Cloud Regions
- Licensing
- Networks
- Overview
- Product Version
- Projects
- getGet Collection of Projects
- postAdd Project
- getGet Project Data
- putModify Project
- delRemove Project
- getGet Collection of CMEKs for Project
- getGet Collection of CMEKs for Region
- getGet Collection of Regions
- getGet Instance Types Available in Regions
- getGet Region Availability Zones
- getGet Instance Types Available in Availability Zone
- getGet Cloud SQL Instance Types Available in Availability Zone
- getGet Cloud Spanner Instance Configurations
- getGet Collection of Service Accounts for Project
- postCreate HMAC Key
- getGet Collection of HMAC Keys
- postAdd Existing HMAC Key
- postGenerate Permissions Script
- Repositories
- Security Certificates
- Service
- Service Accounts
- Sessions
- SMTP Accounts
- SQL Backup Policies
- getGet Collection of Backup Policies
- postCreate Backup Policy
- postGenerate Permissions Script
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postSet Backup Policy Priority
- postCalculate Estimated Cost for Backup Policy
- postCalculate Estimated Cost for Modified Backup Policy
- getGet Backup Policy Status
- getGet Backup Policy Schedule
- getGet Backup Policy Sessions Data
- getGet Google Cloud Resources Protected by Backup Policy
- SQL Instances
- getGet Collection of Cloud SQL Instances
- getGet Cloud SQL Instance Data
- getGet Cloud SQL Instance Restore Points
- delRemove Cloud SQL Instance Restore Points
- getGet Collection of Cloud SQL Instance Sessions
- postCreate Snapshot of Cloud SQL Instance
- getGet Collection of Cloud SQL Databases
- postInfrastructure Rescan for Cloud SQL Instances
- SQL Restore Points
- Storage Buckets
- System Logs
- System Notifications
- User Accounts
- VM Instances
- VM Instance Backup Policies
- getGet Collection of Backup Policies
- postCreate Backup Policy
- postGenerate Permissions Script
- getGet Backup Policy Data
- putModify Backup Policy
- delDelete Backup Policy
- postStart Backup Policy
- postStop Backup Policy
- postEnable Backup Policy
- postDisable Backup Policy
- postSet Backup Policy Priority
- postCalculate Estimated Cost of Backup Policy
- postCalculate Estimated Cost for Modified Backup Policy
- getGet Backup Policy Status
- getGet Backup Policy Schedule
- getGet Backup Policy Sessions Data
- getGet Google Cloud Resources Protected by Backup Policy
- VM Instance Restore Points
- Workers
- getGet Worker Custom Labels
- putModify Worker Custom Labels
- getGet Project Selected for Worker Instances
- putChange Project for Worker Instances
- getGet Worker Configurations
- postAdd Worker Configuration
- getGet Worker Configuration Data
- putModify Worker Configuration
- delRemove Worker Configuration
- getGet Worker Profiles
- postAdd Worker Profiles
- getGet Default Worker Profiles
- getGet Worker Profiles for Region
- putModify Worker Profiles
- delRemove Worker Profiles
The /certificates resource collection represents current TLS certificate details.
Get Current Security Certificate Data
The HTTP GET request to the /certificates endpoint retrieves current TLS certificate details.
header Parameters
| x-api-version required | string Default: 1.4-rev0 Specifies the current revision of the Veeam Backup for Google Cloud REST API. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 400
- 401
- 403
- 500
{- "data": [
- {
- "thumbprint": "string",
- "serialNumber": "string",
- "keyAlgorithm": "string",
- "keySize": "string",
- "subject": "string",
- "issuedTo": "string",
- "issuedBy": "string",
- "validFrom": "2019-08-24T14:15:22Z",
- "validBy": "2019-08-24T14:15:22Z",
- "automaticallyGenerated": true
}
]
}Recreate Security Certificate
The HTTP POST request to the /certificates/recreate endpoint replaces the existing security certificate with a new self-signed certificate automatically generated by Veeam Backup for Google Cloud.
After you replace the existing security certificate, the Veeam Backup for Google Cloud REST API and Web UI services will be restarted automatically.
header Parameters
| x-api-version required | string Default: 1.4-rev0 Specifies the current revision of the Veeam Backup for Google Cloud REST API. |
Request Body schema: application/jsonrequired
Detailed information of a security certificate.
| validBy | string <date-time> Specifies the date and time when the certificate will expire. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.
- Payload
- curl
- Python
- JavaScript
- C#
- Go
{- "validBy": "2019-08-24T14:15:22Z"
}- 200
- 400
- 401
- 403
- 500
{- "certificate": {
- "thumbprint": "string",
- "serialNumber": "string",
- "keyAlgorithm": "string",
- "keySize": "string",
- "subject": "string",
- "issuedTo": "string",
- "issuedBy": "string",
- "validFrom": "2019-08-24T14:15:22Z",
- "validBy": "2019-08-24T14:15:22Z",
- "automaticallyGenerated": true
}, - "issues": [
- {
- "description": "string",
- "severity": "Error"
}
]
}Upload Own Security Certificate
The HTTP POST request to the /certificates/upload endpoint uploads a security certificate that you obtained from a Certificate Authority (CA) or generated using a 3rd party tool.
After you replace the existing security certificate, the Veeam Backup for Google Cloud REST API and Web UI services will be restarted automatically.
header Parameters
| x-api-version required | string Default: 1.4-rev0 Specifies the current revision of the Veeam Backup for Google Cloud REST API. |
Request Body schema: multipart/form-datarequired
| certificateFile required | string <binary> Uploads the .PFX certificate file. |
| certificatePassword | string <password> Specifies a password for the certificate file. |
OK
Bad Request. The request body is malformed, incomplete or otherwise invalid
Unauthorized. The authorization header has been expected but not found (or found but is expired).
Forbidden. The user sending a request does not have adequate privileges to access one or more objects specified in the request.
Internal Server Error. The request has been received but could not be completed because of an internal error at the server side.
- curl
- Python
- JavaScript
- C#
- Go
- 200
- 400
- 401
- 403
- 500
{- "certificate": {
- "thumbprint": "string",
- "serialNumber": "string",
- "keyAlgorithm": "string",
- "keySize": "string",
- "subject": "string",
- "issuedTo": "string",
- "issuedBy": "string",
- "validFrom": "2019-08-24T14:15:22Z",
- "validBy": "2019-08-24T14:15:22Z",
- "automaticallyGenerated": true
}, - "issues": [
- {
- "description": "string",
- "severity": "Error"
}
]
}