Welcome to Teradata Viewpoint and Teradata Data Lab API Reference Guide - Teradata Data Lab - Teradata Viewpoint

Teradata® Viewpoint and Teradata® Data Lab API Reference Guide - 24.04

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
Lake
VMware
Product
Teradata Data Lab
Teradata Viewpoint
Release Number
24.04
Published
April 2024
Language
English (United States)
Last Update
2024-04-29
dita:mapPath
qko1711972084905.ditamap
dita:ditavalPath
ft:empty
dita:id
prd1525780132746
Product Category
Analytical Ecosystem

Using Teradata® Viewpoint and Teradata® Data Lab API Reference Guide

This guide describes the Teradata Viewpoint RESTful APIs and Teradata® Data Lab APIs, with their supported operations and data objects. System administrators, database administrators, relational database developers, customers, and Teradata customer support persons are the intended users of this guide.

Why Would I Use this Content?

If you want to perform the following Viewpoint and Data Lab operations programmatically without using the web portal, go through this content.

  • Create backups for Viewpoint servers
  • Change the Teradata user password for static logins
  • Configure Viewpoint systems for monitoring
  • Automate the retrieval and deletion of flagged queries
  • Automate the retrieval of a list of all the sessions on a given Teradata system
  • Enable installation of the SSL Certificates
  • Automate the provision of system health information, including metric data, down components and services, and configured thresholds
  • Prepare lists of all Viewpoint users and roles
  • Automate the password change, addition, deletion, and update of Viewpoint users.
  • Get LDAP configuration and update service account password of LDAP server on Viewpoint servers
  • Create lab groups
  • Create and delete lab requests
  • Check the Viewpoint service running status
  • Provide metric details for:
    • Teradata system
    • Viewpoint or other managed system
    • Teradata machine learning engine
    • Hadoop system

How Do I Use this Content?

This content gives you an overview of Viewpoint and Data Labs RESTful APIs. Each API presents its purpose, supported operations, and Data Objects. You can use the APIs according to your requirements.

How Do I Get Started?

Start with Viewpoint and Data Lab RESTful APIs Overview to understand the API access, security, status codes, versioning, and use of Swagger. Looking into your required operations, proceed to the respective APIs.