{"@context": "https://schema.org", "@type": "WebAPI", "name": "Crucible API", "description": "Crucible, an HTTP API described by an OpenAPI document.", "provider": {"@type": "Organization", "name": "crucible.local"}, "documentation": "https://docs.atlassian.com/fisheye-crucible/latest_backup/wadl/crucible.wadl"}
Index / APIs / crucible.local

Crucible API

Crucible, an HTTP API described by an OpenAPI document.

Every row below was read from the vendor's own OpenAPI document. The summary text is theirs. What this registry adds is that each operation is indexed with its method, path, base URL and auth scheme, so a search for a capability can answer with a call rather than a name, and that the endpoint is probed on a schedule.

Specifications as held by the APIs.guru corpus, whose newest record is 2023-04-21. Operations the vendor has added since are not listed here; the origin links above are the vendor's own current documents.

base URLs: http://crucible.local/context

find it by capability: POST /search {"query":{"text":"..."}} returns these operations with their invocation detail. Connect any agent client.

Crucible v1.0.0

Crucible, an HTTP API described by an OpenAPI document.

methodpathwhat the vendor says it does
GET/rest-service/auth-v1/loginGet the user authentication token. This is a legacy version of the login request. Using GET is deprecated a
POST/rest-service/auth-v1/loginGet the user authentication token.
GET/rest-service/projects-v1Get the list of projects that the authenticated user is entitled to access.
GET/rest-service/projects-v1/{key}Returns a project description.
GET/rest-service/repositories-v1Returns a list of all repositories. This includes plugin provided repositories
GET/rest-service/repositories-v1/browse/{repository}/{path}Lists the contents of the specified directory.
GET/rest-service/repositories-v1/change/{repository}/{revision}Represents a particular changeset.
GET/rest-service/repositories-v1/changes/{repository}/{path}Represents a sorted list of changesets, newest first.
GET/rest-service/repositories-v1/content/{repository}/{revision}/{path}Returns the raw content of the specified file revision as a binary stream. No attempt is made to identify the
GET/rest-service/repositories-v1/history/{repository}/{revision}/{path}Represents the history of a versioned entity.
GET/rest-service/repositories-v1/{repository}/svnFor backward compatibility we provide this method, but repositories should be referred to just by their key.
GET/rest-service/reviews-v1/detailsRetrieves all reviews that are in one of the the specified states. For each review all details are included (r
GET/rest-service/reviews-v1/filterTo ignore a property, omit it from the query string.
POST/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 f
GET/rest-service/reviews-v1/filter/detailsTo ignore a property, omit it from the query string.
POST/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 f
GET/rest-service/reviews-v1/filter/{filter}Get all the reviews which match the given filter, for the current user.
GET/rest-service/reviews-v1/filter/{filter}/detailsGets a list of all the reviews that match the specified filter criteria.
GET/rest-service/reviews-v1/metrics/{version}Get comment metrics metadata for the specified metrics version.
GET/rest-service/reviews-v1/search/{repository}Return a list of Reviews which include a particular file.
GET/rest-service/reviews-v1/search/{repository}/detailsReturn a list of Reviews which include a particular file.
GET/rest-service/reviews-v1/versionInfoReturns Crucible version information.
GET/rest-service/reviews-v1/{id}Get a single review by its permId (e.g. "CR-45"). If the review does not exist, a 404 is returned. The mod
DELETE/rest-service/reviews-v1/{id}Permanently deletes the specified review. The review must have been abandoned.
GET/rest-service/reviews-v1/{id}/actionsGet a list of the actions which the current user is allowed to perform on the review.
POST/rest-service/reviews-v1/{id}/addPatchOld, non-restful name. Kept for backwards compatibility. Exactly the same as POSTing to /{id}/patch
POST/rest-service/reviews-v1/{id}/closeCloses the given review with the summary given.
GET/rest-service/reviews-v1/{id}/commentsReturn all the comments visible to the requesting user for the review.
POST/rest-service/reviews-v1/{id}/commentsAdd a general comment to the review.
POST/rest-service/reviews-v1/{id}/comments/markAllAsReadFor the effective user, mark all comments in a review as read (except those marked as leave unread).
GET/rest-service/reviews-v1/{id}/comments/{cId}Gets the given comment.
POST/rest-service/reviews-v1/{id}/comments/{cId}Updates the comment given by the perma id to the new comment posted.
DELETE/rest-service/reviews-v1/{id}/comments/{cId}Deletes the given comment.
POST/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 crucibl
POST/rest-service/reviews-v1/{id}/comments/{cId}/markAsReadMark the given comment as read for the user used to make this POST.
GET/rest-service/reviews-v1/{id}/comments/{cId}/repliesGets the replies to the given comment.
POST/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
POST/rest-service/reviews-v1/{id}/comments/{cId}/replies/{rId}Updates a reply with the given newComment.
DELETE/rest-service/reviews-v1/{id}/comments/{cId}/replies/{rId}Deletes the reply.
POST/rest-service/reviews-v1/{id}/completeCompletes the review for the current user

and 30 more operation(s) in this specification, all searchable.

specification origin: https://docs.atlassian.com/fisheye-crucible/latest_backup/wadl/crucible.wadl

nothing on this page is a rating, an endorsement or a claim about quality. Reachability is what our probes observed from one network; answering is a floor under usefulness, not a measure of it.