Atlassian Jira On Premise

the atlassian jira on premise connector allows for automated issue tracking and project management within the swimlane turbine platform atlassian jira on premise is a powerful issue and project tracking tool widely used by development and operations teams the swimlane turbine connector for jira on premise enables users to automate the creation, updating, and management of jira issues, enhancing collaboration and incident response by leveraging this integration, teams can attach files, add comments, transition issues, and execute searches within jira directly from the swimlane platform, streamlining workflows and reducing manual effort atlassian jira on premise connector integrates with swimlane to allow creating, editing, retrieve, search issues and add and delete attachments prerequisites to utilize the atlassian jira on premise connector, ensure you have the following prerequisites http basic authentication with these parameters url the base url of your jira instance username your jira username api token a jira api token used in place of a password for increased security http bearer authentication with these parameters url the base url of your jira instance personal access token (pat) a personal access token for bearer token authentication capabilities this connector provides the following capabilities add attachment add comment create issue delete attachment edit issue get attachment get comments get issue get issuetypes get issue transitions issue transition search input details add attachment this resource expects a multipart post the media type multipart/form data is defined in rfc 1867 most client libraries have classes that make dealing with multipart posts simple for instance, in java the apache http components library provides a multipartentity http //hc apache org/httpcomponents client ga/httpmime/apidocs/org/apache/http/entity/mime/multipartentity html that makes it simple to submit a multipart post in order to protect against xsrf attacks, because this method accepts multipart/form data, it has xsrf protection on it this means you must submit a header of x atlassian token no check with the request, otherwise it will be blocked the name of the multipart/form data parameter that contains attachments must be "file" create issue the fields that can be set on create, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/createmeta resource if a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field validation error will occur if it is submitted creating a sub task is similar to creating a regular issue, with two important differences the issuetype field must correspond to a sub task issue type (you can use /issue/createmeta to discover sub task issue types), and you must provide a parent field in the issue create request containing the id or key of the parent issue the updatehistory param adds the project that this issue is created in, to the current user's project history, if set to true (by default, the project history is not updated) example { "update" { "worklog" \[ { "add" { "timespent" "60m", "started" "2011 07 05t11 05 00 000+0000" } } ] } } or { "fields" { "project" { "id" "10000" }, "summary" "something's wrong", "issuetype" { "id" "10000" }, "assignee" { "name" "homer" }, "reporter" { "name" "smithers" }, "priority" { "id" "20000" }, "labels" \[ "bugfix", "blitz test" ] } } edit issue the issue can either be updated by setting explicit the field value(s) or by using an operation to change the field value the fields that can be updated, in either the fields parameter or the update parameter, can be determined using the /rest/api/2/issue/{issueidorkey}/editmeta resource if a field is not configured to appear on the edit screen, then it will not be in the editmeta, and a field validation error will occur if it is submitted specifying a "field id" field value in the "fields" is a shorthand for a "set" operation in the "update" section field should appear either in "fields" or "update", not in both example { "update" { "summary" \[ {"set" "bug in business logic"} ], "components" \[ {"set" "some component"} ] } } or { "fields" { "summary" "this is a shorthand for a set operation on the summary field", "components" "some component" } } get issue an issue json consists of the issue key, a collection of fields, a link to the workflow transition sub resource, and (optionally) the html rendered values of any fields that support it (e g if wiki syntax is enabled for the description or comments) the fields param (which can be specified multiple times) gives a comma separated list of fields to include in the response this can be used to retrieve a subset of fields a particular field can be excluded by prefixing it with a minus by default, all ( all) fields are returned in this get issue resource note the default is different when doing a jql search the default there is just navigable fields ( navigable) for more details, please refer to notes section of get issue search sorting the jql parameter is a full jql expression, and includes an order by clause the fields param (which can be specified multiple times) gives a comma separated list of fields to include in the response this can be used to retrieve a subset of fields a particular field can be excluded by prefixing it with a minus by default, only navigable ( navigable) fields are returned in this search resource note the default is different in the get issue resource the default there all fields ( all) for more details, please refer to notes section expanding issues in the search result it is possible to expand the issues returned by directly specifying the expansion on the expand parameter passed in to this resources for instance, to expand the "changelog" for all the issues on the search result, it is neccesary to specify "changelog" as one of the values to expand issue transition the fields that can be set on transition, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/{issueidorkey}/transitions?expand=transitions fields resource if a field is not configured to appear on the transition screen, then it will not be in the transition metadata, and a field validation error will occur if it is submitted the updatehistory param adds the issues retrieved by this method to the current user's issue history, if set to true (by default, the issue history does not include issues retrieved via the rest api) you can view the issue history in the jira application, via the issues dropdown or by using the lastviewed jql field in an issue search example { "transition" { "id" "41" } } configurations atlassian jira on prem http basic authentication authenticates atlassian jira on prem using username and password configuration parameters parameter description type required url a url to the target host string required username username string required password api token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional jira server pat authentication authenticates using bearer token such as a jwt, etc configuration parameters parameter description type required url a url to the target host string required token personal access token string required verify ssl verify ssl certificate boolean optional http proxy a proxy to route requests through string optional actions add attachment attach files to a specified jira issue using the issueidorkey requires path parameters and form data endpoint url /rest/api/2/issue/{{issueidorkey}}/attachments method post input argument name type required description issueidorkey string required unique identifier headers object optional http headers for the request x atlassian token string optional parameter for add attachment form data object required response data file array required parameter for add attachment file name string required name of the resource file string required parameter for add attachment output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "reason" "ok", "response headers" {}, "json body" \[ {} ] } ] add comment adds a new comment to a specified issue in atlassian jira on premise, requiring the issue id or key and author details endpoint url /rest/api/2/issue/{{issueidorkey}}/comment method post input argument name type required description issueidorkey string required unique identifier expand string optional parameter for add comment id string optional unique identifier author object required parameter for add comment name string optional name of the resource key string optional parameter for add comment emailaddress string optional parameter for add comment avatarurls object optional url endpoint for the request displayname string optional name of the resource active boolean required parameter for add comment timezone string optional parameter for add comment body string optional request body data renderedbody string optional request body data updateauthor object required parameter for add comment name string optional name of the resource key string optional parameter for add comment emailaddress string optional parameter for add comment avatarurls object optional url endpoint for the request displayname string optional name of the resource active boolean required parameter for add comment timezone string optional parameter for add comment created string optional parameter for add comment updated string optional parameter for add comment visibility object optional parameter for add comment type string optional type of the resource output parameter type description status code number http status code of the response reason string response reason phrase self string output field self id string unique identifier author object output field author self string output field self name string name of the resource displayname string name of the resource active boolean output field active body string request body data updateauthor object output field updateauthor self string output field self name string name of the resource displayname string name of the resource active boolean output field active created string output field created updated string output field updated visibility object output field visibility type string type of the resource value string value for the parameter example \[ { "status code" 201, "reason" "ok", "response headers" {}, "json body" { "self" "http //www example com/jira/rest/api/2/issue/10010/comment/10000", "id" "10000", "author" {}, "body" "lorem ipsum dolor sit amet, consectetur adipiscing elit pellentesque eget venen ", "updateauthor" {}, "created" "2024 01 22t19 59 47 595+0000", "updated" "2024 01 22t19 59 47 595+0000", "visibility" {} } } ] create issue create an issue or sub task in atlassian jira on premise using a json representation with required 'fields' data endpoint url /rest/api/2/issue method post input argument name type required description updatehistory boolean optional if true then the user's project history is updated fields object required parameter for create issue summary string required parameter for create issue parent object optional parameter for create issue key string optional parameter for create issue issuetype object required type of the resource id string required unique identifier components array optional parameter for create issue id string optional unique identifier project object required parameter for create issue id string required unique identifier description object optional parameter for create issue type string optional type of the resource version number optional parameter for create issue content array optional response content type string optional type of the resource content array optional response content reporter object optional parameter for create issue id string optional unique identifier fixversions array optional parameter for create issue id string optional unique identifier priority object optional parameter for create issue id string optional unique identifier labels array optional parameter for create issue timetracking object optional parameter for create issue output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier key string output field key self string output field self example \[ { "status code" 201, "reason" "ok", "response headers" {}, "json body" { "id" "10000", "key" "tst 24", "self" "http //www example com/jira/rest/api/2/issue/10000" } } ] delete attachment removes a specified attachment from an issue in atlassian jira on premise using the attachment's unique id endpoint url /rest/api/2/attachment/{{id}} method delete input argument name type required description id string required unique identifier output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 204, "reason" "removal was successful", "response headers" {}, "json body" {} } ] edit issue edits an existing issue in atlassian jira on premise using the specified issue id or key and a json payload endpoint url /rest/api/2/issue/{{issueidorkey}} method put input argument name type required description issueidorkey string required unique identifier notifyusers boolean optional parameter for edit issue historymetadata object optional response data actor object optional parameter for edit issue avatarurl string optional url endpoint for the request displayname string optional name of the resource id string optional unique identifier type string optional type of the resource url string optional url endpoint for the request extradata object optional response data iteration string optional parameter for edit issue step string optional parameter for edit issue description string optional parameter for edit issue generator object optional parameter for edit issue id string optional unique identifier type string optional type of the resource cause object optional parameter for edit issue id string optional unique identifier type string optional type of the resource activitydescription string optional parameter for edit issue type string optional type of the resource update object optional date value summary array optional parameter for edit issue set string optional parameter for edit issue components array optional parameter for edit issue output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text example \[ { "status code" 200, "response headers" { "content type" "application/json", "date" "thu, 01 jan 2024 00 00 00 gmt" }, "reason" "ok", "response text" "string" } ] get attachment retrieve metadata for a specified attachment in atlassian jira on premise using the attachment id endpoint url /rest/api/2/attachment/{{id}} method get input argument name type required description id string required the id of the attachment output parameter type description status code number http status code of the response reason string response reason phrase id number unique identifier self string output field self filename string name of the resource author object output field author self string output field self accountid string unique identifier avatarurls object url endpoint for the request 48x48 string output field 48x48 24x24 string output field 24x24 16x16 string output field 16x16 32x32 string output field 32x32 displayname string name of the resource active boolean output field active created string output field created size number output field size mimetype string type of the resource properties object output field properties content string response content thumbnail string output field thumbnail example \[ { "status code" 200, "response headers" { "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "date" "wed, 15 oct 2025 09 36 20 gmt", "server" "atlassianedge", "timing allow origin" " ", "x arequestid" "4721db0c6b91ec8c05ff58ae054477b8", "set cookie" "atlassian xsrf token=755c33fb6d023b29c1756351184ee8bdac229bf7 lin; path=/; sames ", "x aaccountid" "712020%3aab4557ae 85d6 46c8 a771 c72866daee0d", "cache control" "no cache, no store, no transform", "x beta ratelimit limit" "350", "x beta ratelimit remaining" "348", "vary" "accept encoding", "content encoding" "gzip", "x content type options" "nosniff" }, "reason" "ok", "json body" { "id" 10033, "self" "https //saikumarbadri845 atlassian net/rest/api/2/attachment/10033", "filename" "greenbone logo png", "author" {}, "created" "2025 10 15t15 00 07 959+0530", "size" 18264, "mimetype" "image/png", "properties" {}, "content" "https //saikumarbadri845 atlassian net/rest/api/2/attachment/content/10033", "thumbnail" "https //saikumarbadri845 atlassian net/rest/api/2/attachment/thumbnail/10033" } } ] get comments retrieves all comments associated with a specified issue in atlassian jira using the issueidorkey endpoint url /rest/api/2/issue/{{issueidorkey}}/comment method get input argument name type required description startat number optional the page offset, if not specified then defaults to 0 maxresults number optional how many results on the page should be included defaults to 50 orderby string optional ordering of the results expand string optional optional flags renderedbody (provides body rendered in html) issueidorkey string required the id or key of the issue to get comments for output parameter type description status code number http status code of the response reason string response reason phrase startat number output field startat maxresults number result of the operation total number output field total comments array output field comments self string output field self id string unique identifier author object output field author self string output field self accountid string unique identifier emailaddress string output field emailaddress avatarurls object url endpoint for the request 48x48 string output field 48x48 24x24 string output field 24x24 16x16 string output field 16x16 32x32 string output field 32x32 displayname string name of the resource active boolean output field active timezone string output field timezone accounttype string type of the resource body string request body data updateauthor object output field updateauthor self string output field self accountid string unique identifier example \[ { "status code" 200, "response headers" { "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "date" "wed, 15 oct 2025 09 40 35 gmt", "server" "atlassianedge", "timing allow origin" " ", "x arequestid" "3cf3be5bed36ce8852b022b22fad4680", "set cookie" "atlassian xsrf token=34825ff539cae4c90e5c4d95ea5046864837e5a9 lin; path=/; sames ", "x aaccountid" "712020%3aab4557ae 85d6 46c8 a771 c72866daee0d", "cache control" "no cache, no store, no transform", "x beta ratelimit limit" "350", "x beta ratelimit remaining" "348", "vary" "accept encoding", "content encoding" "gzip", "x content type options" "nosniff" }, "reason" "ok", "json body" { "startat" 0, "maxresults" 100, "total" 2, "comments" \[] } } ] get issue retrieve a full representation of a jira issue using the specified issue key or id endpoint url /rest/api/2/issue/{{issueidorkey}} method get input argument name type required description issueidorkey string required unique identifier fields string optional the list of fields to return for the issue by default, all fields are returned expand string optional parameter for get issue properties string optional the list of properties to return for the issue by default no properties are returned updatehistory boolean optional parameter for get issue output parameter type description status code number http status code of the response reason string response reason phrase expand string output field expand id string unique identifier self string output field self key string output field key fields object output field fields watcher object output field watcher attachment array output field attachment sub tasks array output field sub tasks description string output field description project object output field project comment array output field comment issuelinks array output field issuelinks worklog array output field worklog updated number output field updated timetracking object output field timetracking names object name of the resource schema object output field schema example \[ { "status code" 200, "reason" "ok", "response headers" {}, "json body" { "expand" "renderedfields,names,schema,operations,editmeta,changelog,versionedrepresentatio ", "id" "10002", "self" "http //www example com/jira/rest/api/2/issue/10002", "key" "ex 1", "fields" {}, "names" {}, "schema" {} } } ] get issue transitions retrieve available workflow transitions for a specified issue in atlassian jira using the issueidorkey endpoint url /rest/api/2/issue/{{issueidorkey}}/transitions method get input argument name type required description issueidorkey string required unique identifier transitionid string optional unique identifier expand string optional parameter for get issue transitions output parameter type description status code number http status code of the response reason string response reason phrase expand string output field expand transitions array output field transitions id string unique identifier name string name of the resource to object output field to self string output field self description string output field description iconurl string url endpoint for the request name string name of the resource id string unique identifier statuscategory object status value self string output field self id number unique identifier key string output field key colorname string name of the resource name string name of the resource hasscreen boolean output field hasscreen isglobal boolean output field isglobal isinitial boolean output field isinitial isavailable boolean output field isavailable isconditional boolean output field isconditional islooped boolean output field islooped example \[ { "status code" 200, "response headers" { "date" "thu, 14 mar 2024 10 55 21 gmt", "content type" "application/json;charset=utf 8", "server" "atlassianedge", "timing allow origin" " ", "x arequestid" "01a9bcce2d2e22ac682648d57a91d21c", "set cookie" "atlassian xsrf token=ae9ec298fd6a6260aad919dc8100fbac03038d54 lin; path=/; sames ", "x aaccountid" "63b4c0c5082abdd71bb64f24", "cache control" "no cache, no store, no transform", "vary" "accept encoding", "content encoding" "gzip", "x content type options" "nosniff", "x xss protection" "1; mode=block", "atl traceid" "2fa0df8fffa74b83b184fdbf66605aa7", "strict transport security" "max age=63072000; includesubdomains; preload", "report to" "{\\"endpoints\\" \[{\\"url\\" \\"https //dz8aopenkvv6s cloudfront net\\"}], \\"group\\" \\"endpo " }, "reason" "ok", "json body" { "expand" "transitions", "transitions" \[] } } ] get issuetypes retrieve all issue types available in atlassian jira on premise that the current user has visibility of endpoint url /rest/api/2/issuetype method get output parameter type description status code number http status code of the response reason string response reason phrase example \[ { "status code" 200, "response headers" { "content type" "application/json;charset=utf 8", "transfer encoding" "chunked", "connection" "keep alive", "date" "wed, 15 oct 2025 09 51 23 gmt", "server" "atlassianedge", "timing allow origin" " ", "x arequestid" "98aec3331636c732add6a1589479d7cd", "set cookie" "atlassian xsrf token=2d037883c1d7293963032df25cc910d647853d18 lin; path=/; sames ", "x aaccountid" "712020%3aab4557ae 85d6 46c8 a771 c72866daee0d", "cache control" "no cache, no store, no transform", "x beta ratelimit limit" "350", "x beta ratelimit remaining" "348", "vary" "accept encoding", "content encoding" "gzip", "x content type options" "nosniff" }, "reason" "ok", "json body" \[ {}, {}, {} ] } ] issue transition performs a transition on a jira issue using the specified issueidorkey and updates or sets fields as needed endpoint url /rest/api/2/issue/{{issueidorkey}}/transitions method post input argument name type required description issueidorkey string required unique identifier transition object required parameter for issue transition id string optional unique identifier name string optional name of the resource to object optional parameter for issue transition name string optional name of the resource id string optional unique identifier statuscategory object optional status value id number optional unique identifier hasscreen boolean optional parameter for issue transition isglobal boolean optional parameter for issue transition isinitial boolean optional parameter for issue transition isavailable boolean optional parameter for issue transition isconditional boolean optional parameter for issue transition islooped boolean optional parameter for issue transition update object optional date value fields object optional parameter for issue transition output parameter type description status code number http status code of the response reason string response reason phrase response text string output field response text example \[ { "status code" 204, "response headers" { "date" "thu, 14 mar 2024 11 46 30 gmt", "content type" "text/html;charset=utf 8", "server" "atlassianedge", "timing allow origin" " ", "x arequestid" "c3e33947c9397314e2813e89af530487", "set cookie" "atlassian xsrf token=8080b8cf421caf2bc881add5736b334bbe88b6a2 lin; path=/; sames ", "x aaccountid" "63b4c0c5082abdd71bb64f24", "cache control" "no cache, no store, no transform", "x frame options" "sameorigin", "vary" "accept encoding", "x content type options" "nosniff", "x xss protection" "1; mode=block", "atl traceid" "8d1d673909604e128c9ea6e240e41e87", "strict transport security" "max age=63072000; includesubdomains; preload", "report to" "{\\"endpoints\\" \[{\\"url\\" \\"https //dz8aopenkvv6s cloudfront net\\"}], \\"group\\" \\"endpo " }, "reason" "no content", "response text" "" } ] search executes a search for issues in atlassian jira on premise using the jira query language (jql) endpoint url /rest/api/2/search method get input argument name type required description jql string optional parameter for search startat number optional parameter for search maxresults number optional result of the operation validatequery boolean optional unique identifier fields string optional parameter for search expand string optional parameter for search output parameter type description status code number http status code of the response reason string response reason phrase id string unique identifier title string output field title type string type of the resource properties object output field properties expand object output field expand startat object output field startat maxresults object result of the operation total object output field total issues object output field issues warningmessages object response message names object name of the resource schema object output field schema definitions object output field definitions field meta object output field field meta history metadata participant object response data json type object type of the resource link group object output field link group simple link object output field simple link additionalproperties boolean output field additionalproperties example \[ { "status code" 200, "reason" "ok", "response headers" {}, "json body" { "id" "https //docs atlassian com/jira/rest/schema/search results#", "title" "search results", "type" "object", "properties" {}, "definitions" {}, "additionalproperties" false } } ] response headers header description example atl request id http response header atl request id 184a6de0 0e99 4055 b7f9 a0fcacb3c25e atl traceid http response header atl traceid 2fa0df8fffa74b83b184fdbf66605aa7 cache control directives for caching mechanisms no cache, no store, no transform connection http response header connection keep alive content encoding http response header content encoding gzip content type the media type of the resource application/json date the date and time at which the message was originated wed, 15 oct 2025 09 40 35 gmt nel http response header nel {"failure fraction" 0 001, "include subdomains" true, "max age" 600, "report to" "endpoint 1"} report to http response header report to {"endpoints" \[{"url" " https //dz8aopenkvv6s cloudfront net https //dz8aopenkvv6s cloudfront net "}], "group" "endpoint 1", "include subdomains" true, "max age" 600} server information about the software used by the origin server atlassianedge server timing http response header server timing cdn upstream layer;desc="edge",cdn upstream dns;dur=0,cdn upstream connect;dur=1,cdn upstream fbl;dur=470,atl edge;dur=463,atl edge internal;dur=213,atl edge upstream;dur=249,atl edge pop;desc="aws ap south 1",cdn cache miss,cdn pop;desc="bom78 p2",cdn rid;desc="shvkliavw2xuxfnr9nnz ugguk25ta4dbbnpmj mvl27knjweluyha==",cdn downstream fbl;dur=473 set cookie http response header set cookie atlassian xsrf token=8080b8cf421caf2bc881add5736b334bbe88b6a2 lin; path=/; samesite=none; secure strict transport security http response header strict transport security max age=63072000; includesubdomains; preload timing allow origin http response header timing allow origin transfer encoding http response header transfer encoding chunked vary http response header vary accept encoding via http response header via 1 1 42d8b5806519269a38fa2b69fb2e2d36 cloudfront net (cloudfront) x aaccountid http response header x aaccountid 712020%3aab4557ae 85d6 46c8 a771 c72866daee0d x amz cf id http response header x amz cf id tupgfefdcjui2tmorr6h6amqlwsq70xsaiq5prjlbs45pdftsybt8g== x amz cf pop http response header x amz cf pop bom78 p1 x arequestid http response header x arequestid 01a9bcce2d2e22ac682648d57a91d21c x beta ratelimit limit http response header x beta ratelimit limit 350 x beta ratelimit remaining http response header x beta ratelimit remaining 348 x cache http response header x cache miss from cloudfront x content type options http response header x content type options nosniff notes atlassian jira on premise api documentation https //docs atlassian com/software/jira/docs/api/rest/9 13 0/ get issue api documentation https //docs atlassian com/software/jira/docs/api/rest/9 13 0/#api/2/issue getissue search api documentation https //docs atlassian com/software/jira/docs/api/rest/9 13 0/#api/2/search search