REST API
The JAMS Web Client includes a REST API. Much of what the Web Client screens do can also be driven from a script, an integration, or a monitoring tool by calling the API instead.
The API is served by the JAMS API service, which is installed with the JAMS Web Client and runs on your own server. There is no JAMS-hosted endpoint to call: every request goes to your installation.
API Reference
JAMS REST API Reference (7.9.2)The page also offers the underlying OpenAPI document as a download, for generating a client or importing into a tool such as Postman.
The reference is a read-only document. It has no Try it out button, because it is not connected to a JAMS installation and has no server to send a request to. To execute requests, use the Swagger page on your own server, described below.
Base URL
Paths in the reference are relative to your JAMS Web Client host, and each one already includes the /api prefix. A path shown as /api/agents is therefore called as:
https://your-jams-host/api/agents
Authentication
Every request must be authenticated. There are two ways to do it:
| Method | Use it for |
|---|---|
| API Token | Scripts, integrations, and unattended processes. A token is issued in advance, sent as a bearer credential, and stays valid until it expires or is revoked. See API Tokens. |
| Interactive sign-in | Exploring the API by hand from the Swagger page on your server. An authorization lasts 15 minutes. |
A request carries the permissions of the user behind it, whether that is the signed-in user or an API Token's Run As user. The API enforces the same Access Control Lists as the Web Client. See Access Control.
The Swagger page on your JAMS server
Your installation serves its own Swagger page at https://your-jams-host/swagger. Unlike the reference above, it is connected to your live JAMS environment: you can authorize on it and execute real requests against your own data.
The definition dropdown on that page selects which definition you are working with. Entries ending in (OAuth) authorize with an interactive sign-in; entries ending in (System API Token) authorize with an API Token. For how to authorize with a token, see Using an API Token.
Requests executed from the Swagger page on your server are real. Submitting a Job, holding a Monitor entry, or deleting a Folder from that page does exactly what it would do in the Web Client.