BaaS Enterprise APIs | Supported Operations | - BaaS Backup Jobs 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-28
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 various types of jobs.

HTTP URL Parameters Description Success Response Code
GET https://<api-path>/data-protection/v2/sites/{site_id}/jobs
Required parameters
  • site_id: ID of the site.
Optional parameters
  • is-activeFetches only active jobs
  • page: The page number to fetch. Default is 1.
  • page-size: The number of items in each page. Default is 10.
  • job-type: The job type, either as Backup or Restore
 Gets all the BACKUP or RESTORE jobs. 200
GET https://<api-path>/data-protection/v2/sites/{site_id}/jobs/{job_id}
Required parameters
  • site_id: ID of the site.
  • job_id: ID of the job.

Gets all information related to the JobID.

 200
POST https://<api-path>/data-protection/v2/sites/{site_id}/jobs/{job_id}/execute
Required parameters
  • site_id: ID of the site.
  • job_id: ID of the job.
Optional parameters
  • run_typeSelect Full or Delta.
 Executes the selected backup job. 202
GET https://<api-path>/data-protection/v2/sites/{site-id}/executions
Required parameters
  • site_id: ID of the site.
 List all executions in a site. 200
GET https://<api-path>/data-protection/v2/sites/{site-id}/jobs/{job-id}/executions
Required parameters
  • site_id: ID of the site.
  • job_id: ID of the job.
 List All executions for a job in a site. 200

The sample codes for various APIs are as follows:

Sample API Response Payload for Listing all the Jobs

[
  {
    "site_id": "string",
    "auto_abort_in_minutes": 0,
    "backup_type": "FULL",
    "description": "test backup plan for employee database",
    "is_active": true,
    "is_auto_abort_active": false,
    "job_id": 34,
    "job_type": "BACKUP",
    "last_execution_details": {
      "end_time": "2022-12-07T11:35:00.000000Z",
      "start_time": "2022-12-07T11:31:00.000000Z",
      "status": "SUCCESSFUL",
      "backup_set_size": 1000000,
      "backup_job_id": 34,
      "backup_job_execution_id": 121,
      "restore_execution_id": 121
    },
    "name": "test_backup_plan",
    "next_run_time": "2022-12-08T11:31:02.282298Z",
    "no_of_retention_copies": 2,
    "priority": 1,
    "siteTargetType": "AWS",
    "backup_mechanism": "DSA",
    "targetSiteDetails": {
      "target_site_id": "string",
      "target_retention_copies_count": 0,
      "target_retention_source": "string"
    }
  }
]

Sample API Response Payload to get a Backup or Restore Job by Job ID

{
  "site_id": "string",
  "auto_abort_in_minutes": 0,
  "backup_type": "FULL",
  "description": "test backup plan for employee database",
  "job_settings": {
    "online": false,
    "objects": [
      {
        "exclude_objects": [
          {
            "object_name": "DEPARTMENT",
            "object_type": "DATABASE"
          }
        ],
        "include_all": true,
        "object_name": "EMPLOYEE",
        "object_type": "DATABASE",
        "parent_name": "DBC",
        "parent_type": "DATABASE",
        "rename_to": "string"
      }
    ],
    "continue_job_on_access_right_violation": true,
    "run_as_a_copy_job": true,
    "restore_to_a_different_database_on_target_site": "DATABASE_NAME",
    "skip_statstics": true,
    "retained_copy": "string"
  },
  "is_active": true,
  "is_auto_abort_active": false,
  "job_id": 34,
  "job_type": "BACKUP",
  "last_execution_details": {
    "end_time": "2022-12-07T11:35:00.000000Z",
    "start_time": "2022-12-07T11:31:00.000000Z",
    "status": "SUCCESSFUL",
    "backup_set_size": 1000000,
    "backup_job_id": 34,
    "backup_job_execution_id": 121,
    "restore_execution_id": 121
  },
  "name": "test_backup_plan",
  "next_run_time": "2022-12-08T11:31:02.282298Z",
  "no_of_retention_copies": 2,
  "siteTargetType": "AWS",
  "targetSiteDetails": {
    "target_site_id": "string",
    "target_retention_copies_count": 0,
    "target_retention_source": "string"
  },
  "priority": 1,
  "backup_mechanism": "DSA"
}

Sample API Request Payload to Execute Backup Jobs

{
  "run_type": "FULL"
}
Response Header for Status 202 (Accepted)

x-resource-id: Execution ID of the job.

Sample API Response Payload for Listing All Job Executions

[
  {
    "site_id": "string",
    "target_site": "string",
    "job_id": 0,
    "job_name": "string",
    "backup_mechanism": "DSA",
    "job_type": "RESTORE",
    "execution_id": "string",
    "execution_name": "string",
    "start_time": "string",
    "end_time": "string",
    "backup_set_size": 0,
    "server_execution_id": "string",
    "parent_execution_id": "string",
    "status": "SUCCESSFUL",
    "saveset_replication_status": "FAILED",
    "is_saveset_retained": true,
    "is_saveset_deleted": true,
    "saveset_id": 0,
    "run_type": "FULL",
    "site_type": "string",
    "status_detail": "string"
  }
]

Sample API Response Payload for Listing All Executions for a Job in a Site

[
  {
    "site_id": "string",
    "target_site": "string",
    "job_id": 0,
    "job_name": "string",
    "backup_mechanism": "DSA",
    "job_type": "RESTORE",
    "execution_id": "string",
    "execution_name": "string",
    "start_time": "string",
    "end_time": "string",
    "backup_set_size": 0,
    "server_execution_id": "string",
    "parent_execution_id": "string",
    "status": "SUCCESSFUL",
    "saveset_replication_status": "FAILED",
    "is_saveset_retained": true,
    "is_saveset_deleted": true,
    "saveset_id": 0,
    "run_type": "FULL",
    "site_type": "string",
    "status_detail": "string"
  }
]