API Overview

KUKAN provides four APIs for different use cases.

API	Path	Purpose
REST API (v1)	/api/v1/*	KUKAN native API. Recommended
CKAN-compatible API	/api/3/action/*	Compatibility with existing CKAN tools
MCP Server	/api/mcp	AI agent integration (Model Context Protocol)
OData feed	/odata/v1/resources/*	Read-only; a BI tool opens it as a table

Base URL

https://your-kukan-site

Response format

The REST API returns standard JSON. Errors follow RFC 7807 Problem Details.

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "Package not found"
}

The CKAN-compatible API follows CKAN conventions:

{
  "help": "https://your-kukan-site/api/3/action/...",
  "success": true,
  "result": { ... }
}

Pagination

List endpoints use offset / limit query parameters.

GET /api/v1/packages?offset=0&limit=20

The response format is:

{
  "items": [...],
  "total": 123,
  "offset": 0,
  "limit": 20
}

Rate limits

General API endpoints have no rate limit, but the sign-in endpoints (/api/auth/*) and AI metadata suggestions do (429 when exceeded). Contact operators before sending large bursts.