API Overview

API Overview


The JackDB API is designed to provide much of the same functionality to administrators of JackDB Enterprise as the web interface. Specifically, the API allows you to automate the creation and management of data sources, roles, permissions, and other system objects.

The JackDB API is organized around Representational State Transfer (REST).

The API is designed to:

  • be predictable with its inputs and outputs
  • have resource-oriented URLs
  • leverage the built-in features of HTTP
  • use HTTP response code to indicate API errors

All responses from the API will return in JSON format (including errors).

All requests must be made over HTTPS. Every request must be authenticated by an API key; unauthenticated requests will fail.

Administrators can create and manage API keys through the web interface.