Atlassian

JIRA 7.6.1

JIRA 7.6.1 endpoints from Atlassian

Developer tools#openapi#developer-tools

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

JIRA 7.6.1 endpoints from Atlassian

Endpoints 324

  • GETGET /api/2/application-properties/api/2/application-properties?key=string&permissionLevel=string&keyFilter=stringReturns an application property.
  • GETgetAdvancedSettings/api/2/application-properties/advanced-settingsReturns the properties that are displayed on the "General Configuration > Advanced Settings" page.
  • PUTsetPropertyViaRestfulTable/api/2/application-properties/:idModify an application property via PUT. The "value" field present in the PUT will override the existing value.
  • GETgetAll/api/2/applicationroleReturns all ApplicationRoles in the system. Will also return an ETag header containing a version hash of the collection of ApplicationRoles.
  • PUTputBulk/api/2/applicationroleUpdates the ApplicationRoles with the passed data if the version hash is the same as the server. Only the groups and default groups setting of the role may be…
  • GETget/api/2/applicationrole/:keyReturns the ApplicationRole with passed key if it exists.
  • PUTput/api/2/applicationrole/:keyUpdates the ApplicationRole with the passed data. Only the groups and default groups setting of the role may be updated. Requests to change the key or the…
  • GETgetAttachmentMeta/api/2/attachment/metaReturns the meta information for an attachments, specifically if they are enabled and the maximum upload size allowed.
  • GETgetAttachment/api/2/attachment/:idReturns the meta-data for an attachment, including the URI of the actual attached file.
  • DELETEremoveAttachment/api/2/attachment/:idRemove an attachment from an issue.
  • GETexpandForHumans/api/2/attachment/:id/expand/humanTries to expand an attachment. Output is human-readable and subject to change.
  • GETexpandForMachines/api/2/attachment/:id/expand/rawTries to expand an attachment. Output is raw and should be backwards-compatible through the course of time.
  • GETgetRecords/api/2/auditing/record?offset=0&limit=0&filter=string&from=string&to=string&projectIds=string&userIds=stringReturns auditing records filtered using provided parameters
  • POSTaddRecord/api/2/auditing/recordStore a record in Audit Log
  • GETgetAllSystemAvatars/api/2/avatar/:type/systemReturns all system avatars of the given type.
  • POSTstoreTemporaryAvatar/api/2/avatar/:type/temporary?filename=string&size=0Creates temporary avatar
  • POSTPOST /api/2/avatar/{type}/temporaryCrop/api/2/avatar/:type/temporaryCropUpdates the cropping instructions of the temporary avatar.
  • POSTapproveUpgrade/api/2/cluster/zdu/approve
  • POSTcancelUpgrade/api/2/cluster/zdu/cancel
  • POSTacknowledgeErrors/api/2/cluster/zdu/retryUpgrade
  • POSTsetReadyToUpgrade/api/2/cluster/zdu/start
  • GETgetState/api/2/cluster/zdu/state
  • GETGET /api/2/comment/{commentId}/properties/api/2/comment/:commentId/propertiesReturns the keys of all properties for the comment identified by the key or by the id.
  • GETGET /api/2/comment/{commentId}/properties/{propertyKey}/api/2/comment/:commentId/properties/:propertyKeyReturns the value of the property with a given key from the comment identified by the key or by the id. The user who retrieves the property is required to…
  • PUTPUT /api/2/comment/{commentId}/properties/{propertyKey}/api/2/comment/:commentId/properties/:propertyKeySets the value of the specified comment's property. <p> You can use this resource to store a custom data against the comment identified by the key or by the…
  • DELETEDELETE /api/2/comment/{commentId}/properties/{propertyKey}/api/2/comment/:commentId/properties/:propertyKeyRemoves the property from the comment identified by the key or by the id. Ths user removing the property is required to have permissions to administer the…
  • POSTcreateComponent/api/2/componentCreate a component via POST.
  • GETgetComponent/api/2/component/:idReturns a project component.
  • PUTupdateComponent/api/2/component/:idModify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.…
  • DELETEDELETE /api/2/component/{id}/api/2/component/:id?moveIssuesTo=stringDelete a project component.
  • GETgetComponentRelatedIssues/api/2/component/:id/relatedIssueCountsReturns counts of issues related to this component.
  • GETgetConfiguration/api/2/configurationReturns the information if the optional features in JIRA are enabled or disabled. If the time tracking is enabled, it also returns the detailed information…
  • GETgetCustomFieldOption/api/2/customFieldOption/:idReturns a full representation of the Custom Field Option that has the given id.
  • GETlist/api/2/dashboard?filter=string&startAt=0&maxResults=0Returns a list of all dashboards, optionally filtering them.
  • GETGET /api/2/dashboard/{dashboardId}/items/{itemId}/properties/api/2/dashboard/:dashboardId/items/:itemId/propertiesReturns the keys of all properties for the dashboard item identified by the id.
  • GETGET /api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}/api/2/dashboard/:dashboardId/items/:itemId/properties/:propertyKeyReturns the value of the property with a given key from the dashboard item identified by the id. The user who retrieves the property is required to have…
  • PUTPUT /api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}/api/2/dashboard/:dashboardId/items/:itemId/properties/:propertyKeySets the value of the specified dashboard item's property. <p> You can use this resource to store a custom data against the dashboard item identified by the…
  • DELETEDELETE /api/2/dashboard/{dashboardId}/items/{itemId}/properties/{propertyKey}/api/2/dashboard/:dashboardId/items/:itemId/properties/:propertyKeyRemoves the property from the dashboard item identified by the key or by the id. Ths user removing the property is required to have permissions to administer…
  • GETgetDashboard/api/2/dashboard/:idReturns a single dashboard.
  • GETgetFields/api/2/fieldReturns a list of all fields, both System and Custom
  • POSTcreateCustomField/api/2/fieldCreates a custom field using a definition (object encapsulating custom field data)
  • POSTcreateFilter/api/2/filter?expand=stringCreates a new filter, and returns newly created filter. Currently sets permissions just using the users default sharing permissions
  • GETgetDefaultShareScope/api/2/filter/defaultShareScopeReturns the default share scope of the logged-in user.
  • PUTsetDefaultShareScope/api/2/filter/defaultShareScopeSets the default share scope of the logged-in user. Available values are GLOBAL and PRIVATE.
  • GETgetFavouriteFilters/api/2/filter/favourite?expand=string&enableSharedUsers=trueReturns the favourite filters of the logged-in user.
  • GETgetFilter/api/2/filter/:id?expand=string&enableSharedUsers=trueReturns a filter given an id
  • PUTeditFilter/api/2/filter/:id?expand=stringUpdates an existing filter, and returns its new value.
  • DELETEdeleteFilter/api/2/filter/:idDelete a filter.
  • GETGET /api/2/filter/{id}/columns/api/2/filter/:id/columnsReturns the default columns for the given filter. Currently logged in user will be used as the user making such request.
  • PUTPUT /api/2/filter/{id}/columns/api/2/filter/:id/columnsSets the default columns for the given filter.
  • DELETEDELETE /api/2/filter/{id}/columns/api/2/filter/:id/columnsResets the columns for the given filter such that the filter no longer has its own column config.
  • GETgetSharePermissions/api/2/filter/:id/permissionReturns all share permissions of the given filter.
  • POSTaddSharePermission/api/2/filter/:id/permissionAdds a share permissions to the given filter. Adding a global permission removes all previous permissions from the filter.
  • DELETEdeleteSharePermission/api/2/filter/:id/permission/:permission-idRemoves a share permissions from the given filter.
  • GETgetSharePermission/api/2/filter/:id/permission/:permissionIdReturns a single share permission of the given filter.
  • GETgetGroup/api/2/group?groupname=string&expand=stringReturns REST representation for the requested group. Allows to get list of active users belonging to the specified group and its subgroups if "users" expand…
  • POSTcreateGroup/api/2/groupCreates a group by given group parameter <p> Returns REST representation for the requested group.
  • DELETEremoveGroup/api/2/group?groupname=string&swapGroup=stringDeletes a group by given group parameter. <p> Returns no content
  • GETgetUsersFromGroup/api/2/group/member?groupname=string&includeInactiveUsers=false&startAt=0&maxResults=50This resource returns a <a href="#pagination">paginated</a> list of users who are members of the specified group and its subgroups. Users in the page are…
  • POSTaddUserToGroup/api/2/group/user?groupname=stringAdds given user to a group. <p> Returns the current state of the group.
  • DELETEremoveUserFromGroup/api/2/group/user?groupname=string&username=stringRemoves given user from a group. <p> Returns no content
  • GETfindGroups/api/2/groups/picker?query=string&exclude=string&maxResults=0&userName=stringReturns groups with substrings matching a given query. This is mainly for use with the group picker, so the returned groups contain html to be used as picker…
  • GETfindUsersAndGroups/api/2/groupuserpicker?query=string&maxResults=0&showAvatar=true&fieldId=string&projectId=string&issueTypeId=stringReturns a list of users and groups matching query with highlighting. This resource cannot be accessed anonymously.
  • GETgetIndexSummary/api/2/index/summarySummarizes index condition of current node. <p/> Returned data consists of: <ul> <li><code>nodeId</code> - Node identifier.</li> <li><code>reportTime</code> -…
  • POSTcreateIssue/api/2/issueCreates an issue or a sub-task from a JSON representation. <p/> The fields that can be set on create, in either the fields parameter or the update parameter…
  • POSTcreateIssues/api/2/issue/bulkCreates issues or sub-tasks from a JSON representation. <p/> Creates many issues in one bulk operation. <p/> Creating a sub-task is similar to creating a…
  • GETgetCreateIssueMeta/api/2/issue/createmeta?projectIds=string&projectKeys=string&issuetypeIds=string&issuetypeNames=stringReturns the meta data for creating issues. This includes the available projects, issue types and fields, including field types and whether or not those fields…
  • GETgetIssuePickerResource/api/2/issue/picker?query=string&currentJQL=string&currentIssueKey=string&currentProjectId=string&showSubTasks=true&showSubTaskParent=trueReturns suggested issues which match the auto-completion query for the user which executes this request. This REST method will check the user's history and…
  • GETgetIssue/api/2/issue/:issueIdOrKey?fields=string&expand=string&properties=stringReturns a full representation of the issue for the given issue key. <p> An issue JSON consists of the issue key, a collection of fields, a link to the…
  • PUTeditIssue/api/2/issue/:issueIdOrKey?notifyUsers=trueEdits an issue from a JSON representation. <p/> The issue can either be updated by setting explicit the field value(s) or by using an operation to change the…
  • DELETEdeleteIssue/api/2/issue/:issueIdOrKey?deleteSubtasks=stringDelete an issue. <p/> If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue. You cannot delete an issue without its…
  • PUTassign/api/2/issue/:issueIdOrKey/assigneeAssigns an issue to a user. You can use this resource to assign issues when the user submitting the request has the assign permission but not the edit issue…
  • POSTaddAttachment/api/2/issue/:issueIdOrKey/attachmentsAdd one or more attachments to an issue. <p> This resource expects a multipart post. The media-type multipart/form-data is defined in RFC 1867. Most client…
  • GETgetComments/api/2/issue/:issueIdOrKey/comment?startAt=0&maxResults=0&orderBy=string&expand=stringReturns all comments for an issue. <p> Results can be ordered by the "created" field which means the date a comment was added. </p>
  • POSTaddComment/api/2/issue/:issueIdOrKey/comment?expand=stringAdds a new comment to an issue.
  • GETgetComment/api/2/issue/:issueIdOrKey/comment/:id?expand=stringReturns a single comment.
  • PUTupdateComment/api/2/issue/:issueIdOrKey/comment/:id?expand=stringUpdates an existing comment using its JSON representation.
  • DELETEdeleteComment/api/2/issue/:issueIdOrKey/comment/:idDeletes an existing comment .
  • GETgetEditIssueMeta/api/2/issue/:issueIdOrKey/editmetaReturns the meta data for editing an issue. <p/> The fields in the editmeta correspond to the fields in the edit screen for the issue. Fields not in the…
  • POSTnotify/api/2/issue/:issueIdOrKey/notifySends a notification (email) to the list or recipients defined in the request.
  • GETGET /api/2/issue/{issueIdOrKey}/properties/api/2/issue/:issueIdOrKey/propertiesReturns the keys of all properties for the issue identified by the key or by the id.
  • GETGET /api/2/issue/{issueIdOrKey}/properties/{propertyKey}/api/2/issue/:issueIdOrKey/properties/:propertyKeyReturns the value of the property with a given key from the issue identified by the key or by the id. The user who retrieves the property is required to have…
  • PUTPUT /api/2/issue/{issueIdOrKey}/properties/{propertyKey}/api/2/issue/:issueIdOrKey/properties/:propertyKeySets the value of the specified issue's property. <p> You can use this resource to store a custom data against the issue identified by the key or by the id.…
  • DELETEDELETE /api/2/issue/{issueIdOrKey}/properties/{propertyKey}/api/2/issue/:issueIdOrKey/properties/:propertyKeyRemoves the property from the issue identified by the key or by the id. Ths user removing the property is required to have permissions to edit the issue.
  • GETgetRemoteIssueLinks/api/2/issue/:issueIdOrKey/remotelink?globalId=stringA REST sub-resource representing the remote issue links on the issue.
  • POSTcreateOrUpdateRemoteIssueLink/api/2/issue/:issueIdOrKey/remotelinkCreates or updates a remote issue link from a JSON representation. If a globalId is provided and a remote issue link exists with that globalId, the remote…
  • DELETEdeleteRemoteIssueLinkByGlobalId/api/2/issue/:issueIdOrKey/remotelink?globalId=stringDelete the remote issue link with the given global id on the issue.
  • GETgetRemoteIssueLinkById/api/2/issue/:issueIdOrKey/remotelink/:linkIdGet the remote issue link with the given id on the issue.
  • PUTupdateRemoteIssueLink/api/2/issue/:issueIdOrKey/remotelink/:linkIdUpdates a remote issue link from a JSON representation. Any fields not provided are set to null.
  • DELETEdeleteRemoteIssueLinkById/api/2/issue/:issueIdOrKey/remotelink/:linkIdDelete the remote issue link with the given id on the issue.
  • GETgetSubTasks/api/2/issue/:issueIdOrKey/subtaskReturns an issue's subtask list
  • GETcanMoveSubTask/api/2/issue/:issueIdOrKey/subtask/move
  • POSTmoveSubTasks/api/2/issue/:issueIdOrKey/subtask/moveReorders an issue's subtasks by moving the subtask at index "from" to index "to".
  • GETgetTransitions/api/2/issue/:issueIdOrKey/transitions?transitionId=stringGet a list of the transitions possible for this issue by the current user, along with fields that are required and their types. <p/> Fields will only be…
  • POSTdoTransition/api/2/issue/:issueIdOrKey/transitionsPerform a transition on an issue. When performing the transition you can update or set other issue fields. <p/> The fields that can be set on transtion, in…
  • GETgetVotes/api/2/issue/:issueIdOrKey/votesA REST sub-resource representing the voters on the issue.
  • POSTaddVote/api/2/issue/:issueIdOrKey/votesCast your vote in favour of an issue.
  • DELETEremoveVote/api/2/issue/:issueIdOrKey/votesRemove your vote from an issue. (i.e. "unvote")
  • GETgetIssueWatchers/api/2/issue/:issueIdOrKey/watchersReturns the list of watchers for the issue with the given key.
  • POSTaddWatcher/api/2/issue/:issueIdOrKey/watchersAdds a user to an issue's watcher list.
  • DELETEremoveWatcher/api/2/issue/:issueIdOrKey/watchers?username=stringRemoves a user from an issue's watcher list.
  • GETgetIssueWorklog/api/2/issue/:issueIdOrKey/worklogReturns all work logs for an issue. <br/> <strong>Note:</strong> Work logs won't be returned if the Log work field is hidden for the project.
  • POSTaddWorklog/api/2/issue/:issueIdOrKey/worklog?adjustEstimate=string&newEstimate=string&reduceBy=stringAdds a new worklog entry to an issue.
  • GETgetWorklog/api/2/issue/:issueIdOrKey/worklog/:idReturns a specific worklog. <br/> <strong>Note:</strong> The work log won't be returned if the Log work field is hidden for the project.
  • PUTupdateWorklog/api/2/issue/:issueIdOrKey/worklog/:id?adjustEstimate=string&newEstimate=stringUpdates an existing worklog entry. <p>Note that:</p> <ul> <li>Fields possible for editing are: comment, visibility, started, timeSpent and…
  • DELETEdeleteWorklog/api/2/issue/:issueIdOrKey/worklog/:id?adjustEstimate=string&newEstimate=string&increaseBy=stringDeletes an existing worklog entry.
  • POSTlinkIssues/api/2/issueLinkCreates an issue link between two issues. The user requires the link issue permission for the issue which will be linked to another issue. The specified link…
  • GETgetIssueLink/api/2/issueLink/:linkIdReturns an issue link with the specified id.
  • DELETEdeleteIssueLink/api/2/issueLink/:linkIdDeletes an issue link with the specified id. To be able to delete an issue link you must be able to view both issues and must have the link issue permission…
  • GETgetIssueLinkTypes/api/2/issueLinkTypeReturns a list of available issue link types, if issue linking is enabled. Each issue link type has an id, a name and a label for the outward and inward link…
  • POSTcreateIssueLinkType/api/2/issueLinkTypeCreate a new issue link type.
  • GETgetIssueLinkType/api/2/issueLinkType/:issueLinkTypeIdReturns for a given issue link type id all information about this issue link type.
  • PUTupdateIssueLinkType/api/2/issueLinkType/:issueLinkTypeIdUpdate the specified issue link type.
  • DELETEdeleteIssueLinkType/api/2/issueLinkType/:issueLinkTypeIdDelete the specified issue link type.
  • GETgetIssueSecuritySchemes/api/2/issuesecurityschemesReturns all issue security schemes that are defined.
  • GETGET /api/2/issuesecurityschemes/{id}/api/2/issuesecurityschemes/:idReturns the issue security scheme along with that are defined.
  • GETgetIssueAllTypes/api/2/issuetypeReturns a list of all issue types visible to the user
  • POSTcreateIssueType/api/2/issuetypeCreates an issue type from a JSON representation and adds the issue newly created issue type to the default issue type scheme.
  • GETGET /api/2/issuetype/{id}/api/2/issuetype/:idReturns a full representation of the issue type that has the given id.
  • PUTupdateIssueType/api/2/issuetype/:idUpdates the specified issue type from a JSON representation.
  • DELETEDELETE /api/2/issuetype/{id}/api/2/issuetype/:id?alternativeIssueTypeId=stringDeletes the specified issue type. If the issue type has any associated issues, these issues will be migrated to the alternative issue type specified in the…
  • GETgetAlternativeIssueTypes/api/2/issuetype/:id/alternativesReturns a list of all alternative issue types for the given issue type id. The list will contain these issues types, to which issues assigned to the given…
  • POSTPOST /api/2/issuetype/{id}/avatar/api/2/issuetype/:id/avatarConverts temporary avatar into a real avatar
  • POSTPOST /api/2/issuetype/{id}/avatar/temporary/api/2/issuetype/:id/avatar/temporaryCreates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit…
  • GETgetPropertyKeys/api/2/issuetype/:issueTypeId/propertiesReturns the keys of all properties for the issue type identified by the id.
  • GETGET /api/2/issuetype/{issueTypeId}/properties/{propertyKey}/api/2/issuetype/:issueTypeId/properties/:propertyKeyReturns the value of the property with a given key from the issue type identified by the id. The user who retrieves the property is required to have…
  • PUTPUT /api/2/issuetype/{issueTypeId}/properties/{propertyKey}/api/2/issuetype/:issueTypeId/properties/:propertyKeySets the value of the specified issue type's property. <p> You can use this resource to store a custom data against an issue type identified by the id. The…
  • DELETEDELETE /api/2/issuetype/{issueTypeId}/properties/{propertyKey}/api/2/issuetype/:issueTypeId/properties/:propertyKeyRemoves the property from the issue type identified by the id. Ths user removing the property is required to have permissions to edit the issue type.
  • GETgetAutoComplete/api/2/jql/autocompletedataReturns the auto complete data required for JQL searches.
  • GETgetFieldAutoCompleteForQueryString/api/2/jql/autocompletedata/suggestions?fieldName=string&fieldValue=string&predicateName=string&predicateValue=stringReturns auto complete suggestions for JQL search.
  • POSTvalidate/api/2/licenseValidator
  • GETareMetricsExposed/api/2/monitoring/jmx/areMetricsExposed
  • GETgetAvailableMetrics/api/2/monitoring/jmx/getAvailableMetrics
  • GETstart/api/2/monitoring/jmx/startExposing
  • GETstop/api/2/monitoring/jmx/stopExposing
  • GETgetPermissions/api/2/mypermissions?projectKey=string&projectId=string&issueKey=string&issueId=stringReturns all permissions in the system and whether the currently logged in user has them. You can optionally provide a specific context to get permissions for…
  • GETgetPreference/api/2/mypreferences?key=stringReturns preference of the currently logged in user. Preference key must be provided as input parameter (key). The value is returned exactly as it is. If key…
  • PUTsetPreference/api/2/mypreferences?key=stringSets preference of the currently logged in user. Preference key must be provided as input parameters (key). Value must be provided as post body. If key or…
  • DELETEremovePreference/api/2/mypreferences?key=stringRemoves preference of the currently logged in user. Preference key must be provided as input parameters (key). If key parameter is not provided or wrong -…
  • GETGET /api/2/myself/api/2/myselfReturns currently logged user. This resource cannot be accessed anonymously.
  • PUTPUT /api/2/myself/api/2/myselfModify currently logged user. The "value" fields present will override the existing value. Fields skipped in request will not be changed. Only email and…
  • PUTchangeMyPassword/api/2/myself/passwordModify caller password.
  • GETgetNotificationSchemes/api/2/notificationscheme?startAt=0&maxResults=0&expand=stringReturns a <a href="#pagination">paginated</a> list of notification schemes. In order to access notification scheme, the calling user is required to have…
  • GETGET /api/2/notificationscheme/{id}/api/2/notificationscheme/:id?expand=stringReturns a full representation of the notification scheme for the given id. This resource will return a notification scheme containing a list of events and…
  • GETgetPasswordPolicy/api/2/password/policy?hasOldPassword=falseReturns the list of requirements for the current password policy. For example, "The password must have at least 10 characters.", "The password must not be…
  • POSTpolicyCheckCreateUser/api/2/password/policy/createUserReturns a list of statements explaining why the password policy would disallow a proposed password for a new user. <p> You can use this method to test the…
  • POSTpolicyCheckUpdateUser/api/2/password/policy/updateUserReturns a list of statements explaining why the password policy would disallow a proposed new password for a user with an existing password. <p> You can use…
  • GETgetAllPermissions/api/2/permissionsReturns all permissions that are present in the JIRA instance - Global, Project and the global ones added by plugins
  • GETgetPermissionSchemes/api/2/permissionscheme?expand=stringReturns a list of all permission schemes. <p> By default only shortened beans are returned. If you want to include permissions of all the schemes, then…
  • POSTcreatePermissionScheme/api/2/permissionscheme?expand=stringCreate a new permission scheme. This method can create schemes with a defined permission set, or without.
  • GETgetSchemeAttribute/api/2/permissionscheme/:permissionSchemeId/attribute/:attributeKey
  • PUTsetSchemeAttribute/api/2/permissionscheme/:permissionSchemeId/attribute/:keyUpdates or inserts the attribute for a permission scheme specified by permission scheme id. The attribute consists of the key and the value. The value will be…
  • GETgetPermissionScheme/api/2/permissionscheme/:schemeId?expand=stringReturns a permission scheme identified by the given id.
  • PUTupdatePermissionScheme/api/2/permissionscheme/:schemeId?expand=stringUpdates a permission scheme. <p> If the permissions list is present then it will be set in the permission scheme, which basically means it will overwrite any…
  • DELETEdeletePermissionScheme/api/2/permissionscheme/:schemeIdDeletes a permission scheme identified by the given id.
  • GETgetPermissionSchemeGrants/api/2/permissionscheme/:schemeId/permission?expand=stringReturns all permission grants of the given permission scheme.
  • POSTcreatePermissionGrant/api/2/permissionscheme/:schemeId/permission?expand=stringCreates a permission grant in a permission scheme.
  • GETgetPermissionSchemeGrant/api/2/permissionscheme/:schemeId/permission/:permissionId?expand=stringReturns a permission grant identified by the given id.
  • DELETEdeletePermissionSchemeEntity/api/2/permissionscheme/:schemeId/permission/:permissionIdDeletes a permission grant from a permission scheme.
  • GETgetPriorities/api/2/priorityReturns a list of all issue priorities.
  • GETgetPriority/api/2/priority/:idReturns an issue priority.
  • GETgetAllProjects/api/2/project?expand=string&recent=0Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using…
  • POSTcreateProject/api/2/projectCreates a new project.
  • GETgetAllProjectTypes/api/2/project/typeReturns all the project types defined on the JIRA instance, not taking into account whether the license to use those project types is valid or not.
  • GETgetProjectTypeByKey/api/2/project/type/:projectTypeKeyReturns the project type with the given key.
  • GETgetAccessibleProjectTypeByKey/api/2/project/type/:projectTypeKey/accessibleReturns the project type with the given key, if it is accessible to the logged in user. This takes into account whether the user is licensed on the…
  • GETGET /api/2/project/{projectIdOrKey}/api/2/project/:projectIdOrKey?expand=stringContains a full representation of a project in JSON format. <p> All project keys associated with the project will only be returned if…
  • PUTupdateProject/api/2/project/:projectIdOrKey?expand=stringUpdates a project. <p> Only non null values sent in JSON will be updated in the project.</p> <p> Values available for the assigneeType field are:…
  • DELETEdeleteProject/api/2/project/:projectIdOrKeyDeletes a project.
  • PUTPUT /api/2/project/{projectIdOrKey}/avatar/api/2/project/:projectIdOrKey/avatar
  • POSTPOST /api/2/project/{projectIdOrKey}/avatar/api/2/project/:projectIdOrKey/avatarConverts temporary avatar into a real avatar
  • POSTPOST /api/2/project/{projectIdOrKey}/avatar/temporary/api/2/project/:projectIdOrKey/avatar/temporaryCreates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit…
  • DELETEDELETE /api/2/project/{projectIdOrKey}/avatar/{id}/api/2/project/:projectIdOrKey/avatar/:idDeletes avatar
  • GETGET /api/2/project/{projectIdOrKey}/avatars/api/2/project/:projectIdOrKey/avatarsReturns all avatars which are visible for the currently logged in user. The avatars are grouped into system and custom.
  • GETgetProjectComponents/api/2/project/:projectIdOrKey/componentsContains a full representation of a the specified project's components.
  • GETGET /api/2/project/{projectIdOrKey}/properties/api/2/project/:projectIdOrKey/propertiesReturns the keys of all properties for the project identified by the key or by the id.
  • GETGET /api/2/project/{projectIdOrKey}/properties/{propertyKey}/api/2/project/:projectIdOrKey/properties/:propertyKeyReturns the value of the property with a given key from the project identified by the key or by the id. The user who retrieves the property is required to…
  • PUTPUT /api/2/project/{projectIdOrKey}/properties/{propertyKey}/api/2/project/:projectIdOrKey/properties/:propertyKeySets the value of the specified project's property. <p> You can use this resource to store a custom data against the project identified by the key or by the…
  • DELETEDELETE /api/2/project/{projectIdOrKey}/properties/{propertyKey}/api/2/project/:projectIdOrKey/properties/:propertyKeyRemoves the property from the project identified by the key or by the id. Ths user removing the property is required to have permissions to administer the…
  • GETGET /api/2/project/{projectIdOrKey}/role/api/2/project/:projectIdOrKey/roleReturns all roles in the given project Id or key, with links to full details on each role.
  • GETgetProjectRole/api/2/project/:projectIdOrKey/role/:idReturns the details for a given project role in a project.
  • PUTsetActors/api/2/project/:projectIdOrKey/role/:idUpdates a project role to include the specified actors (users or groups).
  • POSTaddActorUsers/api/2/project/:projectIdOrKey/role/:idAdds an actor (user or group) to a project role.
  • DELETEdeleteActor/api/2/project/:projectIdOrKey/role/:id?user=string&group=stringDeletes actors (users or groups) from a project role. <p> <ul> <li>Delete a user from the role:…
  • GETgetAllStatuses/api/2/project/:projectIdOrKey/statusesGet all issue types with valid status values for a project
  • PUTupdateProjectType/api/2/project/:projectIdOrKey/type/:newProjectTypeKeyUpdates the type of a project.
  • GETgetProjectVersionsPaginated/api/2/project/:projectIdOrKey/version?startAt=0&maxResults=0&orderBy=string&expand=stringReturns all versions for the specified project. Results are <a href="#pagination">paginated</a>. <p> Results can be ordered by the following fields: <ul>…
  • GETgetProjectVersions/api/2/project/:projectIdOrKey/versions?expand=stringContains a full representation of a the specified project's versions.
  • GETGET /api/2/project/{projectKeyOrId}/issuesecuritylevelscheme/api/2/project/:projectKeyOrId/issuesecuritylevelschemeReturns the issue security scheme for project.
  • GETGET /api/2/project/{projectKeyOrId}/notificationscheme/api/2/project/:projectKeyOrId/notificationscheme?expand=stringGets a notification scheme associated with the project. Follow the documentation of /notificationscheme/{id} resource for all details about returned value.
  • GETgetAssignedPermissionScheme/api/2/project/:projectKeyOrId/permissionscheme?expand=stringGets a permission scheme assigned with a project.
  • PUTassignPermissionScheme/api/2/project/:projectKeyOrId/permissionscheme?expand=stringAssigns a permission scheme with a project.
  • GETgetSecurityLevelsForProject/api/2/project/:projectKeyOrId/securitylevelReturns all security levels for the project that the current logged in user has access to. If the user does not have the Set Issue Security permission, the…
  • GETgetAllProjectCategories/api/2/projectCategoryReturns all project categories
  • POSTcreateProjectCategory/api/2/projectCategoryCreate a project category via POST.
  • GETgetProjectCategoryById/api/2/projectCategory/:idContains a representation of a project category in JSON format.
  • PUTupdateProjectCategory/api/2/projectCategory/:idModify a project category via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently…
  • DELETEremoveProjectCategory/api/2/projectCategory/:idDelete a project category.
  • GETGET /api/2/projectvalidate/key/api/2/projectvalidate/key?key=stringValidates a project key.
  • GETgetReindexInfo/api/2/reindex?taskId=0Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active…
  • POSTreindex/api/2/reindex?type=string&indexComments=false&indexChangeHistory=false&indexWorklogs=falseKicks off a reindex. Need Admin permissions to perform this reindex.
  • POSTreindexIssues/api/2/reindex/issue?issueId=string&indexComments=false&indexChangeHistory=false&indexWorklogs=falseReindexes one or more individual issues. Indexing is performed synchronously - the call returns when indexing of the issues has completed or a failure occurs.…
  • GETgetReindexProgress/api/2/reindex/progress?taskId=0Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active…
  • POSTprocessRequests/api/2/reindex/requestExecutes any pending reindex requests. Returns a JSON array containing the IDs of the reindex requests that are being processed. Execution is asynchronous -…
  • GETgetProgressBulk/api/2/reindex/request/bulk?requestId=stringRetrieves the progress of a multiple reindex requests. Only reindex requests that actually exist will be returned in the results.
  • GETgetProgress/api/2/reindex/request/:requestIdRetrieves the progress of a single reindex request.
  • GETgetResolutions/api/2/resolutionReturns a list of all resolutions.
  • GETgetResolution/api/2/resolution/:idReturns a resolution.
  • GETGET /api/2/role/api/2/roleGet all the ProjectRoles available in JIRA. Currently this list is global.
  • POSTcreateProjectRole/api/2/roleCreates a new ProjectRole to be available in JIRA. The created role does not have any default actors assigned.
  • GETgetProjectRolesById/api/2/role/:idGet a specific ProjectRole available in JIRA.
  • PUTfullyUpdateProjectRole/api/2/role/:idFully updates a roles. Both name and description must be given.
  • POSTpartialUpdateProjectRole/api/2/role/:idPartially updates a roles name or description.
  • DELETEdeleteProjectRole/api/2/role/:id?swap=0Deletes a role. May return 403 in the future
  • GETgetProjectRoleActorsForRole/api/2/role/:id/actorsGets default actors for the given role.
  • POSTaddProjectRoleActorsToRole/api/2/role/:id/actorsAdds default actors to the given role. The request data should contain a list of usernames or a list of groups to add.
  • DELETEdeleteProjectRoleActorsFromRole/api/2/role/:id/actors?user=string&group=stringRemoves default actor from the given role.
  • POSTaddFieldToDefaultScreen/api/2/screens/addToDefault/:fieldIdAdds field or custom field to the default tab
  • GETgetFieldsToAdd/api/2/screens/:screenId/availableFieldsGets available fields for screen. i.e ones that haven't already been added.
  • GETgetAllTabs/api/2/screens/:screenId/tabs?projectKey=stringReturns a list of all tabs for the given screen
  • POSTaddTab/api/2/screens/:screenId/tabsCreates tab for given screen
  • PUTrenameTab/api/2/screens/:screenId/tabs/:tabIdRenames tab on given screen
  • DELETEdeleteTab/api/2/screens/:screenId/tabs/:tabIdDeletes tab to give screen
  • GETgetAllFields/api/2/screens/:screenId/tabs/:tabId/fields?projectKey=stringGets all fields for a given tab
  • POSTaddField/api/2/screens/:screenId/tabs/:tabId/fieldsAdds field to the given tab.
  • DELETEremoveField/api/2/screens/:screenId/tabs/:tabId/fields/:idRemoves field from given tab
  • POSTmoveField/api/2/screens/:screenId/tabs/:tabId/fields/:id/moveMoves field on the given tab
  • POSTmoveTab/api/2/screens/:screenId/tabs/:tabId/move/:posMoves tab position
  • GETsearch/api/2/search?jql=string&startAt=0&maxResults=0&validateQuery=true&fields=string&expand=stringSearches for issues using JQL. <p> <b>Sorting</b> the <code>jql</code> parameter is a full <a…
  • POSTsearchUsingSearchRequest/api/2/searchPerforms a search using JQL.
  • GETgetIssuesecuritylevel/api/2/securitylevel/:idReturns a full representation of the security level that has the given id.
  • GETgetServerInfo/api/2/serverInfo?doHealthCheck=trueReturns general information about the current JIRA server.
  • PUTsetBaseURL/api/2/settings/baseUrlSets the base URL that is configured for this JIRA instance.
  • GETgetIssueNavigatorDefaultColumns/api/2/settings/columnsReturns the default system columns for issue navigator. Admin permission will be required.
  • PUTsetIssueNavigatorDefaultColumns/api/2/settings/columnsSets the default system columns for issue navigator. Admin permission will be required.
  • GETgetStatuses/api/2/statusReturns a list of all statuses
  • GETgetStatus/api/2/status/:idOrNameReturns a full representation of the Status having the given id or name.
  • GETgetStatusCategories/api/2/statuscategoryReturns a list of all status categories
  • GETgetStatusCategory/api/2/statuscategory/:idOrKeyReturns a full representation of the StatusCategory having the given id or key
  • GETgetAvatars/api/2/universal_avatar/type/:type/owner/:owningObjectId
  • POSTPOST /api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/api/2/universal_avatar/type/:type/owner/:owningObjectId/avatar
  • DELETEDELETE /api/2/universal_avatar/type/{type}/owner/{owningObjectId}/avatar/{id}/api/2/universal_avatar/type/:type/owner/:owningObjectId/avatar/:idDeletes avatar
  • POSTPOST /api/2/universal_avatar/type/{type}/owner/{owningObjectId}/temp/api/2/universal_avatar/type/:type/owner/:owningObjectId/temp
  • GETgetUpgradeResult/api/2/upgradeReturns the result of the last upgrade task. Returns {@link javax.ws.rs.core.Response#seeOther(java.net.URI)} if still running.
  • POSTrunUpgradesNow/api/2/upgradeRuns any pending delayed upgrade tasks. Need Admin permissions to do this.
  • GETGET /api/2/user/api/2/user?username=string&key=stringReturns a user. This resource cannot be accessed anonymously.
  • PUTPUT /api/2/user/api/2/user?username=string&key=stringModify user. The "value" fields present will override the existing value. Fields skipped in request will not be changed.
  • POSTcreateUser/api/2/userCreate user. By default created user will not be notified with email. If password field is not set then password will be randomly generated.
  • DELETEremoveUser/api/2/user?username=string&key=stringRemoves user.
  • POSTaddUserToApplication/api/2/user/application?username=string&applicationKey=stringAdd user to given application. Admin permission will be required to perform this operation.
  • DELETEremoveUserFromApplication/api/2/user/application?username=string&applicationKey=stringRemove user from given application. Admin permission will be required to perform this operation.
  • GETfindBulkAssignableUsers/api/2/user/assignable/multiProjectSearch?username=string&projectKeys=string&startAt=0&maxResults=0Returns a list of users that match the search string and can be assigned issues for all the given projects. This resource cannot be accessed anonymously.
  • GETfindAssignableUsers/api/2/user/assignable/search?username=string&project=string&issueKey=string&startAt=0&maxResults=0&actionDescriptorId=0Returns a list of users that match the search string. This resource cannot be accessed anonymously. Please note that this resource should be called with an…
  • PUTPUT /api/2/user/avatar/api/2/user/avatar?username=string
  • POSTPOST /api/2/user/avatar/api/2/user/avatar?username=stringConverts temporary avatar into a real avatar
  • POSTPOST /api/2/user/avatar/temporary/api/2/user/avatar/temporary?username=stringCreates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit…
  • DELETEDELETE /api/2/user/avatar/{id}/api/2/user/avatar/:id?username=stringDeletes avatar
  • GETGET /api/2/user/avatars/api/2/user/avatars?username=stringReturns all avatars which are visible for the currently logged in user.
  • GETGET /api/2/user/columns/api/2/user/columns?username=stringReturns the default columns for the given user. Admin permission will be required to get columns for a user other than the currently logged in user.
  • PUTPUT /api/2/user/columns/api/2/user/columnsSets the default columns for the given user. Admin permission will be required to get columns for a user other than the currently logged in user.
  • DELETEDELETE /api/2/user/columns/api/2/user/columns?username=stringReset the default columns for the given user to the system default. Admin permission will be required to get columns for a user other than the currently…
  • PUTchangeUserPassword/api/2/user/password?username=string&key=stringModify user password.
  • GETfindUsersWithAllPermissions/api/2/user/permission/search?username=string&permissions=string&issueKey=string&projectKey=string&startAt=0&maxResults=0Returns a list of active users that match the search string and have all specified permissions for the project or issue.<br> This resource can be accessed by…
  • GETfindUsersForPicker/api/2/user/picker?query=string&maxResults=0&showAvatar=true&exclude=stringReturns a list of users matching query with highlighting. This resource cannot be accessed anonymously.
  • GETGET /api/2/user/properties//api/2/user/properties/?userKey=string&username=stringReturns the keys of all properties for the user identified by the key or by the id.
  • GETGET /api/2/user/properties/{propertyKey}/api/2/user/properties/:propertyKey?userKey=string&username=stringReturns the value of the property with a given key from the user identified by the key or by the id. The user who retrieves the property is required to have…
  • PUTPUT /api/2/user/properties/{propertyKey}/api/2/user/properties/:propertyKey?userKey=string&username=stringSets the value of the specified user's property. <p> You can use this resource to store a custom data against the user identified by the key or by the id. The…
  • DELETEDELETE /api/2/user/properties/{propertyKey}/api/2/user/properties/:propertyKey?userKey=string&username=stringRemoves the property from the user identified by the key or by the id. Ths user removing the property is required to have permissions to administer the user.
  • GETfindUsers/api/2/user/search?username=string&startAt=0&maxResults=0&includeActive=true&includeInactive=trueReturns a list of users that match the search string. This resource cannot be accessed anonymously.
  • GETfindUsersWithBrowsePermission/api/2/user/viewissue/search?username=string&issueKey=string&projectKey=string&startAt=0&maxResults=0Returns a list of active users that match the search string. This resource cannot be accessed anonymously and requires the Browse Users global permission.…
  • POSTcreateVersion/api/2/versionCreate a version via POST.
  • GETgetRemoteVersionLinks/api/2/version/remotelink?globalId=stringReturns the remote version links for a given global ID.
  • GETgetVersion/api/2/version/:id?expand=stringReturns a project version.
  • PUTupdateVersion/api/2/version/:idModify a version via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.
  • DELETEDELETE /api/2/version/{id}/api/2/version/:id?moveFixIssuesTo=string&moveAffectedIssuesTo=stringDelete a project version.
  • PUTmerge/api/2/version/:id/mergeto/:moveIssuesToMerge versions
  • POSTmoveVersion/api/2/version/:id/moveModify a version's sequence within a project. <p/> The move version bean has 2 alternative field value pairs: <dl> <dt>position</dt><dd>An absolute position,…
  • GETgetVersionRelatedIssues/api/2/version/:id/relatedIssueCountsReturns a bean containing the number of fixed in and affected issues for the given version.
  • POSTPOST /api/2/version/{id}/removeAndSwap/api/2/version/:id/removeAndSwapDelete a project version.
  • GETgetVersionUnresolvedIssues/api/2/version/:id/unresolvedIssueCountReturns the number of unresolved issues for the given version
  • GETgetRemoteVersionLinksByVersionId/api/2/version/:versionId/remotelinkReturns the remote version links associated with the given version ID.
  • POSTPOST /api/2/version/{versionId}/remotelink/api/2/version/:versionId/remotelinkCreate a remote version link via POST. The link's global ID will be taken from the JSON payload if provided; otherwise, it will be generated.
  • DELETEdeleteRemoteVersionLinksByVersionId/api/2/version/:versionId/remotelinkDelete all remote version links for a given version ID.
  • GETgetRemoteVersionLink/api/2/version/:versionId/remotelink/:globalIdA REST sub-resource representing a remote version link
  • POSTPOST /api/2/version/{versionId}/remotelink/{globalId}/api/2/version/:versionId/remotelink/:globalIdCreate a remote version link via POST. The link's global ID will be taken from the JSON payload if provided; otherwise, it will be generated.
  • DELETEdeleteRemoteVersionLink/api/2/version/:versionId/remotelink/:globalIdDelete a specific remote version link with the given version ID and global ID.
  • GETgetAllWorkflows/api/2/workflow?workflowName=stringReturns all workflows.
  • GETgetProperties/api/2/workflow/api/2/transitions/:id/properties?includeReservedKeys=true&key=string&workflowName=string&workflowMode=stringReturn the property or properties associated with a transition.
  • PUTupdateProperty/api/2/workflow/api/2/transitions/:id/properties?key=string&workflowName=string&workflowMode=stringUpdate/add new property to a transition. Trying to update a property that does not exist will result in a new property being added.
  • POSTcreateProperty/api/2/workflow/api/2/transitions/:id/properties?key=string&workflowName=string&workflowMode=stringAdd a new property to a transition. Trying to add a property that already exists will fail.
  • DELETEDELETE /api/2/workflow/api/2/transitions/{id}/properties/api/2/workflow/api/2/transitions/:id/properties?key=string&workflowName=string&workflowMode=stringDelete a property from the passed transition on the passed workflow. It is not an error to delete a property that does not exist.
  • POSTcreateScheme/api/2/workflowschemeCreate a new workflow scheme. <p/> The body contains a representation of the new scheme. Values not passed are assumed to be set to their defaults.
  • GETgetById/api/2/workflowscheme/:id?returnDraftIfExists=falseReturns the requested workflow scheme to the caller.
  • PUTupdate/api/2/workflowscheme/:idUpdate the passed workflow scheme. <p/> The body of the request is a representation of the workflow scheme. Values not passed are assumed to indicate no…
  • DELETEdeleteScheme/api/2/workflowscheme/:idDelete the passed workflow scheme.
  • POSTcreateDraftForParent/api/2/workflowscheme/:id/createdraftCreate a draft for the passed scheme. The draft will be a copy of the state of the parent.
  • GETgetDefault/api/2/workflowscheme/:id/default?returnDraftIfExists=falseReturn the default workflow from the passed workflow scheme.
  • PUTupdateDefault/api/2/workflowscheme/:id/defaultSet the default workflow for the passed workflow scheme. <p/> The passed representation can have its updateDraftIfNeeded flag set to true to indicate that the…
  • DELETEdeleteDefault/api/2/workflowscheme/:id/default?updateDraftIfNeeded=trueRemove the default workflow from the passed workflow scheme.
  • GETgetDraftById/api/2/workflowscheme/:id/draftReturns the requested draft workflow scheme to the caller.

Showing 300 of 324 endpoints. Fork the collection to see all of them.

API details

Base URL
http://jira.local:8080/jira/rest
Authentication
None declared in the description
Operations
324 operations on 205 pathsGET 153POST 68DELETE 53PUT 50
Description format
Swagger 2.0, API version 1.0.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the JIRA 7.6.1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the JIRA 7.6.1 collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “GET /api/2/application-properties” (GET /api/2/application-properties?key=string&permissionLevel=string&keyFilter=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the JIRA 7.6.1?

JIRA 7.6.1 endpoints from Atlassian It is listed under Developer tools and has 324 endpoints.

Who publishes the JIRA 7.6.1?

It is listed from Atlassian's public API description (an OpenAPI document), not published by Atlassian on Swastik Codes. Anyone who controls atlassian.com can claim the profile by adding a DNS TXT record.

What is the base URL of the JIRA 7.6.1?

Requests go to http://jira.local:8080/jira/rest. Endpoint paths are added to this base URL.

How do I authenticate with the JIRA 7.6.1?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the JIRA 7.6.1 have?

324 operations on 205 paths (153 GET, 68 POST, 53 DELETE, 50 PUT).

Is forking the JIRA 7.6.1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.