Management API Introduction

Manage sharing and users

The Management API allows you to manage sharing of objects (charts, dashboards, watchlists, etc) through the Library.

Authentication

Authentication is available via both customer-level API key as well as user-level API access tokens.

API keys should be passed with the x-api-key header, while access tokens should be passed with bearer auth. On the page for each API endpoint, you can switch between the 2 in the top-right of the page.

📘

Which should you use?

This is mainly relevant for the LibraryService.

Customer-level API keys operate as the service account user, which has access only to folders and library objects that have been shared to the entire customer (by sharing a folder with the customer user group).

User-level API access tokens allow the API to operate as the user who created the token. This means that the API will be able to manage library folders and objects that are private to that user, or have been shared but not with the entire customer group.

Examples:

curl --request GET \
     --url https://management.api.exabel.com/v1/folders \
     --header 'accept: application/json' \
     --header 'x-api-key: xxx'
curl --request GET \
     --url https://management.api.exabel.com/v1/folders \
     --header 'accept: application/json' \
     --header 'authorization: Bearer xxx'

Services

LibraryService: Create and manage Library folders, move objects between folders, and share/unshare folders with user groups.

UserService : List users and user groups within your customer organization.