API endpoints

The Data Cataloging REST APIs include several API services for monitoring data and performing other management tasks.

IBM Spectrum Discover provides the following REST APIs:
  • An API for working with a DB2® warehouse
  • A policy management API and an autotags API
  • A connection management API
  • An application management API
  • A resource-based access control (RBAC) API

The endpoints of each API have a characteristic basic syntax. In the following code blocks, <spectrum_discover_host> is the host name or IP address of the API server:

  • Endpoints for the Db2® Warehouse API:
    https://<spectrum_discover_host>/db2whrest/v1/<endpoint_ID>
    For example:
    curl -k -H 'Authorization: Bearer <token>' https://<spectrum_discover_host>/db2whrest/v1/
    sql_query_async?<sql>
  • Endpoints for the policy management API:
    https://<spectrum_discover_host>/policyengine/v1/policies/<endpoint_ID>
    For example:
    curl -k -H 'Authorization: Bearer <token>' "https://<spectrum_discover_host>/policyengine/v1/
    policies/<policy_ID>
  • Endpoints for the resource-based access control (RBAC) API:
    https://<spectrum_discover_host>/auth/v1/<endpoint_ID>
    For example:
    curl -k -H 'Authorization: Bearer <token>' https://<spectrum_discover_host>/auth/v1/users