Managed API for Jira Cloud is an API Client for Jira Cloud by Adaptavist primarily designed for the use in ScriptRunner Connect. You can read more about Managed APIs here.
This is a runtime agnostic version of the Managed API (with core
suffix) that makes it easy to port it to any runtime you may want to use this Managed API on.
- fetch
- Application
- Avatar
- Dashboard
- Filter
- Group
- GroupAndUserPicker
- Instance
- Issue
- assignIssue
- createIssue
- createIssues
- deleteIssue
- editIssue
- getChangeLogs
- getChangeLogsById
- getIssue
- sendNotification
- Attachment
- Comment
- Field
- getContexts
- getFields
- getFieldsPaginated
- Configuration
- Custom
- createField
- deleteField
- moveToTrash
- restoreField
- updateField
- Context
- Option
- Link
- Metadata
- Navigator
- Notification
- Scheme
- Priority
- Property
- Resolution
- Search
- Security
- getLevel
- getMembers
- Scheme
- Transition
- Type
- createType
- deleteType
- getAlternativeTypes
- getType
- getTypesForProject
- getTypesForUser
- loadTypeAvatar
- updateType
- Property
- Scheme
- Screen
- Vote
- Watcher
- Worklog
- Jql
- Label
- Myself
- Permission
- Project
- createProject
- deleteProject
- deleteProjectAsync
- getProject
- getProjects
- getStatuses
- restoreDeletedProject
- updateProject
- Avatar
- Category
- Component
- IssueType
- Notification
- Scheme
- Permission
- Property
- Role
- Security
- Scheme
- Type
- Validation
- Version
- Screen
- User
- Workflow
- createWorkflow
- deleteWorkflow
- getWorkflows
- Scheme
- Status
- getStatus
- getStatuses
- Category
- Transition
While the primary reason for creating Managed APIs was to use them in ScriptRunner Connect runtime, then you can easily port them to any runtime of your choosing.
You can do so by extending the *Core
Managed API class where you'll be asked to provide implementation for getPlatformImplementation
function. In this implementation you have to specify how to perform buffer encoding/decoding operations and how to perform HTTP calls:
{
buffer: {
encode(input: string): ArrayBuffer;
decode(input: ArrayBuffer): string;
},
performHttpCall(request: Request): Promise<Response>
}
Here is an example how to create a Node port of the Managed API:
import { JiraCloudApiCore } from "@managed-api/jira-cloud-v3-core";
import { PlatformImplementation, Request, Response, Headers } from "@managed-api/commons-core";
import fetch from "node-fetch";
export class JiraCloudApi extends JiraCloudApiCore {
constructor(private baseUrl: string, private authToken: string) {
super();
}
protected getPlatformImplementation(): PlatformImplementation {
return {
buffer: {
encode: (input) => Buffer.from(input, 'utf-8'),
decode: (input) => Buffer.from(input).toString('utf-8')
},
performHttpCall: (request) => this.performHttpCall(request)
};
}
private async performHttpCall(request: Request): Promise<Response> {
const requestUrl = `${this.baseUrl}${request.url}`; // Substitute base URL
request.headers.set('Authorization', `Basic ${this.authToken}`); // Substitute auth token
const response = await fetch(requestUrl, {
method: request.method,
headers: request.headers as any,
body: request.method.toLowerCase() !== 'get' ? Buffer.from((await request.arrayBuffer()) ?? new ArrayBuffer(0)) : undefined
});
const apiHeaders = new Headers();
response.headers.forEach((value, key) => apiHeaders.append(key, value));
const body = await response.arrayBuffer();
return super.buildResponse(response.url, response.status, response.statusText, apiHeaders, body);
}
}
Please note that the authentication handling details may not be accurate and serve as an example. If you wish to use these Managed APIs without having to concern yourself how to deal with and secure authentication details when working with APIs, then feel free to evaluate ScriptRunner Connect platform.
At this time Managed APIs are unlicensed and close sourced, but feel free to drop an email to eknoll@adaptavist.com for ideas, suggestions and improvements.
-
-
Get attachment content that can be used as
Issue.Attachment.getAttachmentContent
orAll.getIssueAttachmentContent
.
-
Get attachment content that can be used as
-
-
Search for issues using JQL enhanced search that can be used as
Issue.Search.searchByJqlEnhancedSearch
orAll.searchIssuesByJqlEnhancedSearch
.
-
Search for issues using JQL enhanced search that can be used as
-
-
Search for issues using JQL that can be used as
Issue.Search.searchByJql
orAll.searchIssuesByJql
.
-
Search for issues using JQL that can be used as
-
-
Jql.parseQuery
: Makevalidation
required in the request. -
Issue.Security.getMembers
: ChangeissueSecurityLevelId
to string in the request. -
User.Search.findUserKeysByQuery
: RemovemaxResults
from request and addmaxResult
. -
Issue.getIssue
: AddfailFast
,expand
andreturnIssue
to request. -
User.Search.findIssuesAssignableToUser
: AddissueId
to request. - Added optional properties to the responses of several methods.
-
-
Added support to pass
key
property forproject
field,name
property forissuetype
,fixVersions
,priority
,versions
,resolution
fields for the following methods:-
Create issue that can be used as
Issue.createIssue
orAll.createIssue
. -
Bulk create issue that can be used as
Issue.createIssues
orAll.createIssues
. -
Edit issue that can be used as
Issue.editIssue
orAll.editIssue
.
-
Create issue that can be used as
-
-
Create issue that can be used as
Issue.createIssue
orAll.createIssue
. -
Bulk create issue that can be used as
Issue.createIssues
orAll.createIssues
. -
Edit issue that can be used as
Issue.editIssue
orAll.editIssue
.
-
Create issue that can be used as
-
-
Search priorities that can be used as
Issue.Priority.searchPriorities
orAll.searchIssuePriorities
.
-
Search priorities that can be used as
-
-
Get notification scheme that can be used as
Issue.Notification.Scheme.getScheme
orAll.getIssueNotificationScheme
. -
Get resolution that can be used as
Issue.Resolution.getResolution
orAll.getIssueResolution
. -
Get priority that can be used as
Issue.Priority.getPriority
orAll.getIssuePriority
.
-
Get notification scheme that can be used as
-
-
Get priorities that can be used as
Issue.Priority.getPriorities
orAll.getIssuePriorities
. -
Get priority that can be used as
Issue.Priority.getPriority
orAll.getIssuePriority
. -
Get resolutions that can be used as
Issue.Resolution.getResolutions
orAll.getIssueResolutions
. -
Get resolution that can be used as
Issue.Resolution.getResolution
orAll.getIssueResolution
. -
Get notification scheme that can be used as
Issue.Notification.Scheme.getScheme
orAll.getIssueNotificationScheme
. -
Get project notification scheme that can be used as
Project.Notification.Scheme.getScheme
orAll.getProjectNotificationScheme
. Copyright Adaptavist 2025 (c) All rights reserved
-
Get priorities that can be used as