--- title: Atlassian Jira On Premise slug: connectors/atlassian-jira-on-premise docTags: createdAt: 2026-06-09T16:29:59.981Z --- Atlassian Jira On Premise is a self-hosted project management tool for tracking and managing software development projects. Atlassian Jira On Premise is a robust issue tracking and project management platform designed for software development teams. This connector enables seamless integration with Swimlane Turbine, allowing users to automate Jira issue tracking and management tasks. By leveraging this integration, users can efficiently create, update, and manage issues, comments, and attachments, enhancing workflow automation and reducing manual effort. The connector empowers security teams to streamline operations, improve response times, and maintain comprehensive oversight of project activities within the Jira environment. Atlassian Jira On Premise Connector integrates with Swimlane to allow creating, editing, retrieve, search issues and add and delete attachments. ## Prerequisites Before you can use the Atlassian Jira On Premise connector for Turbine, you'll need access to the Jira API. This requires the following: - HTTP Bearer authentication using the following parameters: - URL: The base URL of your Jira On Premise instance. - Personal Access Token (PAT): A token used for authenticating API requests. - HTTP Basic authentication using the following parameters: - URL: The base URL of your Jira On Premise instance. - Username: Your Jira username for authentication. - API Token: A token generated from your Jira account for secure API access. ## 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: ```javascript { "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//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: ```javascript { "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//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: ```javascript { "transition": { "id": "41" } } ``` ## 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) ## Additional Documentation - [Atlassian Jira On Premise Connector Documentation](https://docs.swimlane.com/connectors/atlassian-jira-on-premise) - [Atlassian Jira On Premise API Documentation](https://docs.atlassian.com/software/jira/docs/api/REST/9.13.0/) - [Atlassian Jira On Premise Authentication Guide](https://docs.swimlane.com/authentication-guides/atlassian-jira-on-premise) # 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** | | ------------------------------ | -------- | ------------ | ---------------------------------------- | | `path_parameters.issueIdOrKey` | string | Required | Parameters for the Add Attachment action | | `headers` | object | Optional | HTTP headers for the request | | `headers.X-Atlassian-Token` | string | Optional | HTTP headers for the request | | `form_data` | object | Required | Response data | | `form_data.file` | array | Required | Response data | | `form_data.file.file_name` | string | Required | Response data | | `form_data.file.file` | string | Required | Response data | ### Input Example `{"path_parameters":{"issueIdOrKey":"10000"},"headers":{"X-Atlassian-Token":"no-check"},"form_data":{"file":[]}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":200,"reason":"OK","response_headers":{},"json_body":[{"self":"http://www.example.com/jira/rest/api/2.0/attachments/10000","filename":"picture.jpg","author":{},"created":"2024-01-22T19:59:47.624+0000","size":23123,"mimeType":"image/jpeg","content":"http://www.example.com/jira/attachments/10000","thumbnail":"http://www.example.com/jira/secure/thumbnail/10000"}]}` ## Add Comment Add 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** | | ------------------------------ | -------- | ------------ | ------------------------------------- | | `path_parameters.issueIdOrKey` | string | Required | Parameters for the Add Comment action | | `parameters.expand` | string | Optional | Parameters for the Add Comment action | | `id` | string | Optional | Unique identifier | | `author` | object | Optional | Parameter for Add Comment | | `author.name` | string | Optional | Name of the resource | | `author.key` | string | Optional | Parameter for Add Comment | | `author.emailAddress` | string | Optional | Parameter for Add Comment | | `author.avatarUrls` | object | Optional | URL endpoint for the request | | `author.displayName` | string | Optional | Name of the resource | | `author.active` | boolean | Required | Parameter for Add Comment | | `author.timeZone` | string | Optional | Parameter for Add Comment | | `body` | string | Optional | Request body data | | `renderedBody` | string | Optional | Request body data | | `updateAuthor` | object | Optional | Parameter for Add Comment | | `updateAuthor.name` | string | Optional | Name of the resource | | `updateAuthor.key` | string | Optional | Parameter for Add Comment | | `updateAuthor.emailAddress` | string | Optional | Parameter for Add Comment | | `updateAuthor.avatarUrls` | object | Optional | URL endpoint for the request | | `updateAuthor.displayName` | string | Optional | Name of the resource | | `updateAuthor.active` | boolean | Required | Parameter for Add Comment | | `updateAuthor.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 | | `visibility.type` | string | Optional | Type of the resource | ### Input Example `{"parameters":{"expand":"renderedBody"},"path_parameters":{"issueIdOrKey":"10000"}}` ### 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 | | `author.self` | string | Output field: author.self | | `author.name` | string | Name of the resource | | `author.displayName` | string | Name of the resource | | `author.active` | boolean | Output field: author.active | | `body` | string | Request body data | | `updateAuthor` | object | Output field: updateAuthor | | `updateAuthor.self` | string | Output field: updateAuthor.self | | `updateAuthor.name` | string | Name of the resource | | `updateAuthor.displayName` | string | Name of the resource | | `updateAuthor.active` | boolean | Output field: updateAuthor.active | | `created` | string | Output field: created | | `updated` | string | Output field: updated | | `visibility` | object | Output field: visibility | | `visibility.type` | string | Type of the resource | | `visibility.value` | string | Value for the parameter | ### Output 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":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred F. User","active":false},"body":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque eget venen...","updateAuthor":{"self":"http://www.example.com/jira/rest/api/2/user?username=fred","name":"fred","displayName":"Fred...` ## 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** | | --------------------------------------- | -------- | ------------ | --------------------------------------------------- | | `parameters.updateHistory` | boolean | Optional | if true then the user's project history is updated. | | `fields` | object | Optional | Parameter for Create Issue | | `fields.summary` | string | Required | Parameter for Create Issue | | `fields.parent` | object | Optional | Parameter for Create Issue | | `fields.parent.key` | string | Optional | Parameter for Create Issue | | `fields.issuetype` | object | Required | Type of the resource | | `fields.issuetype.id` | string | Required | Unique identifier | | `fields.components` | array | Optional | Parameter for Create Issue | | `fields.components.id` | string | Optional | Unique identifier | | `fields.project` | object | Required | Parameter for Create Issue | | `fields.project.id` | string | Required | Unique identifier | | `fields.description` | string | Optional | Parameter for Create Issue | | `fields.reporter` | object | Optional | Parameter for Create Issue | | `fields.reporter.id` | string | Optional | Unique identifier | | `fields.fixVersions` | array | Optional | Parameter for Create Issue | | `fields.fixVersions.id` | string | Optional | Unique identifier | | `fields.priority` | object | Optional | Parameter for Create Issue | | `fields.priority.id` | string | Optional | Unique identifier | | `fields.labels` | array | Optional | Parameter for Create Issue | | `fields.timetracking` | object | Optional | Parameter for Create Issue | | `fields.timetracking.remainingEstimate` | string | Optional | Parameter for Create Issue | | `fields.timetracking.originalEstimate` | string | Optional | Parameter for Create Issue | | `fields.security` | object | Optional | Parameter for Create Issue | | `fields.security.id` | string | Optional | Unique identifier | | `fields.environment` | string | Optional | Parameter for Create Issue | ### Input Example `{"parameters":{"updateHistory":false},"json_body":{"fields":{"summary":"Issue summary","parent":{"key":"SCT-214"},"issuetype":{"id":"10000"},"components":[{"id":"10000"}],"project":{"id":"11435"},"description":"Order entry fails when selecting supplier.","reporter":{"id":"5b10a2844c20165700ede21g"},"fixVersions":[{"id":"10001"}],"priority":{"id":"20000"},"labels":["bugfix","blitz_test"],"timetracking":{"remainingEstimate":"5","originalEstimate":"10"},"security":{"id":"10000"},"environment":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"UAT","type":"text"}]}]},"versions":[{"id":"10000"}],"duedate":"2019-05-11","assignee":{"id":"5b109f2e9729b51b54dc274d"}}}}` ### 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 | ### Output 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 Remove 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** | | -------------------- | -------- | ------------ | ------------------------------------------- | | `path_parameters.id` | string | Required | Parameters for the Delete Attachment action | ### Input Example `{"path_parameters":{"id":"10000"}}` ### Output | **Parameter** | **Type** | **Description** | | ------------- | -------- | -------------------------------- | | `status_code` | number | HTTP status code of the response | | `reason` | string | Response reason phrase | ### Output Example `{"status_code":204,"reason":"Removal was successful","response_headers":{},"json_body":{}}` ## Edit Issue Edit 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** | | ------------------------------------- | -------- | ------------ | ------------------------------------ | | `path_parameters.issueIdOrKey` | string | Required | Parameters for the Edit Issue action | | `parameters.notifyUsers` | boolean | Optional | Parameters for the Edit Issue action | | `historyMetadata` | object | Optional | Response data | | `historyMetadata.actor` | object | Optional | Response data | | `historyMetadata.actor.avatarUrl` | string | Optional | Response data | | `historyMetadata.actor.displayName` | string | Optional | Response data | | `historyMetadata.actor.id` | string | Optional | Response data | | `historyMetadata.actor.type` | string | Optional | Response data | | `historyMetadata.actor.url` | string | Optional | Response data | | `historyMetadata.extraData` | object | Optional | Response data | | `historyMetadata.extraData.Iteration` | string | Optional | Response data | | `historyMetadata.extraData.Step` | string | Optional | Response data | | `historyMetadata.description` | string | Optional | Response data | | `historyMetadata.generator` | object | Optional | Response data | | `historyMetadata.generator.id` | string | Optional | Response data | | `historyMetadata.generator.type` | string | Optional | Response data | | `historyMetadata.cause` | object | Optional | Response data | | `historyMetadata.cause.id` | string | Optional | Response data | | `historyMetadata.cause.type` | string | Optional | Response data | | `historyMetadata.activityDescription` | string | Optional | Response data | | `historyMetadata.type` | string | Optional | Response data | | `update` | object | Optional | Date value | | `update.summary` | array | Optional | Parameter for Edit Issue | | `update.summary.set` | string | Optional | Parameter for Edit Issue | | `update.components` | array | Optional | Parameter for Edit Issue | ### Input Example `{"parameters":{"notifyUsers":true},"json_body":{"historyMetadata":{"actor":{"avatarUrl":"http://mysystem/avatar/tony.jpg","displayName":"Tony","id":"tony","type":"mysystem-user","url":"http://mysystem/users/tony"},"extraData":{"Iteration":"10a","Step":"4"},"description":"From the order testing process","generator":{"id":"mysystem-1","type":"mysystem-application"},"cause":{"id":"myevent","type":"mysystem-event"},"activityDescription":"Complete order processing","type":"myplugin:type"},"update":{"summary":[{"set":"Bug in business logic"}],"components":[{"set":""}],"timetracking":[{"edit":{"remainingEstimate":"4d","originalEstimate":"1w 1d"}}],"labels":[{"add":"triaged"},{"remove":"blocker"}]},"fields":{"summary":"Completed orders still displaying in pending","customfield_10010":1,"customfield_10000":{"type":"doc","version":1,"content":[{"type":"paragraph","content":[{"text":"Investigation underway","type":"text"}]}]}},"properties":[{"value":"Order number 10784","key":"key1"},{"value":"Order number 10923","key":"key2"}]},"path_parameters":{"issueIdOrKey":"10002"}}` ### 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 | ### Output Example `{"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** | | -------------------- | -------- | ------------ | ------------------------- | | `path_parameters.id` | string | Required | The ID of the attachment. | ### Input Example `{"path_parameters":{"id":"10033"}}` ### 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 | | `author.self` | string | Output field: author.self | | `author.accountId` | string | Unique identifier | | `author.avatarUrls` | object | URL endpoint for the request | | `author.avatarUrls.48x48` | string | URL endpoint for the request | | `author.avatarUrls.24x24` | string | URL endpoint for the request | | `author.avatarUrls.16x16` | string | URL endpoint for the request | | `author.avatarUrls.32x32` | string | URL endpoint for the request | | `author.displayName` | string | Name of the resource | | `author.active` | boolean | Output field: author.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 | ### Output 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-B...` ## Get Comments Retrieve all comments for a specified issue in Atlassian Jira using the issueIdOrKey as a path parameter. ### Endpoint - **URL:** `/rest/api/2/issue/{{issueIdOrKey}}/comment` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------ | -------- | ------------ | ---------------------------------------------------------------- | | `parameters.startAt` | number | Optional | The page offset, if not specified then defaults to 0. | | `parameters.maxResults` | number | Optional | How many results on the page should be included. Defaults to 50. | | `parameters.orderBy` | string | Optional | Ordering of the results. | | `parameters.expand` | string | Optional | Optional flags- renderedBody (provides body rendered in HTML) | | `path_parameters.issueIdOrKey` | string | Required | The ID or key of the issue to get comments for. | ### Input Example `{"parameters":{"startAt":0,"maxResults":1,"orderBy":"created","expand":"renderedBody"},"path_parameters":{"issueIdOrKey":"SCRUM-1"}}` ### 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 | | `comments.self` | string | Output field: comments.self | | `comments.id` | string | Unique identifier | | `comments.author` | object | Output field: comments.author | | `comments.author.self` | string | Output field: comments.author.self | | `comments.author.accountId` | string | Unique identifier | | `comments.author.emailAddress` | string | Output field: comments.author.emailAddress | | `comments.author.avatarUrls` | object | URL endpoint for the request | | `comments.author.avatarUrls.48x48` | string | URL endpoint for the request | | `comments.author.avatarUrls.24x24` | string | URL endpoint for the request | | `comments.author.avatarUrls.16x16` | string | URL endpoint for the request | | `comments.author.avatarUrls.32x32` | string | URL endpoint for the request | | `comments.author.displayName` | string | Name of the resource | | `comments.author.active` | boolean | Output field: comments.author.active | | `comments.author.timeZone` | string | Output field: comments.author.timeZone | | `comments.author.accountType` | string | Type of the resource | | `comments.body` | string | Request body data | | `comments.updateAuthor` | object | Output field: comments.updateAuthor | | `comments.updateAuthor.self` | string | Output field: comments.updateAuthor.self | | `comments.updateAuthor.accountId` | string | Unique identifier | ### Output 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-B...` ## Get Issue Retrieve a full representation of a Jira issue using the specified issue key or ID in Atlassian Jira On Premise. ### Endpoint - **URL:** `/rest/api/2/issue/{{issueIdOrKey}}` - **Method:** `GET` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | ------------------------------ | -------- | ------------ | -------------------------------------------------------------------------------------- | | `path_parameters.issueIdOrKey` | string | Required | Parameters for the Get Issue action | | `parameters.fields` | string | Optional | the list of fields to return for the issue. By default, all fields are returned. | | `parameters.expand` | string | Optional | Parameters for the Get Issue action | | `parameters.properties` | string | Optional | the list of properties to return for the issue. By default no properties are returned. | | `parameters.updateHistory` | boolean | Optional | Parameters for the Get Issue action | ### Input Example `{"parameters":{"fields":"fields","expand":"expand","properties":"properties","updateHistory":false},"path_parameters":{"issueIdOrKey":"10002"}}` ### 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 | | `fields.watcher` | object | Output field: fields.watcher | | `fields.attachment` | array | Output field: fields.attachment | | `fields.sub-tasks` | array | Output field: fields.sub-tasks | | `fields.description` | string | Output field: fields.description | | `fields.project` | object | Output field: fields.project | | `fields.comment` | array | Output field: fields.comment | | `fields.issuelinks` | array | Output field: fields.issuelinks | | `fields.worklog` | array | Output field: fields.worklog | | `fields.updated` | number | Output field: fields.updated | | `fields.timetracking` | object | Output field: fields.timetracking | | `names` | object | Name of the resource | | `schema` | object | Output field: schema | ### Output 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":{"watcher":{},"attachment":[],"sub-tasks":[],"description":"example bug report","project":{},"comment":[],"issuelinks":[],"worklog":[],"updated":1,"timetracking":{}},"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** | | ------------------------------ | -------- | ------------ | ----------------------------------------------- | | `path_parameters.issueIdOrKey` | string | Required | Parameters for the Get Issue Transitions action | | `parameters.transitionId` | string | Optional | Parameters for the Get Issue Transitions action | | `parameters.expand` | string | Optional | Parameters for the Get Issue Transitions action | ### Input Example `{"parameters":{"transitionId":"145","expand":"transitions.fields"},"path_parameters":{"issueIdOrKey":"ABC-123456"}}` ### 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 | | `transitions.id` | string | Unique identifier | | `transitions.name` | string | Name of the resource | | `transitions.to` | object | Output field: transitions.to | | `transitions.to.self` | string | Output field: transitions.to.self | | `transitions.to.description` | string | Output field: transitions.to.description | | `transitions.to.iconUrl` | string | URL endpoint for the request | | `transitions.to.name` | string | Name of the resource | | `transitions.to.id` | string | Unique identifier | | `transitions.to.statusCategory` | object | Status value | | `transitions.to.statusCategory.self` | string | Status value | | `transitions.to.statusCategory.id` | number | Unique identifier | | `transitions.to.statusCategory.key` | string | Status value | | `transitions.to.statusCategory.colorName` | string | Name of the resource | | `transitions.to.statusCategory.name` | string | Name of the resource | | `transitions.hasScreen` | boolean | Output field: transitions.hasScreen | | `transitions.isGlobal` | boolean | Output field: transitions.isGlobal | | `transitions.isInitial` | boolean | Output field: transitions.isInitial | | `transitions.isAvailable` | boolean | Output field: transitions.isAvailable | | `transitions.isConditional` | boolean | Output field: transitions.isConditional | | `transitions.isLooped` | boolean | Output field: transitions.isLooped | ### Output 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":"nosn...` ## 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 | ### Output 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-B...` ## Issue Transition Perform a transition on a Jira issue using the specified issueIdOrKey and update or set fields as needed. Requires path parameters and JSON body with transition details. ### Endpoint - **URL:** `/rest/api/2/issue/{{issueIdOrKey}}/transitions` - **Method:** `POST` ### Input | **Argument Name** | **Type** | **Required** | **Description** | | --------------------------------- | -------- | ------------ | ------------------------------------------ | | `path_parameters.issueIdOrKey` | string | Required | Parameters for the Issue Transition action | | `transition` | object | Optional | Parameter for Issue Transition | | `transition.id` | string | Optional | Unique identifier | | `transition.name` | string | Optional | Name of the resource | | `transition.to` | object | Optional | Parameter for Issue Transition | | `transition.to.name` | string | Optional | Name of the resource | | `transition.to.id` | string | Optional | Unique identifier | | `transition.to.statusCategory` | object | Optional | Status value | | `transition.to.statusCategory.id` | number | Optional | Unique identifier | | `transition.hasScreen` | boolean | Optional | Parameter for Issue Transition | | `transition.isGlobal` | boolean | Optional | Parameter for Issue Transition | | `transition.isInitial` | boolean | Optional | Parameter for Issue Transition | | `transition.isAvailable` | boolean | Optional | Parameter for Issue Transition | | `transition.isConditional` | boolean | Optional | Parameter for Issue Transition | | `transition.isLooped` | boolean | Optional | Parameter for Issue Transition | | `update` | object | Optional | Date value | | `fields` | object | Optional | Parameter for Issue Transition | ### Input Example `{"json_body":{"transition":{"id":"171","name":"Send to Backlog","to":{"name":"Backlog","id":"10103","statusCategory":{"id":2}},"hasScreen":false,"isGlobal":false,"isInitial":false,"isAvailable":true,"isConditional":false,"isLooped":false},"update":{},"fields":{}},"path_parameters":{"issueIdOrKey":"ABC-123456"}}` ### 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 | ### Output 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":"nosnif...` ## Search Execute 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** | | -------------------------- | -------- | ------------ | -------------------------------- | | `parameters.jql` | string | Optional | Parameters for the Search action | | `parameters.startAt` | number | Optional | Parameters for the Search action | | `parameters.maxResults` | number | Optional | Parameters for the Search action | | `parameters.validateQuery` | boolean | Optional | Parameters for the Search action | | `parameters.fields` | string | Optional | Parameters for the Search action | | `parameters.expand` | string | Optional | Parameters for the Search action | ### Input Example `{"parameters":{"jql":"jql","startAt":0,"maxResults":100,"validateQuery":true,"fields":"fields","expand":"expand"}}` ### 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 | | `properties.expand` | object | Output field: properties.expand | | `properties.startAt` | object | Output field: properties.startAt | | `properties.maxResults` | object | Result of the operation | | `properties.total` | object | Output field: properties.total | | `properties.issues` | object | Output field: properties.issues | | `properties.warningMessages` | object | Response message | | `properties.names` | object | Name of the resource | | `properties.schema` | object | Output field: properties.schema | | `definitions` | object | Output field: definitions | | `definitions.field-meta` | object | Output field: definitions.field-meta | | `definitions.history-metadata-participant` | object | Response data | | `definitions.json-type` | object | Type of the resource | | `definitions.link-group` | object | Output field: definitions.link-group | | `definitions.simple-link` | object | Output field: definitions.simple-link | | `additionalProperties` | boolean | Output field: additionalProperties | ### Output 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":{"expand":{},"startAt":{},"maxResults":{},"total":{},"issues":{},"warningMessages":{},"names":{},"schema":{}},"definitions":{"field-meta":{},"history-metadata-participant":{},"json-type":{},"link-group":{},"simple-link":{}},"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 | 7fc204976a2a492ba6f100b52f62e9f9 | | 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 | text/html;charset=UTF-8 | | Date | The date and time at which the message was originated | Thu, 14 Mar 2024 10:55:21 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=2d037883c1d7293963032df25cc910d647853d18\_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 5b3ba25f8eac620d91408a458d7b2a9e.cloudfront.net (CloudFront) | | X-Aaccountid | HTTP response header: X-Aaccountid | 63b4c0c5082abdd71bb64f24 | | 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 | | X-Frame-Options | HTTP response header: X-Frame-Options | SAMEORIGIN | | X-Xss-Protection | HTTP response header: X-Xss-Protection | 1; mode=block |