REST API
ScriptRunner Connect offers a RESTful API to help you accomplish more with the app.
You can create new API keys and access existing ones from the app by clicking your name at the bottom-left corner of the screen and then clicking API Keys.
Base URL âšī¸
The base URL is https://docs.api.scriptrunnerconnect.com/
Limited API coverage đ§
API coverage is currently limited, but it is expected to grow over time. Feel free to contact our support to request more capabilities.
Browsing the API
Authentication
ScriptRunner Connect API utilises basic authentication whereas the user's email is the username and the API key is the password. To generate an API key, click on your name in the left bottom area of the screen, then select API Keys. From there, you can generate a new API key.
Once you have the API key, send it along with the Authorization header as follows: Basic base64Encoded(UserName:ApiKey). When you generate the API Key, you will also receive the base64 encoded Authorization header value, which you can use directly.
Single key per activity âđŊ
We recommend generating a new key for each activity. This makes it easier to deactivate the activity by deleting the associated API key.
API keys are not retrievable đž
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.
Calling the API from ScriptRunner Connect
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.
Rate limiting
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.