Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Teradata Queries API

The Queries API from Teradata — 2 operation(s) for queries.

Teradata Queries API is one of 11 APIs that Teradata publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Queries. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 4 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://vantage.teradata.com/api/query/v1.

4 operations 2 paths 3 schemas 1 DELETE2 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://querygrid.teradata.com/api/v1
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

Teradata Queries API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

  • BasicAuth — HTTP Basic authentication with Vantage credentials.

Paths & Operations 4

Across 2 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Queries 4
POST
/queries
Teradata Execute Query
executeQuery body → 200400401
GET
/queries
Teradata List Queries
listQueries → 200
GET
/queries/{queryId}
Teradata Get Query Status
getQueryStatus 1 param → 200404
DELETE
/queries/{queryId}
Teradata Cancel Query
cancelQuery 1 param → 204404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are QuerySummary (6 properties), QueryResult (6 properties), QueryRequest (4 properties). Each schema is shown below with its type and property counts.

QueryResult
object
Query execution result.
6 properties
QuerySummary
object
Summary of a cross-system query execution.
6 properties
QueryRequest
object
Request to execute a SQL query.
4 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teradata-queries-api-openapi.yml Raw ↑

Other APIs Teradata publishes across the network.

Teradata API Info API
Teradata Configuration API
Teradata Issues API
Teradata Managers API
Teradata Nodes API
Teradata Operations API
Teradata Sessions API
Teradata Software API
Teradata Systems API
Teradata Users API