BaaS Objects APIs - Teradata Vantage

Teradata® VantageCloud Enterprise
Deployment
VantageCloud
Edition
Enterprise
Product
Teradata Vantage
Release Number
3.1.0
Published
October 2025
ft:locale
en-US
ft:lastEdition
2025-11-10
dita:mapPath
gqe1746821105801.ditamap
dita:ditavalPath
paz1652209068143.ditaval
dita:id
wec1649710665916
Product Category
Teradata Vantage

The BaaS functionality supports various APIs on VantageCloud Enterprise. The following are the supported operations for objects.

HTTP URL Parameters Description Success Response Code
POST https://<api-path>/data-protection/v2/sites/{site-id}/jobs/{job-id}/executions/{execution-id}/prepare-objects
Required parameters
  • site_id: ID of the site.
  • job_id: ID of the job.
  • execution_id: ID of the execution job.
 Starts the object preparation for restore activity. 200
GET https://<api-path>/data-protection/v2/sites/{site-id}/objects-preparation-status
Required parameters
  • site_id: ID of the site.

Gets the status of the object preparation.

 200
GET https://<api-path>/data-protection/v2/sites/{site-id}/jobs/{job-id}/executions/{execution-id}/objects
Required parameters
  • site_id: ID of the site.
  • job_id: ID of the job.
  • execution_id: ID of the execution job.
 Gets objects that were backed up in a job execution. 200

Start Object Preparation Response Header for 202 (Accepted)

x-resource-id: Job objects status ID.

Sample API Response Payload to find the Status of the Object Preparation

{
"status": "string",
"details": "string"
}

Sample API Response Payload to get the Objects Backed up

[
  {
    "object_name": "string",
    "object_type": "DATABASE",
    "parent_name": "string",
    "parent_type": "string",
    "byte_count": 0
  }
]