PDC API Reference

The Pentaho Data Catalog (PDC) API exposes a set of RESTful endpoints that allow you to interact programmatically with your catalog. The reference is organized into logical groups so you can quickly find the endpoints you need. Each endpoint page includes details about request methods, parameters, request/response schemas, error codes, and code examples.

How to use this reference

This API Reference is designed to help you explore and use the PDC API effectively. Each endpoint page provides the information you need to build, test, and integrate requests into your workflows.

• Navigation: Endpoints are organized into logical groups (such as Health, Auth, Search, and Data Sources) so you can quickly locate the functionality you need. Use the sidebar to browse by domain.

• Schemas: Every endpoint includes request and response schemas, with clear field descriptions, data types, and example payloads. This helps you understand exactly what to send and what to expect back.

• Error codes: Standard error responses are listed for each endpoint. These include sample error objects with status codes, messages, and possible causes.

• Code examples: Ready-to-use code snippets are provided in multiple languages. All endpoints include a curl example, and some also provide JavaScript, Python, or Java examples for quick integration.

• Authorization: All endpoints (except the Health check) require a valid bearer token in the Authorization header. Refer to the Authentication page to learn how to obtain and use tokens.

Endpoint groups

The following groups of endpoints are available:

Group

Health

Description

Verify that the PDC API is running and reachable — useful for monitoring or automation scripts.

Endpoint(s)

/api/public/health

Group

Auth

Description

Authenticate with username and password to obtain a bearer token for secure API access.

Endpoint(s)

/api/public/v1/auth

Group

Notifications

Description

Retrieve or create notifications to track system events, data changes, or catalog activity.

Endpoint(s)

/api/public/v1/notifications

Group

Search

Description

Search catalog assets and retrieve facets to filter results for discovery and analytics.

Endpoint(s)

/api/public/v1/search, /api/public/v1/search/facets

Group

Data Sources

Description

Create, retrieve, and manage data source connections across databases, files, and cloud stores.

Endpoint(s)

/api/public/v1/data-sources

Group

Data Entities

Description

Get, update, or filter entities and fetch profiling information for metadata analysis.

Endpoint(s)

/api/public/v1/entities/... (single, bulk, filter, profiling)

Group

Data Collections

Description

Manage datasets, collections, categories, and groups to organize catalog content.

Endpoint(s)

/api/public/v1/dataset/..., collection management

Group

Jobs

Description

Run and monitor background jobs such as profiling, ingestion, or schema scanning.

Endpoint(s)

/api/public/v1/job/execution

Conventions

All PDC API endpoints follow these conventions:

• Base path: All endpoints are hosted under:

  https://<your-domain>/api/public/v1/

• Authentication: Except for the Health endpoint, all requests require a bearer token. Add the token to your request headers:

  Authorization: Bearer <accessToken>

• Request/response format: JSON

• Versioning: Current version is v1. Future versions will follow the same pattern (/api/public/v2/...).

• Errors: Consistent error objects are returned across endpoints.