Crucible
Crucible 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
Crucible endpoints from Atlassian
Endpoints 79
- GETlogin
/rest-service/auth-v1/login?userName=string&password=stringGet the user authentication token. This is a legacy version of the login request. Using GET is deprecated as your password is likely to appear in logs which… - POSTloginPost
/rest-service/auth-v1/loginGet the user authentication token. - GETgetAllProjects
/rest-service/projects-v1?excludeAllowedReviewers=falseGet the list of projects that the authenticated user is entitled to access. - GETgetProject
/rest-service/projects-v1/:key?excludeAllowedReviewers=falseReturns a project description. - GETgetAllRepositories
/rest-service/repositories-v1?name=string&enabled=true&available=true&type=string&limit=10000Returns a list of all repositories. This includes plugin provided repositories - GETbrowse
/rest-service/repositories-v1/browse/:repository/:pathLists the contents of the specified directory. - GETchange
/rest-service/repositories-v1/change/:repository/:revisionRepresents a particular changeset. - GETchanges
/rest-service/repositories-v1/changes/:repository/:path?oldestCsid=string&includeOldest=true&newestCsid=string&includeNewest=true&max=0Represents a sorted list of changesets, newest first. - GETgetContents
/rest-service/repositories-v1/content/:repository/:revision/:pathReturns the raw content of the specified file revision as a binary stream. No attempt is made to identify the content type and no mime type is provided. - GEThistory
/rest-service/repositories-v1/history/:repository/:revision/:pathRepresents the history of a versioned entity. - GETgetRepositoryDetails
/rest-service/repositories-v1/:repository - GETgetSvnRepositoryDetails
/rest-service/repositories-v1/:repository/svnFor backward compatibility we provide this method, but repositories should be referred to just by their key. - GETdetails
/rest-service/repositories-v1/:repository/:revision/:path - GETgetAllReviews
/rest-service/reviews-v1?state=string - POSTcreateReview
/rest-service/reviews-v1 - GETgetAllDetailedReviews
/rest-service/reviews-v1/details?state=stringRetrieves all reviews that are in one of the the specified states. For each review all details are included (review items + comments). The wiki rendered… - GETgetCustomFilterReviews
/rest-service/reviews-v1/filter?title=string&author=string&moderator=string&creator=string&states=string&reviewer=string&orRoles=true&complete=true&allReviewersComplete=true&project=string&fromDate=0&toDate=0To ignore a property, omit it from the query string. - POSTpostCustomFilterReviews
/rest-service/reviews-v1/filterThis method should no longer be used, as it uses a POST for a read-only retrieval operation and is provided for backward compatibility only. - GETgetDetailedCustomFilterReviews
/rest-service/reviews-v1/filter/details?title=string&author=string&moderator=string&creator=string&states=string&reviewer=string&orRoles=true&complete=true&allReviewersComplete=true&project=string&fromDate=0&toDate=0To ignore a property, omit it from the query string. - POSTpostDetailedCustomFilterReviews
/rest-service/reviews-v1/filter/detailsThis method should no longer be used, as it uses a POST for a read-only retrieval operation and is provided for backward compatibility only. - GETgetFilteredReviewsForUser
/rest-service/reviews-v1/filter/:filterGet all the reviews which match the given filter, for the current user. - GETgetDetailedFilteredReviewsForUser
/rest-service/reviews-v1/filter/:filter/detailsGets a list of all the reviews that match the specified filter criteria. - GETgetMetrics
/rest-service/reviews-v1/metrics/:versionGet comment metrics metadata for the specified metrics version. - GETgetReviewsForPath
/rest-service/reviews-v1/search/:repository?path=stringReturn a list of Reviews which include a particular file. - GETgetReviewsDetailsForPath
/rest-service/reviews-v1/search/:repository/details?path=stringReturn a list of Reviews which include a particular file. - GETgetVersionInfo
/rest-service/reviews-v1/versionInfoReturns Crucible version information. - GETgetReview
/rest-service/reviews-v1/:idGet a single review by its permId (e.g. "CR-45"). If the review does not exist, a 404 is returned. The moderator element may not exist if the review does not… - DELETEdeleteReview
/rest-service/reviews-v1/:idPermanently deletes the specified review. The review must have been abandoned. - GETgetAvailableActions
/rest-service/reviews-v1/:id/actionsGet a list of the actions which the current user is allowed to perform on the review. - POSTaddChangesetToReview
/rest-service/reviews-v1/:id/addChangeset - POSTaddFile
/rest-service/reviews-v1/:id/addFile - POSTaddPatchReview0
/rest-service/reviews-v1/:id/addPatchOld, non-restful name. Kept for backwards compatibility. Exactly the same as POSTing to /{id}/patch - POSTcloseReviewWithComment
/rest-service/reviews-v1/:id/closeCloses the given review with the summary given. - GETgetAllComments
/rest-service/reviews-v1/:id/comments?render=falseReturn all the comments visible to the requesting user for the review. - POSTaddGeneralComment
/rest-service/reviews-v1/:id/commentsAdd a general comment to the review. - GETgetGeneralComments
/rest-service/reviews-v1/:id/comments/general?render=false - POSTmarkAllCommentsAsRead
/rest-service/reviews-v1/:id/comments/markAllAsReadFor the effective user, mark all comments in a review as read (except those marked as leave unread). - GETgetVersionedComments
/rest-service/reviews-v1/:id/comments/versioned?render=false - GETgetComment
/rest-service/reviews-v1/:id/comments/:cId?render=falseGets the given comment. - POSTupdateComment
/rest-service/reviews-v1/:id/comments/:cIdUpdates the comment given by the perma id to the new comment posted. - DELETEremoveComment
/rest-service/reviews-v1/:id/comments/:cIdDeletes the given comment. - POSTmarkCommentAsLeaveUnread
/rest-service/reviews-v1/:id/comments/:cId/markAsLeaveUnreadMarks the comment as leave unread to the current user - it will not automatically be marked as read by crucible. - POSTmarkCommentAsRead
/rest-service/reviews-v1/:id/comments/:cId/markAsReadMark the given comment as read for the user used to make this POST. - GETgetReplies
/rest-service/reviews-v1/:id/comments/:cId/replies?render=falseGets the replies to the given comment. - POSTaddReply
/rest-service/reviews-v1/:id/comments/:cId/repliesAdds a reply to the given comment. This call includes the repsonse header that contains the URL of the newly created entity. - POSTupdateReply
/rest-service/reviews-v1/:id/comments/:cId/replies/:rIdUpdates a reply with the given newComment. - DELETEremoveReply
/rest-service/reviews-v1/:id/comments/:cId/replies/:rIdDeletes the reply. - POSTcompleteReview
/rest-service/reviews-v1/:id/complete?ignoreWarnings=trueCompletes the review for the current user - GETgetDetailedReview
/rest-service/reviews-v1/:id/detailsReturns the specified review. - GETgetReviewPatches
/rest-service/reviews-v1/:id/patchGet a list of patches and their details for the given review - POSTaddPatchToReview
/rest-service/reviews-v1/:id/patchAdd the revisions in a patch to an existing review. - DELETEremovePatch
/rest-service/reviews-v1/:id/patch/:patchIdRemoves the patch with the given id from the review. All of the revisions provided by the patch will be removed as well. - POSTpublishAllComments
/rest-service/reviews-v1/:id/publishPublishes all the draft comments of the current user. - POSTpublishComment
/rest-service/reviews-v1/:id/publish/:cIdpublishes the given draft comment. - POSTremindIncompleteReviewers
/rest-service/reviews-v1/:id/remindImmediately send a reminder to incomplete reviewers about the given review. - GETgetReviewers
/rest-service/reviews-v1/:id/reviewersGet a list of reviewers in the review given by the permaid id. - POSTaddReviewers
/rest-service/reviews-v1/:id/reviewersAdds the given list of reviewers to the review. - GETgetCompletedReviewers
/rest-service/reviews-v1/:id/reviewers/completedGets a list of completed reviewers. - GETgetUncompletedReviewers
/rest-service/reviews-v1/:id/reviewers/uncompletedGets a list of reviewers that have not completed the review. - DELETEremoveReviewer
/rest-service/reviews-v1/:id/reviewers/:usernameRemoves the reviewer from the review. - GETgetReviewItemsForReview
/rest-service/reviews-v1/:id/reviewitemsReturns a list of all the items in a review. - POSTaddFisheyeReviewItem
/rest-service/reviews-v1/:id/reviewitemsAdd the changes between two files in a fisheye repository to the review. - POSTaddReviewItem
/rest-service/reviews-v1/:id/reviewitems/detailsAdds the given review item to the review. This will always create a new review item, even if there is an existing one with the same data in the review (in… - POSTaddReviewItems
/rest-service/reviews-v1/:id/reviewitems/revisionsAdds a review item for each of the supplied crucibleRevisionData elements. - GETgetReviewItem
/rest-service/reviews-v1/:id/reviewitems/:riIdReturns detailed information for a specific review item. - DELETEremoveReviewItem
/rest-service/reviews-v1/:id/reviewitems/:riIdRemoves an item from a review. - GETgetReviewItemsComments
/rest-service/reviews-v1/:id/reviewitems/:riId/comments?render=false - POSTaddVersionedComment
/rest-service/reviews-v1/:id/reviewitems/:riId/commentsThis call includes the repsonse header that contains the URL of the newly created entity. - PUTsetReviewItem
/rest-service/reviews-v1/:id/reviewitems/:riId/detailsSets the review item specified by itemId with the given reviewItem. The old review item is discarded. Can only perform this operation if the old review item… - POSTaddReviewItemRevisions
/rest-service/reviews-v1/:id/reviewitems/:riId/revisions?rev=stringAdds the given list of revisions to the supplied review item, merging if required. For example, if the review item for contains revisions 3 to 6, and if: - DELETEremoveReviewItemRevisions
/rest-service/reviews-v1/:id/reviewitems/:riId/revisions?rev=stringRemoves the revisions given from the review item in the review specified by the id. If the review item has no more revisions left, it is automatically deleted. - POSTchangeState
/rest-service/reviews-v1/:id/transition?action=string&ignoreWarnings=trueChange the state of a review by performing an action on it. - GETgetAvailableTransitions
/rest-service/reviews-v1/:id/transitionsGet a list of the actions which the current user can perform on this review, given its current state and the user's permissions. - POSTuncompleteReview
/rest-service/reviews-v1/:id/uncomplete?ignoreWarnings=trueUncompletes the review for the current user. - GETgetReviewsForTerm
/rest-service/search-v1/reviews?term=string&maxReturn=stringSearch for reviews where the name, description, state or permaId contain the specified term. - GETgetReviewsForIssueKey
/rest-service/search-v1/reviewsForIssue?jiraKey=string&maxReturn=stringGet a list of all reviews that have been linked to the specified JIRA issue key. - GETgetUsers
/rest-service/users-v1?username=stringGet a list of all the users. You can also ask for a set of users. - GETgetMappedUser
/rest-service/users-v1/:repository/:usernameReturns the user details of the user mapped to a committer in a repository. - GETgetUserProfile
/rest-service/users-v1/:usernameReturns the user's profile details.
API details
- Base URL
http://crucible.local/context- Authentication
- None declared in the description
- Operations
- 79 operations on 63 pathsGET 43POST 28DELETE 7PUT 1
- Description format
- Swagger 2.0, API version
1.0.0 - Links
- OpenAPI document
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Crucible in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Crucible collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “login” (GET /rest-service/auth-v1/login?userName=string&password=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Crucible?
Crucible endpoints from Atlassian It is listed under Developer tools and has 79 endpoints.
Who publishes the Crucible?
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 Crucible?
Requests go to http://crucible.local/context. Endpoint paths are added to this base URL.
How do I authenticate with the Crucible?
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 Crucible have?
79 operations on 63 paths (43 GET, 28 POST, 7 DELETE, 1 PUT).
Is forking the Crucible free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.