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 Configuration API

The Configuration API from Teradata — 8 operation(s) for configuration.

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

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

This API exposes 16 operations across 8 paths, and defines 8 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.

16 operations 8 paths 8 schemas 8 GET8 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 Configuration 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 16

Across 8 paths, the API surfaces 16 operations — 8 GET, 8 POST. Each is listed below with its method, path, parameters, and response codes.

Configuration 16
GET
/config/datacenters
Teradata List Data Centers
listDataCenters → 200
POST
/config/datacenters
Teradata Create Data Center
createDataCenter body → 201400
GET
/config/systems
Teradata List Systems
listSystems → 200
POST
/config/systems
Teradata Create System
createSystem body → 201400
GET
/config/bridges
Teradata List Bridges
listBridges → 200
POST
/config/bridges
Teradata Create Bridge
createBridge body → 201400
GET
/config/connectors
Teradata List Connectors
listConnectors → 200
POST
/config/connectors
Teradata Create Connector
createConnector body → 201400
GET
/config/links
Teradata List Links
listLinks → 200
POST
/config/links
Teradata Create Link
createLink body → 201400
GET
/config/fabrics
Teradata List Fabrics
listFabrics → 200
POST
/config/fabrics
Teradata Create Fabric
createFabric body → 201400
GET
/config/networks
Teradata List Networks
listNetworks → 200
POST
/config/networks
Teradata Create Network
createNetwork body → 201400
GET
/config/comm-policies
Teradata List Communication Policies
listCommPolicies → 200
POST
/config/comm-policies
Teradata Create Communication Policy
createCommPolicy body → 201400

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Link (6 properties), System (6 properties), Connector (5 properties), Bridge (5 properties). Each schema is shown below with its type and property counts.

CommPolicy
object
A communication policy configuration.
5 properties
Fabric
object
A data fabric configuration.
4 properties
DataCenter
object
A data center configuration.
4 properties
Network
object
A network configuration.
4 properties
System
object
A system registered in QueryGrid.
6 properties
Bridge
object
A bridge connecting two systems.
5 properties
Link
object
A link between connected systems.
6 properties
Connector
object
A connector for system integration.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

teradata-configuration-api-openapi.yml Raw ↑

Other APIs Teradata publishes across the network.

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