Query ScriptRunner Connect's logs with the Public REST API

To illustrate how to go about querying our logs, we have an accompanying template that periodically creates a backup of script execution logs in AWS S3.

You can create new API keys and access existing ones from the app by clicking your name at the bottom-left corner of the UI (see screenshot below) and then clicking 'API Keys'. From there, you can generate a new API key.

Once you have the API key, send it along with the Authorisation header as follows: Basic base64Encoded(UserName:ApiKey). When you generate the API Key, you will also receive the base64 encoded Authorisation header value, which you can use directly.

The base URL is https://docs.api.scriptrunnerconnect.com/

Although we currently don't offer a connector or a managed API for our own API, you can call API endpoints from a workspace with the generic connector.

API endpoints are rate-limited; see Limits and Quotas to review the exact limits. If throttled, you'll see a 429 HTTP status code; retry the API call at a later time.

We recommend generating a new key for each activity. This makes it easier to deactivate the activity by deleting the associated API key.

Once the key is generated, make a copy and store it securely. Once you have closed the window that exposed the API key, you won't be able to retrieve it again.

API coverage is currently limited, but it is expected to grow over time. Feel free to contact our support team to request more capabilities or fill in the form below.