go-bitbucket-v1/docs/DefaultApi.md

\DefaultApi

All URIs are relative to http://example.com/rest/

Method	HTTP request	Description
AddGroupToUser	Post /api/1.0/admin/users/add-group
AddUserToGroup	Post /api/1.0/admin/groups/add-user
AddUserToGroups	Post /api/1.0/admin/users/add-groups
AddUsersToGroup	Post /api/1.0/admin/groups/add-users
Approve	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve
AssignParticipantRole	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants
CanMerge	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge
ClearSenderAddress	Delete /api/1.0/admin/mail-server/sender-address
ClearUserCaptchaChallenge	Delete /api/1.0/admin/users/captcha
CountPullRequestTasks	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/tasks/count
Create	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests
CreateBranch	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches
CreateComment	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments
CreateComment_0	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments
CreateGroup	Post /api/1.0/admin/groups
CreateProject	Post /api/1.0/projects
CreateRepository	Post /api/1.0/projects/{projectKey}/repos
CreateTag	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags
CreateTask	Post /api/1.0/tasks
CreateUser	Post /api/1.0/admin/users
CreateWebhook	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks
Decline	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/decline
Delete	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
DeleteAvatar	Delete /api/1.0/users/{userSlug}/avatar.png
DeleteComment	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}
DeleteComment_0	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
DeleteGroup	Delete /api/1.0/admin/groups
DeleteMailConfig	Delete /api/1.0/admin/mail-server
DeleteProject	Delete /api/1.0/projects/{projectKey}
DeleteRepository	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}
DeleteRepositoryHook	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}
DeleteTask	Delete /api/1.0/tasks/{taskId}
DeleteUser	Delete /api/1.0/admin/users
DeleteWebhook	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}
DisableHook	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled
DisableHook_0	Delete /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/enabled
EditFile	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/browse/{path}
EnableHook	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/enabled
EnableHook_0	Put /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/enabled
FindGroupsForUser	Get /api/1.0/admin/users/more-members
FindOtherGroupsForUser	Get /api/1.0/admin/users/more-non-members
FindUsersInGroup	Get /api/1.0/admin/groups/more-members
FindUsersNotInGroup	Get /api/1.0/admin/groups/more-non-members
FindWebhooks	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks
ForkRepository	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}
Get	Get /api/1.0/admin/license
GetActivities	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/activities
GetApplicationProperties	Get /api/1.0/application-properties
GetArchive	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/archive
GetAvatar	Get /api/1.0/hooks/{hookKey}/avatar
GetBranches	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches
GetChanges	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/changes
GetChanges_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/changes
GetComment	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}
GetComment_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
GetComments	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments
GetComments_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments
GetCommit	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}
GetCommits	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits
GetCommits_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/commits
GetContent	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/browse
GetContent_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/browse/{path}
GetContent_1	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/raw
GetContent_2	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/raw/{path}
GetDefaultBranch	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches/default
GetForkedRepositories	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/forks
GetGroups	Get /api/1.0/admin/groups
GetGroupsWithAnyPermission	Get /api/1.0/admin/permissions/groups
GetGroupsWithAnyPermission_0	Get /api/1.0/projects/{projectKey}/permissions/groups
GetGroupsWithAnyPermission_1	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups
GetGroupsWithoutAnyPermission	Get /api/1.0/admin/permissions/groups/none
GetGroupsWithoutAnyPermission_0	Get /api/1.0/projects/{projectKey}/permissions/groups/none
GetGroupsWithoutAnyPermission_1	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups/none
GetGroups_0	Get /api/1.0/groups
GetInformation	Get /api/1.0/admin/cluster
GetLatestInvocation	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/latest
GetLevel	Get /api/1.0/logs/logger/{loggerName}
GetMailConfig	Get /api/1.0/admin/mail-server
GetMergeConfig	Get /api/1.0/admin/pull-requests/{scmId}
GetPage	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests
GetProject	Get /api/1.0/projects/{projectKey}
GetProjectAvatar	Get /api/1.0/projects/{projectKey}/avatar.png
GetProjects	Get /api/1.0/projects
GetPullRequestCount	Get /api/1.0/inbox/pull-requests/count
GetPullRequestSettings	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests
GetPullRequestSettings_0	Get /api/1.0/projects/{projectKey}/settings/pull-requests/{scmId}
GetPullRequestSuggestions	Get /api/1.0/dashboard/pull-request-suggestions
GetPullRequestTasks	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/tasks
GetPullRequests	Get /api/1.0/dashboard/pull-requests
GetPullRequests_0	Get /api/1.0/inbox/pull-requests
GetRelatedRepositories	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/related
GetRepositories	Get /api/1.0/projects/{projectKey}/repos
GetRepositoriesRecentlyAccessed	Get /api/1.0/profile/recent/repos
GetRepositories_0	Get /api/1.0/repos
GetRepository	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}
GetRepositoryHook	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}
GetRepositoryHook_0	Get /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}
GetRepositoryHooks	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks
GetRepositoryHooks_0	Get /api/1.0/projects/{projectKey}/settings/hooks
GetRootLevel	Get /api/1.0/logs/rootLogger
GetSenderAddress	Get /api/1.0/admin/mail-server/sender-address
GetSettings	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings
GetSettings_0	Get /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/settings
GetStatistics	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics
GetStatisticsSummary	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}/statistics/summary
GetTag	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags/{name}
GetTags	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/tags
GetTask	Get /api/1.0/tasks/{taskId}
GetUser	Get /api/1.0/users/{userSlug}
GetUserSettings	Get /api/1.0/users/{userSlug}/settings
GetUsers	Get /api/1.0/admin/users
GetUsersWithAnyPermission	Get /api/1.0/admin/permissions/users
GetUsersWithAnyPermission_0	Get /api/1.0/projects/{projectKey}/permissions/users
GetUsersWithAnyPermission_1	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users
GetUsersWithoutAnyPermission	Get /api/1.0/admin/permissions/users/none
GetUsersWithoutPermission	Get /api/1.0/projects/{projectKey}/permissions/users/none
GetUsersWithoutPermission_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users/none
GetUsers_0	Get /api/1.0/users
GetWebhook	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}
Get_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
HasAllUserPermission	Get /api/1.0/projects/{projectKey}/permissions/{permission}/all
ListParticipants	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants
Merge	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/merge
ModifyAllUserPermission	Post /api/1.0/projects/{projectKey}/permissions/{permission}/all
Preview	Post /api/1.0/markup/preview
RemoveGroupFromUser	Post /api/1.0/admin/users/remove-group
RemoveUserFromGroup	Post /api/1.0/admin/groups/remove-user
RenameUser	Post /api/1.0/admin/users/rename
Reopen	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/reopen
RetryCreateRepository	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/recreate
RevokePermissionsForGroup	Delete /api/1.0/admin/permissions/groups
RevokePermissionsForGroup_0	Delete /api/1.0/projects/{projectKey}/permissions/groups
RevokePermissionsForGroup_1	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups
RevokePermissionsForUser	Delete /api/1.0/admin/permissions/users
RevokePermissionsForUser_0	Delete /api/1.0/projects/{projectKey}/permissions/users
RevokePermissionsForUser_1	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users
Search	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/participants
SetDefaultBranch	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches/default
SetLevel	Put /api/1.0/logs/logger/{loggerName}/{levelName}
SetMailConfig	Put /api/1.0/admin/mail-server
SetMergeConfig	Post /api/1.0/admin/pull-requests/{scmId}
SetPermissionForGroup	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/groups
SetPermissionForGroups	Put /api/1.0/admin/permissions/groups
SetPermissionForGroups_0	Put /api/1.0/projects/{projectKey}/permissions/groups
SetPermissionForUser	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/permissions/users
SetPermissionForUsers	Put /api/1.0/admin/permissions/users
SetPermissionForUsers_0	Put /api/1.0/projects/{projectKey}/permissions/users
SetRootLevel	Put /api/1.0/logs/rootLogger/{levelName}
SetSenderAddress	Put /api/1.0/admin/mail-server/sender-address
SetSettings	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/hooks/{hookKey}/settings
SetSettings_0	Put /api/1.0/projects/{projectKey}/settings/hooks/{hookKey}/settings
Stream	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/last-modified
StreamChanges	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/compare/changes
StreamChanges_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/changes
StreamCommits	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/compare/commits
StreamDiff	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff
StreamDiff_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/diff/{path}
StreamDiff_1	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/compare/diff{path}
StreamDiff_2	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/diff
StreamDiff_3	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/diff/{path}
StreamDiff_4	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff
StreamDiff_5	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/diff/{path}
StreamFiles	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/files
StreamFiles_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/files/{path}
Stream_0	Get /api/1.0/projects/{projectKey}/repos/{repositorySlug}/last-modified/{path}
TestWebhook	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/test
UnassignParticipantRole	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants
UnassignParticipantRole_0	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}
Unwatch	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch
Unwatch_0	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch
Update	Post /api/1.0/admin/license
UpdateComment	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/comments/{commentId}
UpdateComment_0	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
UpdatePullRequestComment	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/comments/{commentId}
UpdateProject	Put /api/1.0/projects/{projectKey}
UpdatePullRequestSettings	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/settings/pull-requests
UpdatePullRequestSettings_0	Post /api/1.0/projects/{projectKey}/settings/pull-requests/{scmId}
UpdateRepository	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}
UpdateSettings	Post /api/1.0/users/{userSlug}/settings
UpdateStatus	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug}
UpdateTask	Put /api/1.0/tasks/{taskId}
UpdateUserDetails	Put /api/1.0/admin/users
UpdateUserDetails_0	Put /api/1.0/users
UpdateUserPassword	Put /api/1.0/admin/users/credentials
UpdateUserPassword_0	Put /api/1.0/users/credentials
UpdateWebhook	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/webhooks/{webhookId}
Update_0	Put /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}
UploadAvatar	Post /api/1.0/projects/{projectKey}/avatar.png
UploadAvatar_0	Post /api/1.0/users/{userSlug}/avatar.png
Watch	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/commits/{commitId}/watch
Watch_0	Post /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/watch
WithdrawApproval	Delete /api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/approve

AddGroupToUser

AddGroupToUser(ctx, )

Deprecated since 2.10. Use /rest/users/add-groups instead.

Add a user to a group. This is very similar to groups/add-user, but with the context and itemName attributes of the supplied request entity reversed. On the face of it this may appear redundant, but it facilitates a specific UI component in Stash.

In the request entity, the context attribute is the user and the itemName is the group.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddUserToGroup

AddUserToGroup(ctx, )

Deprecated since 2.10. Use /rest/users/add-groups instead.

Add a user to a group.

In the request entity, the context attribute is the group and the itemName is the user.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddUserToGroups

AddUserToGroups(ctx, )

Add a user to one or more groups.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddUsersToGroup

AddUsersToGroup(ctx, )

Add multiple users to a group.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Approve

Approve(ctx, pullRequestId)

Approve a pull request as the current user. Implicitly adds the user as a participant if they are not already.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AssignParticipantRole

AssignParticipantRole(ctx, pullRequestId)

Assigns a participant to an explicit role in pull request. Currently only the REVIEWER role may be assigned.

If the user is not yet a participant in the pull request, they are made one and assigned the supplied role.

If the user is already a participant in the pull request, their previous role is replaced with the supplied role unless they are already assigned the AUTHOR role which cannot be changed and will result in a Bad Request (400) response code.

The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CanMerge

CanMerge(ctx, pullRequestId)

Test whether a pull request can be merged.

A pull request may not be merged if:

• there are conflicts that need to be manually resolved before merging; and/or
• one or more merge checks have vetoed the merge.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the ID of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClearSenderAddress

ClearSenderAddress(ctx, )

Clears the server email address.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ClearUserCaptchaChallenge

ClearUserCaptchaChallenge(ctx, optional)

Clears any CAPTCHA challenge that may constrain the user with the supplied username when they authenticate. Additionally any counter or metric that contributed towards the user being issued the CAPTCHA challenge (for instance too many consecutive failed logins) will also be reset.

The authenticated user must have the ADMIN permission to call this resource, and may not clear the CAPTCHA of a user with greater permissions than themselves.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CountPullRequestTasks

CountPullRequestTasks(ctx, )

Retrieve the total number of {@link TaskState#OPEN open} and {@link TaskState#RESOLVED resolved} tasks associated with a pull request.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Create

Create(ctx, )

Create a new pull request between two branches. The branches may be in the same repository, or different ones. When using different repositories, they must still be in the same {@link Repository#getHierarchyId() hierarchy}.

The authenticated user must have REPO_READ permission for the "from" and "to"repositories to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateBranch

CreateBranch(ctx, )

Creates a branch using the information provided in the {@link RestCreateBranchRequest request}

The authenticated user must have REPO_WRITE permission for the context repository to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateComment

CreateComment(ctx, commitId, optional)

Add a new comment.

Comments can be added in a few places by setting different attributes:

General commit comment:

      {          "text": "An insightful general comment on a commit."      }      

Reply to a comment:

      {          "text": "A measured reply.",          "parent": {              "id": 1          }      }      

General file comment:

      {          "text": "An insightful general comment on a file.",          "anchor": {              "diffType": "COMMIT",              "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",              "path": "path/to/file",              "srcPath": "path/to/file",              "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"          }      }      

File line comment:

      {          "text": "A pithy comment on a particular line within a file.",          "anchor": {              "diffType": "COMMIT",              "line": 1,              "lineType": "CONTEXT",              "fileType": "FROM",              "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",              "path": "path/to/file",              "srcPath": "path/to/file",              "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"      }      }      

Note: general file comments are an experimental feature and may change in the near future!

For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on.

For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be:

• 'ADDED' - for an added line;
• 'REMOVED' - for a removed line; or
• 'CONTEXT' - for a line that was unmodified but is in the vicinity of the diff.

'fileType' refers to the file of the diff to which the anchor should be attached - which is of relevance when displaying the diff in a side-by-side way. Currently the supported values are:

• 'FROM' - the source file of the diff
• 'TO' - the destination file of the diff

If the current user is not a participant the user is added as one and updated to watch the commit.

The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string	the commit to which the comments must be anchored
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
commitId	string	the commit to which the comments must be anchored
since	string	For a merge commit, a parent can be provided to specify which diff the comments should be on. For a commit range, a {@code sinceId} can be provided to specify where the comments should be anchored from.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateComment_0

CreateComment_0(ctx, )

Add a new comment.

Comments can be added in a few places by setting different attributes:

General pull request comment:

      {          "text": "An insightful general comment on a pull request."      }      

Reply to a comment:

      {          "text": "A measured reply.",          "parent": {              "id": 1          }      }      

General file comment:

      {          "text": "An insightful general comment on a file.",          "anchor": {              "diffType": "RANGE",              "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",              "path": "path/to/file",              "srcPath": "path/to/file",              "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"          }      }      

File line comment:

      {          "text": "A pithy comment on a particular line within a file.",          "anchor": {              "diffType": "COMMIT",              "line": 1,              "lineType": "CONTEXT",              "fileType": "FROM",              "fromHash": "6df3858eeb9a53a911cd17e66a9174d44ffb02cd",              "path": "path/to/file",              "srcPath": "path/to/file",              "toHash": "04c7c5c931b9418ca7b66f51fe934d0bd9b2ba4b"          }      }      

For file and line comments, 'path' refers to the path of the file to which the comment should be applied and 'srcPath' refers to the path the that file used to have (only required for copies and moves). Also, fromHash and toHash refer to the sinceId / untilId (respectively) used to produce the diff on which the comment was added. Finally diffType refers to the type of diff the comment was added on. For backwards compatibility purposes if no diffType is provided and no fromHash/toHash pair is provided the diffType will be resolved to 'EFFECTIVE'. In any other cases the diffType is REQUIRED.

For line comments, 'line' refers to the line in the diff that the comment should apply to. 'lineType' refers to the type of diff hunk, which can be:

• 'ADDED' - for an added line;
• 'REMOVED' - for a removed line; or
• 'CONTEXT' - for a line that was unmodified but is in the vicinity of the diff.

'fileType' refers to the file of the diff to which the anchor should be attached - which is of relevance when displaying the diff in a side-by-side way. Currently the supported values are:

• 'FROM' - the source file of the diff
• 'TO' - the destination file of the diff

If the current user is not a participant the user is added as a watcher of the pull request.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateGroup

CreateGroup(ctx, optional)

Create a new group.

The authenticated user must have ADMIN permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	Name of the group.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateProject

CreateProject(ctx, )

Create a new project.

To include a custom avatar for the project, the project definition should contain an additional attribute with the key avatar and the value a data URI containing Base64-encoded image data. The URI should be in the following format:

      data:(content type, e.g. image/png);base64,(data)  

If the data is not Base64-encoded, or if a character set is defined in the URI, or the URI is otherwise invalid, project creation will fail.

The authenticated user must have PROJECT_CREATE permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateRepository

CreateRepository(ctx, projectKey)

Create a new repository. Requires an existing project in which this repository will be created. The only parameters which will be used are name and scmId.

The authenticated user must have PROJECT_ADMIN permission for the context project to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	the parent project key

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateTag

CreateTag(ctx, )

Creates a tag using the information provided in the {@link RestCreateTagRequest request}

The authenticated user must have REPO_WRITE permission for the context repository to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateTask

CreateTask(ctx, )

Create a new task.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateUser

CreateUser(ctx, optional)

Creates a new user from the assembled query parameters.

The default group can be used to control initial permissions for new users, such as granting users the ability to login or providing read access to certain projects or repositories. If the user is not added to the default group, they may not be able to login after their account is created until explicit permissions are configured.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the username for the new user
password	string	the password for the new user
displayName	string	the display name for the new user
emailAddress	string	the e-mail address for the new user
addToDefaultGroup	bool	<code>true</code> to add the user to the default group, which can be used to grant them a set of initial permissions; otherwise, <code>false</code> to not add them to a group	[default to true]
notify	string	if present and not <code>false</code> instead of requiring a password, the create user will be notified via email their account has been created and requires a password to be reset. This option can only be used if a mail server has been configured

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateWebhook

CreateWebhook(ctx, )

Create a webhook for the repository specified via the URL.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Decline

Decline(ctx, pullRequestId, optional)

Decline a pull request.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
pullRequestId	int64
version	int32	the current version of the pull request. If the server's version isn't the same as the specified version the operation will fail. To determine the current version of the pull request it should be fetched from the server prior to this operation. Look for the 'version' attribute in the returned JSON structure.	[default to -1]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Delete

Delete(ctx, pullRequestId)

Deletes a pull request.

To call this resource, users must be authenticated and have permission to view the pull request. Additionally, they must:

• be the pull request author, if the system is configured to allow authors to delete their own pull requests (this is the default) OR
• have repository administrator permission for the repository the pull request is targeting

A body containing the version of the pull request must be provided with this request.

{ "version": 1 }

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the ID of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteAvatar

DeleteAvatar(ctx, )

Delete the avatar associated to a user.

Users are always allowed to delete their own avatar. To delete someone else's avatar the authenticated user must have global ADMIN permission, or global SYS_ADMIN permission to update a SYS_ADMIN user's avatar.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteComment

DeleteComment(ctx, commitId, commentId, commitId2, optional)

Delete a commit comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users. Comments which have replies may not be deleted, regardless of the user's granted permissions.

The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string	the commit to which the comments must be anchored
commentId	int64	the ID of the comment to retrieve
commitId2	string	the <i>full {@link Commit#getId() ID}</i> of the commit within the repository
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
commitId	string	the commit to which the comments must be anchored
commentId	int64	the ID of the comment to retrieve
commitId2	string	the <i>full {@link Commit#getId() ID}</i> of the commit within the repository
version	int32	The expected version of the comment. This must match the server's version of the comment or the delete will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the delete. Look for the 'version' attribute in the returned JSON structure.	[default to -1]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteComment_0

DeleteComment_0(ctx, commentId, optional)

Delete a pull request comment. Anyone can delete their own comment. Only users with REPO_ADMIN and above may delete comments created by other users.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commentId	int64	the id of the comment to retrieve
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
commentId	int64	the id of the comment to retrieve
version	int32	The expected version of the comment. This must match the server's version of the comment or the delete will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the delete. Look for the 'version' attribute in the returned JSON structure.	[default to -1]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteGroup

DeleteGroup(ctx, optional)

Deletes the specified group, removing them from the system. This also removes any permissions that may have been granted to the group.

A user may not delete the last group that is granting them administrative permissions, or a group with greater permissions than themselves.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the name identifying the group to delete

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteMailConfig

DeleteMailConfig(ctx, )

Deletes the current mail configuration.

The authenticated user must have the SYS_ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteProject

DeleteProject(ctx, )

Delete the project matching the supplied projectKey.

The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteRepository

DeleteRepository(ctx, projectKey, projectKey2, repositorySlug)

Schedule the repository matching the supplied projectKey and repositorySlug to be deleted. If the request repository is not present

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	the parent project key
projectKey2	string	the parent project key
repositorySlug	string	the repository slug

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteRepositoryHook

DeleteRepositoryHook(ctx, hookKey)

Delete repository hook configuration for the supplied hookKey and repositorySlug

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteTask

DeleteTask(ctx, taskId)

Delete a task.

Note that only the task's creator, the context's author or an admin of the context's repository can delete a task. (For a pull request task, those are the task's creator, the pull request's author or an admin on the repository containing the pull request). Additionally a task cannot be deleted if it has already been resolved.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
taskId	int64	the id identifying the task to delete

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteUser

DeleteUser(ctx, optional)

Deletes the specified user, removing them from the system. This also removes any permissions that may have been granted to the user.

A user may not delete themselves, and a user with ADMIN permissions may not delete a user with SYS_ADMINpermissions.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the username identifying the user to delete

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteWebhook

DeleteWebhook(ctx, webhookId)

Delete a webhook for the repository specified via the URL.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
webhookId	int32	the existing webhook id

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DisableHook

DisableHook(ctx, hookKey)

Disable a repository hook for this repository.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DisableHook_0

DisableHook_0(ctx, hookKey)

Disable a repository hook for this project.

The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EditFile

EditFile(ctx, path)

Update the content of path, on the given repository and branch.

This resource accepts PUT multipart form data, containing the file in a form-field named content.

An example <a href="http://curl.haxx.se/">curl request to update 'README.md' would be:

  curl -X PUT -u username:password -F content=@README.md  -F 'message=Updated using file-edit REST API'  -F branch=master -F  sourceCommitId=5636641a50b   http://example.com/rest/api/latest/projects/PROJECT_1/repos/repo_1/browse/README.md  

branch: the branch on which the path should be modified or created

content: the full content of the file at path

message: the message associated with this change, to be used as the commit message. Or null if the default message should be used.

sourceCommitId: the commit ID of the file before it was edited, used to identify if content has changed. Or null if this is a new file

The file can be updated or created on a new branch. In this case, the sourceBranch parameter should be provided to identify the starting point for the new branch and the branch parameter identifies the branch to create the new commit on.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
path	string	the file path to retrieve content from

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnableHook

EnableHook(ctx, hookKey, optional)

Enable a repository hook for this repository and optionally apply new configuration.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

A JSON document may be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
hookKey	string
contentLength	int32		[default to 0]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

EnableHook_0

EnableHook_0(ctx, hookKey, optional)

Enable a repository hook for this project and optionally apply new configuration.

The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.

A JSON document may be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
hookKey	string
contentLength	int32		[default to 0]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FindGroupsForUser

FindGroupsForUser(ctx, optional)

Retrieves a list of groups the specified user is a member of.

The authenticated user must have the LICENSED_USER permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
context	string	the user which should be used to locate groups
filter	string	if specified only groups with names containing the supplied string will be returned	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FindOtherGroupsForUser

FindOtherGroupsForUser(ctx, optional)

Retrieves a list of groups the specified user is not a member of.

The authenticated user must have the LICENSED_USER permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
context	string	the user which should be used to locate groups
filter	string	if specified only groups with names containing the supplied string will be returned	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FindUsersInGroup

FindUsersInGroup(ctx, optional)

Retrieves a list of users that are members of a specified group.

The authenticated user must have the LICENSED_USER permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
context	string	the group which should be used to locate members
filter	string	if specified only users with usernames, display names or email addresses containing the supplied string will be returned	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FindUsersNotInGroup

FindUsersNotInGroup(ctx, optional)

Retrieves a list of users that are not members of a specified group.

The authenticated user must have the LICENSED_USER permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
context	string	the group which should be used to locate non-members
filter	string	if specified only users with usernames, display names or email addresses containing the supplied string will be returned	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FindWebhooks

FindWebhooks(ctx, optional)

Find webhooks in this repository.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
event	string	list of {@link com.atlassian.webhooks.WebhookEvent} ids to filter for
statistics	bool	{@code true} if statistics should be provided for all found webhooks	[default to false]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ForkRepository

ForkRepository(ctx, projectKey, projectKey2, repositorySlug)

Create a new repository forked from an existing repository.

The JSON body for this {@code POST} is not required to contain any properties. Even the name may be omitted. The following properties will be used, if provided:

• {@code "name":"Fork name"} - Specifies the forked repository's name
  • Defaults to the name of the origin repository if not specified
• {@code "project":{"key":"TARGET_KEY"}} - Specifies the forked repository's target project by key
  • Defaults to the current user's personal project if not specified

The authenticated user must have REPO_READ permission for the specified repository and PROJECT_ADMIN on the target project to call this resource. Note that users always have PROJECT_ADMIN permission on their personal projects.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	the parent project key
projectKey2	string	the parent project key
repositorySlug	string	the repository slug

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get

Get(ctx, )

Retrieves details about the current license, as well as the current status of the system with regards to the installed license. The status includes the current number of users applied toward the license limit, as well as any status messages about the license (warnings about expiry or user counts exceeding license limits).

The authenticated user must have ADMIN permission. Unauthenticated users, and non-administrators, are not permitted to access license details.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetActivities

GetActivities(ctx, pullRequestId, optional)

Retrieve a page of activity associated with a pull request.

Activity items include comments, approvals, rescopes (i.e. adding and removing of commits), merges and more.

Different types of activity items may be introduced in newer versions of Stash or by user installed plugins, so clients should be flexible enough to handle unexpected entity shapes in the returned page.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
pullRequestId	int64	the id of the pull request within the repository
fromId	int64	(optional) the id of the activity item to use as the first item in the returned page
fromType	string	(required if <strong>fromId</strong> is present) the type of the activity item specified by <strong>fromId</strong> (either <strong>COMMENT</strong> or <strong>ACTIVITY</strong>)

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetApplicationProperties

GetApplicationProperties(ctx, )

Retrieve version information and other application properties.

No authentication is required to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetArchive

GetArchive(ctx, optional)

Streams an archive of the repository's contents at the requested commit. If no at= commit is requested, an archive of the default branch is streamed.

The filename= query parameter may be used to specify the exact filename to include in the "Content-Disposition" header. If an explicit filename is not provided, one will be automatically generated based on what is being archived. Its format depends on the at= value:

• No at= commit: <slug>-<default-branch-name>@<commit>.<format>; e.g. example-master@43c2f8a0fe8.zip
• at=sha: <slug>-<at>.<format>; e.g. example-09bcbb00100cfbb5310fb6834a1d5ce6cac253e9.tar.gz
• at=branchOrTag: <slug>-<branchOrTag>@<commit>.<format>; e.g. example-feature@bbb225f16e1.tar
  • If the branch or tag is qualified (e.g. refs/heads/master, the short name (master) will be included in the filename
  • If the branch or tag's short name includes slashes (e.g. release/4.6), they will be converted to hyphens in the filename (release-4.5)

Archives may be requested in the following formats by adding the format= query parameter:

• zip: A zip file using standard compression (Default)
• tar: An uncompressed tarball
• tar.gz or tgz: A GZip-compressed tarball

The contents of the archive may be filtered by using the path= query parameter to specify paths to include. path= may be specified multiple times to include multiple paths.

The prefix= query parameter may be used to define a directory (or multiple directories) where the archive's contents should be placed. If the prefix does not end with /, one will be added automatically. The prefix is always treated as a directory; it is not possible to use it to prepend characters to the entries in the archive.

Archives of public repositories may be streamed by any authenticated or anonymous user. Streaming archives for non-public repositories requires an authenticated user with at least REPO_READ permission.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
at	string	the commit to stream an archive of; if not supplied, an archive of the default branch is streamed
filename	string	a filename to include the "Content-Disposition" header
format	string	the format to stream the archive in; must be one of: zip, tar, tar.gz or tgz
path	string	paths to include in the streamed archive; may be repeated to include multiple paths
prefix	string	a prefix to apply to all entries in the streamed archive; if the supplied prefix does not end with a trailing <code>/</code>, one will be added automatically

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAvatar

GetAvatar(ctx, hookKey, optional)

Retrieve the avatar for the project matching the supplied moduleKey.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string	the complete module key of the hook module
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
hookKey	string	the complete module key of the hook module
version	string	optional version used for HTTP caching only - any non-blank version will result in a large max-age Cache-Control header. Note that this does not affect the Last-Modified header.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetBranches

GetBranches(ctx, optional)

Retrieve the branches matching the supplied filterText param.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
base	string	base branch or tag to compare each branch to (for the metadata providers that uses that information)
details	bool	whether to retrieve plugin-provided metadata about each branch
filterText	string	the text to match on
orderBy	string	ordering of refs either ALPHABETICAL (by name) or MODIFICATION (last updated)

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetChanges

GetChanges(ctx, optional)

Retrieve a page of changes made in a specified commit.

Note: The implementation will apply a hard cap ({@code page.max.changes}) and it is not possible to request subsequent content when that cap is exceeded.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
since	string	the commit to which <code>until</code> should be compared to produce a page of changes. If not specified the commit's first parent is assumed (if one exists)
until	string	the commit to retrieve changes for

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetChanges_0

GetChanges_0(ctx, commitId, optional)

Retrieve a page of changes made in a specified commit.

Note: The implementation will apply a hard cap ({@code page.max.changes}) and it is not possible to request subsequent content when that cap is exceeded.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string	the commit to retrieve changes for
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
commitId	string	the commit to retrieve changes for
since	string	the commit to which <code>until</code> should be compared to produce a page of changes. If not specified the commit's first parent is assumed (if one exists)
withComments	bool	{@code true} to apply comment counts in the changes (the default); otherwise, {@code false} to stream changes without comment counts	[default to true]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetComment

GetComment(ctx, commitId, commentId, commitId2)

Retrieves a commit discussion comment.

The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string	the commit to which the comments must be anchored
commentId	int64	the ID of the comment to retrieve
commitId2	string	the <i>full {@link Commit#getId() ID}</i> of the commit within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetComment_0

GetComment_0(ctx, commentId)

Retrieves a pull request comment.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commentId	int64	the id of the comment to retrieve

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetComments

GetComments(ctx, commitId, optional)

Retrieves the commit discussion comments that match the specified search criteria.

It is possible to retrieve commit discussion comments that are anchored to a range of commits by providing the {@code sinceId} that the comments anchored from.

The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string	the commit to which the comments must be anchored
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
commitId	string	the commit to which the comments must be anchored
path	string	the path to the file on which comments were made
since	string	For a merge commit, a parent can be provided to specify which diff the comments are on. For a commit range, a {@code sinceId} can be provided to specify where the comments are anchored from.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetComments_0

GetComments_0(ctx, optional)

Gets comments for the specified PullRequest.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
anchorState	string	{@code ACTIVE} to stream the active comments; {@code ORPHANED} to stream the orphaned comments; {@code ALL} to stream both the active and the orphaned comments;	[default to ACTIVE]
diffType	string	{@code EFFECTIVE} to stream the comments related to the effective diff of the pull request; {@code RANGE} to stream comments related to a commit range between two arbitrary commits (requires {@code fromHash} and {@code toHash}); {@code COMMIT} to stream comments related to a commit between two arbitrary commits (requires {@code fromHash} and {@code toHash})
fromHash	string	the from commit hash to stream comments for a {@code RANGE} or {@code COMMIT} arbitrary change scope
path	string	the path to stream comments for a given path
toHash	string	the to commit hash to stream comments for a {@code RANGE} or {@code COMMIT} arbitrary change scope

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCommit

GetCommit(ctx, commitId, optional)

Retrieve a single commit identified by its ID>. In general, that ID is a SHA1. From 2.11, ref names like "refs/heads/master" are no longer accepted by this resource.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string	the commit ID to retrieve
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
commitId	string	the commit ID to retrieve
path	string	an optional path to filter the commit by. If supplied the details returned <i>may not</i> be for the specified commit. Instead, starting from the specified commit, they will be the details for the first commit affecting the specified path.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCommits

GetCommits(ctx, optional)

Retrieve a page of commits from a given starting commit or "between" two commits. If no explicit commit is specified, the tip of the repository's default branch is assumed. commits may be identified by branch or tag name or by ID. A path may be supplied to restrict the returned commits to only those which affect that path.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
followRenames	bool	if <code>true</code>, the commit history of the specified file will be followed past renames. Only valid for a path to a single file.	[default to false]
ignoreMissing	bool	<code>true</code> to ignore missing commits, <code>false</code> otherwise	[default to false]
merges	string	if present, controls how merge commits should be filtered. Can be either <code>exclude</code>, to exclude merge commits, <code>include</code>, to include both merge commits and non-merge commits or <code>only</code>, to only return merge commits.
path	string	an optional path to filter commits by
since	string	the commit ID or ref (exclusively) to retrieve commits after
until	string	the commit ID (SHA1) or ref (inclusively) to retrieve commits before
withCounts	bool	optionally include the total number of commits and total number of unique authors	[default to false]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetCommits_0

GetCommits_0(ctx, pullRequestId, optional)

Retrieve commits for the specified pull request.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
pullRequestId	int64
withCounts	bool	if set to true, the service will add "authorCount" and "totalCount" at the end of the page. "authorCount" is the number of different authors and "totalCount" is the total number of commits.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetContent

GetContent(ctx, optional)

Retrieve a page of content for a file path at a specified revision.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
at	string	the commit ID or ref to retrieve the content for.	[default to ]
type_	bool	if true only the type will be returned for the file path instead of the contents.	[default to false]
blame	string	if present the blame will be returned for the file as well.
noContent	string	if present and used with blame only the blame is retrieved instead of the contents.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetContent_0

GetContent_0(ctx, path, optional)

Retrieve a page of content for a file path at a specified revision.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
path	string	the file path to retrieve content from
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
path	string	the file path to retrieve content from
at	string	the commit ID or ref to retrieve the content for.	[default to ]
type_	bool	if true only the type will be returned for the file path instead of the contents.	[default to false]
blame	string	if present the blame will be returned for the file as well.
noContent	string	if present and used with blame only the blame is retrieved instead of the contents.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetContent_1

GetContent_1(ctx, optional)

Retrieve the raw content for a file path at a specified revision.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
at	string	the commit ID or ref to retrieve the content for.
markup	string	if present or <code>&quot;true&quot;</code>, triggers the raw content to be markup-rendered and returned as HTML; otherwise, if not specified, or any value other than <code>&quot;true&quot;</code>, the content is streamed without markup
hardwrap	bool	(Optional) Whether the markup implementation should convert newlines to breaks. If not specified, {@link MarkupService} will use the value of the <code>markup.render.hardwrap</code> property, which is <code>true</code> by default
htmlEscape	bool	(Optional) true if HTML should be escaped in the input markup, false otherwise. If not specified, {@link MarkupService} will use the value of the <code>markup.render.html.escape</code> property, which is <code>true</code> by default

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetContent_2

GetContent_2(ctx, path, optional)

Retrieve the raw content for a file path at a specified revision.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
path	string	the file path to retrieve content from
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
path	string	the file path to retrieve content from
at	string	the commit ID or ref to retrieve the content for.
markup	string	if present or <code>&quot;true&quot;</code>, triggers the raw content to be markup-rendered and returned as HTML; otherwise, if not specified, or any value other than <code>&quot;true&quot;</code>, the content is streamed without markup
hardwrap	bool	(Optional) Whether the markup implementation should convert newlines to breaks. If not specified, {@link MarkupService} will use the value of the <code>markup.render.hardwrap</code> property, which is <code>true</code> by default
htmlEscape	bool	(Optional) true if HTML should be escaped in the input markup, false otherwise. If not specified, {@link MarkupService} will use the value of the <code>markup.render.html.escape</code> property, which is <code>true</code> by default

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetDefaultBranch

GetDefaultBranch(ctx, )

Get the default branch of the repository.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetForkedRepositories

GetForkedRepositories(ctx, projectKey)

Retrieve repositories which have been forked from this one. Unlike {@link #getRelatedRepositories(Repository, PageRequest) related repositories}, this only looks at a given repository's direct forks. If those forks have themselves been the origin of more forks, such "grandchildren" repositories will not be retrieved.

Only repositories to which the authenticated user has REPO_READ permission will be included, even if other repositories have been forked from this one.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	the parent project key

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroups

GetGroups(ctx, optional)

Retrieve a page of groups.

The authenticated user must have LICENSED_USER permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupsWithAnyPermission

GetGroupsWithAnyPermission(ctx, optional)

Retrieve a page of groups that have been granted at least one global permission.

The authenticated user must have ADMIN permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupsWithAnyPermission_0

GetGroupsWithAnyPermission_0(ctx, optional)

Retrieve a page of groups that have been granted at least one permission for the specified project.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupsWithAnyPermission_1

GetGroupsWithAnyPermission_1(ctx, optional)

Retrieve a page of groups that have been granted at least one permission for the specified repository.

The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupsWithoutAnyPermission

GetGroupsWithoutAnyPermission(ctx, optional)

Retrieve a page of groups that have no granted global permissions.

The authenticated user must have ADMIN permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupsWithoutAnyPermission_0

GetGroupsWithoutAnyPermission_0(ctx, optional)

Retrieve a page of groups that have no granted permissions for the specified project.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroupsWithoutAnyPermission_1

GetGroupsWithoutAnyPermission_1(ctx, optional)

Retrieve a page of groups that have no granted permissions for the specified repository.

The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetGroups_0

GetGroups_0(ctx, optional)

Retrieve a page of group names.

The authenticated user must have PROJECT_ADMIN permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetInformation

GetInformation(ctx, )

Gets information about the nodes that currently make up the stash cluster.

The authenticated user must have the SYS_ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLatestInvocation

GetLatestInvocation(ctx, webhookId, optional)

Get the latest invocations for a specific webhook.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
webhookId	int32	id of the webhook
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
webhookId	int32	id of the webhook
event	string	the string id of a specific event to retrieve the last invocation for.
outcome	string	the outcome to filter for. Can be SUCCESS, FAILURE, ERROR. None specified means that the all will be considered

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetLevel

GetLevel(ctx, loggerName)

Retrieve the current log level for a given logger.

The authenticated user must have ADMIN permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
loggerName	string	the name of the logger.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMailConfig

GetMailConfig(ctx, )

Retrieves the current mail configuration. The authenticated user must have the SYS_ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetMergeConfig

GetMergeConfig(ctx, scmId)

Retrieve the merge strategies available for this instance.

The user must be authenticated to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
scmId	string	the id of the scm to get strategies for

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPage

GetPage(ctx, optional)

Retrieve a page of pull requests to or from the specified repository.

The authenticated user must have REPO_READ permission for the specified repository to call this resource. Optionally clients can specify PR participant filters. Each filter has a mandatory {@code username.N} parameter, and the optional {@code role.N} and {@code approved.N} parameters.

• {@code username.N} - the "root" of a single participant filter, where "N" is a natural number starting from 1. This allows clients to specify multiple participant filters, by providing consecutive filters as {@code username.1}, {@code username.2} etc. Note that the filters numbering has to start with 1 and be continuous for all filters to be processed. The total allowed number of participant filters is 10 and all filters exceeding that limit will be dropped.
• {@code role.N}(optional) the role associated with {@code username.N}. This must be one of {@code AUTHOR}, {@code REVIEWER}, or{@code PARTICIPANT}
• {@code approved.N}(optional) the approved status associated with {@code username.N}. That is whether {@code username.N} has approved the PR. Either {@code true}, or {@code false}

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
direction	string	(optional, defaults to <strong>INCOMING</strong>) the direction relative to the specified repository. Either <strong>INCOMING</strong> or <strong>OUTGOING</strong>.	[default to incoming]
at	string	(optional) a <i>fully-qualified</i> branch ID to find pull requests to or from, such as {@code refs/heads/master}
state	string	(optional, defaults to <strong>OPEN</strong>). Supply <strong>ALL</strong> to return pull request in any state. If a state is supplied only pull requests in the specified state will be returned. Either <strong>OPEN</strong>, <strong>DECLINED</strong> or <strong>MERGED</strong>.
order	string	(optional, defaults to <strong>NEWEST</strong>) the order to return pull requests in, either <strong>OLDEST</strong> (as in: &quot;oldest first&quot;) or <strong>NEWEST</strong>.
withAttributes	bool	(optional) defaults to true, whether to return additional pull request attributes	[default to true]
withProperties	bool	(optional) defaults to true, whether to return additional pull request properties	[default to true]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProject

GetProject(ctx, )

Retrieve the project matching the supplied projectKey.

The authenticated user must have PROJECT_VIEW permission for the specified project to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProjectAvatar

GetProjectAvatar(ctx, optional)

Retrieve the avatar for the project matching the supplied projectKey.

The authenticated user must have PROJECT_VIEW permission for the specified project to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
s	int32	The desired size of the image. The server will return an image as close as possible to the specified size.	[default to 0]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetProjects

GetProjects(ctx, optional)

Retrieve a page of projects.

Only projects for which the authenticated user has the PROJECT_VIEW permission will be returned.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string
permission	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPullRequestCount

GetPullRequestCount(ctx, )

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPullRequestSettings

GetPullRequestSettings(ctx, )

Retrieve the pull request settings for the context repository.

The authenticated user must have REPO_READ permission for the context repository to call this resource.

This resource will call all RestFragments that are registered with the key bitbucket.repository.settings.pullRequests. If any fragment fails validations by returning a non-empty Map of errors, then no fragments will execute.

The property keys for the settings that are bundled with the application are

• mergeConfig - the merge strategy configuration for pull requests
• requiredApprovers - (Deprecated, please use com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook instead) the number of approvals required on a pull request for it to be mergeable, or 0 if the merge check is disabled
• com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook - the merge check configuration for required approvers
• requiredAllApprovers - whether or not all approvers must approve a pull request for it to be mergeable
• requiredAllTasksComplete - whether or not all tasks on a pull request need to be completed for it to be mergeable
• requiredSuccessfulBuilds - (Deprecated, please use com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck instead) the number of successful builds on a pull request for it to be mergeable, or 0 if the merge check is disabled
• com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck - the merge check configuration for required builds

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPullRequestSettings_0

GetPullRequestSettings_0(ctx, scmId)

Retrieve the merge strategy configuration for this project and SCM.

The authenticated user must have PROJECT_READ permission for the context repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
scmId	string	the SCM to get strategies for

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPullRequestSuggestions

GetPullRequestSuggestions(ctx, optional)

Retrieves a page of suggestions for pull requests that the currently authenticated user may wish to raise. Such suggestions are based on ref changes occurring and so contain the ref change that prompted the suggestion plus the time the change event occurred. Changes will be returned in descending order based on the time the change that prompted the suggestion occurred.

Note that although the response is a page object, the interface does not support paging, however a limit can be applied to the size of the returned page.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
changesSince	string	restrict pull request suggestions to be based on events that occurred since some time in the past. This is expressed in seconds since "now". So to return suggestions based only on activity within the past 48 hours, pass a value of 172800.	[default to 172800]
limit	int32	restricts the result set to return at most this many suggestions.	[default to 3]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPullRequestTasks

GetPullRequestTasks(ctx, )

Retrieve the tasks associated with a pull request.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPullRequests

GetPullRequests(ctx, optional)

Retrieve a page of pull requests where the current authenticated user is involved as either a reviewer, author or a participant. The request may be filtered by pull request state, role or participant status.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
state	string	(optional, defaults to returning pull requests in any state). If a state is supplied only pull requests in the specified state will be returned. Either <strong>OPEN</strong>, <strong>DECLINED</strong> or <strong>MERGED</strong>. Omit this parameter to return pull request in any state.
role	string	(optional, defaults to returning pull requests for any role). If a role is supplied only pull requests where the authenticated user is a participant in the given role will be returned. Either <strong>REVIEWER</strong>, <strong>AUTHOR</strong> or <strong>PARTICIPANT</strong>.
participantStatus	string	(optional, defaults to returning pull requests with any participant status). A comma separated list of participant status. That is, one or more of <strong>UNAPPROVED</strong>, <strong>NEEDS_WORK</strong>, or <strong>APPROVED</strong>.
order	string	(optional, defaults to <strong>NEWEST</strong>) the order to return pull requests in, either <strong>OLDEST</strong> (as in: &quot;oldest first&quot;), <strong>NEWEST</strong>, <strong>PARTICIPANT_STATUS</strong>, or <strong>CLOSED_DATE</strong>. Where <strong>CLOSED_DATE</strong> is specified and the result set includes pull requests that are not in the closed state, these pull requests will appear first in the result set, followed by most recently closed pull requests.
closedSince	string	(optional, defaults to returning pull requests regardless of closed since date). Permits returning only pull requests with a closed timestamp set more recently that (now - closedSince). Units are in seconds. So for example if closed since 86400 is set only pull requests closed in the previous 24 hours will be returned.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPullRequests_0

GetPullRequests_0(ctx, optional)

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
start	int32		[default to 0]
limit	int32		[default to 25]
role	string		[default to reviewer]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRelatedRepositories

GetRelatedRepositories(ctx, projectKey)

Retrieve repositories which are related to this one. Related repositories are from the same {@link Repository#getHierarchyId() hierarchy} as this repository.

Only repositories to which the authenticated user has REPO_READ permission will be included, even if more repositories are part of this repository's hierarchy.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	the parent project key

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRepositories

GetRepositories(ctx, projectKey)

Retrieve repositories from the project corresponding to the supplied projectKey.

The authenticated user must have REPO_READ permission for the specified project to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	the parent project key

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRepositoriesRecentlyAccessed

GetRepositoriesRecentlyAccessed(ctx, optional)

Retrieve a page of recently accessed repositories for the currently authenticated user.

Repositories are ordered from most recently to least recently accessed.

Only authenticated users may call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
permission	string	(optional) if specified, it must be a valid repository permission level name and will limit the resulting repository list to ones that the requesting user has the specified permission level to. If not specified, the default <code>REPO_READ</code> permission level will be assumed.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRepositories_0

GetRepositories_0(ctx, optional)

Retrieve a page of repositories based on query parameters that control the search. See the documentation of the parameters for more details.

This resource is anonymously accessible.

Note on permissions. In absence of the {@code permission} query parameter the implicit 'read' permission is assumed. Please note that this permission is lower than the REPO_READ permission rather than being equal to it. The implicit 'read' permission for a given repository is assigned to any user that has any of the higher permissions, such as REPO_READ, as well as to anonymous users if the repository is marked as public. The important implication of the above is that an anonymous request to this resource with a permission level REPO_READ is guaranteed to receive an empty list of repositories as a result. For anonymous requests it is therefore recommended to not specify the permission parameter at all.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	(optional) if specified, this will limit the resulting repository list to ones whose name matches this parameter's value. The match will be done case-insensitive and any leading and/or trailing whitespace characters on the <code>name</code> parameter will be stripped.
projectname	string	(optional) if specified, this will limit the resulting repository list to ones whose project's name matches this parameter's value. The match will be done case-insensitive and any leading and/or trailing whitespace characters on the <code>projectname</code> parameter will be stripped.
permission	string	(optional) if specified, it must be a valid repository permission level name and will limit the resulting repository list to ones that the requesting user has the specified permission level to. If not specified, the default implicit 'read' permission level will be assumed. The currently supported explicit permission values are <tt>REPO_READ</tt>, <tt>REPO_WRITE</tt> and <tt>REPO_ADMIN</tt>.
visibility	string	(optional) if specified, this will limit the resulting repository list based on the repositories visibility. Valid values are <em>public</em> or <em>private</em>.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRepository

GetRepository(ctx, projectKey, projectKey2, repositorySlug)

Retrieve the repository matching the supplied projectKey and repositorySlug.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	the parent project key
projectKey2	string	the parent project key
repositorySlug	string	the repository slug

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRepositoryHook

GetRepositoryHook(ctx, hookKey)

Retrieve a repository hook for this repository.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRepositoryHook_0

GetRepositoryHook_0(ctx, hookKey)

Retrieve a repository hook for this project.

The authenticated user must have PROJECT_READ permission for the specified project to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRepositoryHooks

GetRepositoryHooks(ctx, optional)

Retrieve a page of repository hooks for this repository.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
type_	string	the optional type to filter by. Valid values are <code>PRE_RECEIVE</code> or <code>POST_RECEIVE</code>	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRepositoryHooks_0

GetRepositoryHooks_0(ctx, optional)

Retrieve a page of repository hooks for this project.

The authenticated user must have PROJECT_READ permission for the specified project to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
type_	string	the optional type to filter by. Valid values are <code>PRE_RECEIVE</code> or <code>POST_RECEIVE</code>	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetRootLevel

GetRootLevel(ctx, )

Retrieve the current log level for the root logger.

The authenticated user must have ADMIN permission or higher to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSenderAddress

GetSenderAddress(ctx, )

Retrieves the server email address

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSettings

GetSettings(ctx, hookKey)

Retrieve the settings for a repository hook for this repository.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetSettings_0

GetSettings_0(ctx, hookKey)

Retrieve the settings for a repository hook for this project.

The authenticated user must have PROJECT_READ permission for the specified project to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStatistics

GetStatistics(ctx, webhookId, optional)

Get the statistics for a specific webhook.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
webhookId	int32	id of the webhook
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
webhookId	int32	id of the webhook
event	string	the string id of a specific event to retrieve the last invocation for. May be empty, in which case all events are considered

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetStatisticsSummary

GetStatisticsSummary(ctx, webhookId)

Get the statistics summary for a specific webhook.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
webhookId	int32	id of the webhook

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTag

GetTag(ctx, name)

Retrieve a tag in the specified repository.

The authenticated user must have REPO_READ permission for the context repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
name	string	the name of the tag to be retrieved

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTags

GetTags(ctx, optional)

Retrieve the tags matching the supplied filterText param.

The authenticated user must have REPO_READ permission for the context repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filterText	string	the text to match on
orderBy	string	ordering of refs either ALPHABETICAL (by name) or MODIFICATION (last updated)

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetTask

GetTask(ctx, taskId)

Retrieve a existing task.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
taskId	int64	the id identifying the task to delete

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUser

GetUser(ctx, )

Retrieve the user matching the supplied userSlug.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUserSettings

GetUserSettings(ctx, )

Retrieve a map of user setting key values for a specific user identified by the user slug.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsers

GetUsers(ctx, optional)

Retrieve a page of users.

The authenticated user must have the LICENSED_USER permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only users with usernames, display name or email addresses containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsersWithAnyPermission

GetUsersWithAnyPermission(ctx, optional)

Retrieve a page of users that have been granted at least one global permission.

The authenticated user must have ADMIN permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only user names containing the supplied string will be returned	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsersWithAnyPermission_0

GetUsersWithAnyPermission_0(ctx, optional)

Retrieve a page of users that have been granted at least one permission for the specified project.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsersWithAnyPermission_1

GetUsersWithAnyPermission_1(ctx, optional)

Retrieve a page of users that have been granted at least one permission for the specified repository.

The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsersWithoutAnyPermission

GetUsersWithoutAnyPermission(ctx, optional)

Retrieve a page of users that have no granted global permissions.

The authenticated user must have ADMIN permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only user names containing the supplied string will be returned	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsersWithoutPermission

GetUsersWithoutPermission(ctx, optional)

Retrieve a page of licensed users that have no granted permissions for the specified project.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsersWithoutPermission_0

GetUsersWithoutPermission_0(ctx, optional)

Retrieve a page of licensed users that have no granted permissions for the specified repository.

The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
filter	string	if specified only group names containing the supplied string will be returned

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsers_0

GetUsers_0(ctx, )

Retrieve a page of users, optionally run through provided filters.

Only authenticated users may call this resource.

Supported Filters

Filters are provided in query parameters in a standard name=value fashion. The following filters are currently supported:

• {@code filter} - return only users, whose username, name or email address contain the {@code filter} value
• {@code group} - return only users who are members of the given group
• {@code permission} - the "root" of a permission filter, whose value must be a valid global, project, or repository permission. Additional filter parameters referring to this filter that specify the resource (project or repository) to apply the filter to must be prefixed with permission.. See the section "Permission Filters" below for more details.
• {@code permission.N} - the "root" of a single permission filter, similar to the {@code permission} parameter, where "N" is a natural number starting from 1. This allows clients to specify multiple permission filters, by providing consecutive filters as {@code permission.1}, {@code permission.2} etc. Note that the filters numbering has to start with 1 and be continuous for all filters to be processed. The total allowed number of permission filters is 50 and all filters exceeding that limit will be dropped. See the section "Permission Filters" below for more details on how the permission filters are processed.

Permission Filters

The following three sub-sections list parameters supported for permission filters (where [root] is the root permission filter name, e.g. {@code permission}, {@code permission.1} etc.) depending on the permission resource. The system determines which filter to apply (Global, Project or Repository permission) based on the [root] permission value. E.g. {@code ADMIN} is a global permission, {@code PROJECT_ADMIN} is a project permission and {@code REPO_ADMIN} is a repository permission. Note that the parameters for a given resource will be looked up in the order as they are listed below, that is e.g. for a project resource, if both {@code projectId} and {@code projectKey} are provided, the system will use {@code projectId} for the lookup.

Global permissions

The permission value under [root] is the only required and recognized parameter, as global permissions do not apply to a specific resource.

Example valid filter: permission=ADMIN.

Project permissions

• [root]- specifies the project permission
• [root].projectId - specifies the project ID to lookup the project by
• [root].projectKey - specifies the project key to lookup the project by

Example valid filter: permission.1=PROJECT_ADMIN&permission.1.projectKey=TEST_PROJECT.

Repository permissions

• [root]- specifies the repository permission
• [root].projectId - specifies the repository ID to lookup the repository by
• [root].projectKey and [root].repositorySlug- specifies the project key and repository slug to lookup the repository by; both values need to be provided for this look up to be triggered

Example valid filter: permission.2=REPO_ADMIN&permission.2.projectKey=TEST_PROJECT&permission.2.repositorySlug=test_repo.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetWebhook

GetWebhook(ctx, webhookId, optional)

Get a webhook by id.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
webhookId	int32	the existing webhook id
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
webhookId	int32	the existing webhook id
statistics	bool		[default to false]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Get_0

Get_0(ctx, pullRequestId)

Retrieve a pull request.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the ID of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HasAllUserPermission

HasAllUserPermission(ctx, permission)

Check whether the specified permission is the default permission (granted to all users) for a project.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
permission	string	the permission to grant Available project permissions are: <ul> <li>PROJECT_READ</li> <li>PROJECT_WRITE</li> <li>PROJECT_ADMIN</li> </ul>

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListParticipants

ListParticipants(ctx, pullRequestId)

Retrieves a page of the participants for a given pull request.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Merge

Merge(ctx, pullRequestId, optional)

Merge the specified pull request.

The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the ID of the pull request within the repository
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
pullRequestId	int64	the ID of the pull request within the repository
version	int32	the current version of the pull request. If the server's version isn't the same as the specified version the operation will fail. To determine the current version of the pull request it should be fetched from the server prior to this operation. Look for the 'version' attribute in the returned JSON structure.	[default to -1]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModifyAllUserPermission

ModifyAllUserPermission(ctx, permission, optional)

Grant or revoke a project permission to all users, i.e. set the default permission.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
permission	string	the permission to grant Available project permissions are: <ul> <li>PROJECT_READ</li> <li>PROJECT_WRITE</li> <li>PROJECT_ADMIN</li> </ul>
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
permission	string	the permission to grant Available project permissions are: <ul> <li>PROJECT_READ</li> <li>PROJECT_WRITE</li> <li>PROJECT_ADMIN</li> </ul>
allow	bool	<em>true</em> to grant the specified permission to all users, or <em>false</em> to revoke it

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Preview

Preview(ctx, optional)

Preview the generated html for given markdown contents.

Only authenticated users may call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
urlMode	string	(Optional) The UrlMode used when building the url. One of: ABSOLUTE, RELATIVE and CONFIGURED By default this is RELATIVE.
hardwrap	bool	(Optional) Whether the markup implementation should convert newlines to breaks. By default this is false which reflects the standard markdown specification.
htmlEscape	bool	(Optional) true if HTML should be escaped in the input markup, false otherwise.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveGroupFromUser

RemoveGroupFromUser(ctx, )

Remove a user from a group. This is very similar to groups/remove-user, but with the context and itemName attributes of the supplied request entity reversed. On the face of it this may appear redundant, but it facilitates a specific UI component in Stash.

In the request entity, the context attribute is the user and the itemName is the group.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveUserFromGroup

RemoveUserFromGroup(ctx, )

Deprecated since 2.10. Use /rest/users/remove-groups instead.

Remove a user from a group.

The authenticated user must have the ADMIN permission to call this resource.

In the request entity, the context attribute is the group and the itemName is the user.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RenameUser

RenameUser(ctx, )

Rename a user.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Reopen

Reopen(ctx, pullRequestId, optional)

Re-open a declined pull request.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
pullRequestId	int64	the id of the pull request within the repository
version	int32	the current version of the pull request. If the server's version isn't the same as the specified version the operation will fail. To determine the current version of the pull request it should be fetched from the server prior to this operation. Look for the 'version' attribute in the returned JSON structure.	[default to -1]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RetryCreateRepository

RetryCreateRepository(ctx, projectKey)

If a create or fork operation fails, calling this method will clean up the broken repository and try again. The repository must be in an INITIALISATION_FAILED state.

The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	the parent project key

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokePermissionsForGroup

RevokePermissionsForGroup(ctx, optional)

Revoke all global permissions for a group.

The authenticated user must have:

• ADMIN permission or higher; and
• greater or equal permissions than the current permission level of the group (a user may not demote the permission level of a group with higher permissions than them)

to call this resource. In addition, a user may not revoke a group's permissions if their own permission level would be reduced as a result.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the name of the group

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokePermissionsForGroup_0

RevokePermissionsForGroup_0(ctx, optional)

Revoke all permissions for the specified project for a group.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.

In addition, a user may not revoke a group's permissions if it will reduce their own permission level.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the name of the group

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokePermissionsForGroup_1

RevokePermissionsForGroup_1(ctx, optional)

Revoke all permissions for the specified repository for a group.

The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.

In addition, a user may not revoke a group's permissions if it will reduce their own permission level.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the name of the group

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokePermissionsForUser

RevokePermissionsForUser(ctx, optional)

Revoke all global permissions for a user.

The authenticated user must have:

• ADMIN permission or higher; and
• greater or equal permissions than the current permission level of the user (a user may not demote the permission level of a user with higher permissions than them)

to call this resource. In addition, a user may not demote their own permission level.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the name of the user

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokePermissionsForUser_0

RevokePermissionsForUser_0(ctx, optional)

Revoke all permissions for the specified project for a user.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource.

In addition, a user may not revoke their own project permissions if they do not have a higher global permission.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the name of the user

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RevokePermissionsForUser_1

RevokePermissionsForUser_1(ctx, optional)

Revoke all permissions for the specified repository for a user.

The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource.

In addition, a user may not revoke their own repository permissions if they do not have a higher project or global permission.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the name of the user

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Search

Search(ctx, optional)

Retrieve a page of participant users for all the pull requests to or from the specified repository.

Optionally clients can specify following filters.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
direction	string	(optional, defaults to <strong>INCOMING</strong>) the direction relative to the specified repository. Either <strong>INCOMING</strong> or <strong>OUTGOING</strong>.	[default to incoming]
filter	string	(optional) return only users, whose username, name or email address <i>contain</i> the {@code filter} value
role	string	(optional) The role associated with the pull request participant. This must be one of {@code AUTHOR}, {@code REVIEWER}, or{@code PARTICIPANT}

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetDefaultBranch

SetDefaultBranch(ctx, )

Update the default branch of a repository.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetLevel

SetLevel(ctx, levelName, loggerName)

Set the current log level for a given logger.

The authenticated user must have ADMIN permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
levelName	string	the level to set the logger to. Either TRACE, DEBUG, INFO, WARN or ERROR
loggerName	string	the name of the logger.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetMailConfig

SetMailConfig(ctx, )

Updates the mail configuration The authenticated user must have the SYS_ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetMergeConfig

SetMergeConfig(ctx, scmId)

Update the pull request merge strategies for the context repository.

The authenticated user must have ADMIN permission for the context repository to call this resource.

Only the strategies provided will be enabled, only one may be set to default

An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty "mergeConfig" attribute. i.e:

  {      "mergeConfig": {      }  }  

Upon completion of this request, the effective configuration will be the default configuration.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
scmId	string	the id of the scm to get strategies for

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetPermissionForGroup

SetPermissionForGroup(ctx, optional)

Promote or demote a group's permission level for the specified repository. Available repository permissions are:

• REPO_READ
• REPO_WRITE
• REPO_ADMIN

See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Using+repository+permissions">Bitbucket Server documentation for a detailed explanation of what each permission entails.

The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource. In addition, a user may not demote a group's permission level if their own permission level would be reduced as a result.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
permission	string	the permission to grant
name	string	the names of the groups

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetPermissionForGroups

SetPermissionForGroups(ctx, optional)

Promote or demote a user's global permission level. Available global permissions are:

• LICENSED_USER
• PROJECT_CREATE
• ADMIN
• SYS_ADMIN

See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Global+permissions">Bitbucket Server documentation for a detailed explanation of what each permission entails.

The authenticated user must have:

• ADMIN permission or higher; and
• the permission they are attempting to grant or higher; and
• greater or equal permissions than the current permission level of the group (a user may not demote the permission level of a group with higher permissions than them)

to call this resource. In addition, a user may not demote a group's permission level if their own permission level would be reduced as a result.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
permission	string	the permission to grant
name	string	the names of the groups

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetPermissionForGroups_0

SetPermissionForGroups_0(ctx, optional)

Promote or demote a group's permission level for the specified project.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource. In addition, a user may not demote a group's permission level if their own permission level would be reduced as a result.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
permission	string	The permission to grant. See the permissions documentation for a detailed explanation of what each permission entails. Available project permissions are: <ul> <li>PROJECT_READ</li> <li>PROJECT_WRITE</li> <li>PROJECT_ADMIN</li> </ul>
name	string	the names of the groups

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetPermissionForUser

SetPermissionForUser(ctx, optional)

Promote or demote a user's permission level for the specified repository. Available repository permissions are:

• REPO_READ
• REPO_WRITE
• REPO_ADMIN

See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Using+repository+permissions">Bitbucket Server documentation for a detailed explanation of what each permission entails.

The authenticated user must have REPO_ADMIN permission for the specified repository or a higher project or global permission to call this resource. In addition, a user may not reduce their own permission level unless they have a project or global permission that already implies that permission.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the names of the users
permission	string	the permission to grant

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetPermissionForUsers

SetPermissionForUsers(ctx, optional)

Promote or demote the global permission level of a user. Available global permissions are:

• LICENSED_USER
• PROJECT_CREATE
• ADMIN
• SYS_ADMIN

See the <a href="https://confluence.atlassian.com/display/BitbucketServer/Global+permissions">Bitbucket Server documentation for a detailed explanation of what each permission entails.

The authenticated user must have:

• ADMIN permission or higher; and
• the permission they are attempting to grant; and
• greater or equal permissions than the current permission level of the user (a user may not demote the permission level of a user with higher permissions than them)

to call this resource. In addition, a user may not demote their own permission level.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the names of the users
permission	string	the permission to grant

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetPermissionForUsers_0

SetPermissionForUsers_0(ctx, optional)

Promote or demote a user's permission level for the specified project.

The authenticated user must have PROJECT_ADMIN permission for the specified project or a higher global permission to call this resource. In addition, a user may not reduce their own permission level unless they have a global permission that already implies that permission.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
name	string	the names of the users
permission	string	the permission to grant. See the permissions documentation for a detailed explanation of what each permission entails. Available project permissions are: <ul> <li>PROJECT_READ</li> <li>PROJECT_WRITE</li> <li>PROJECT_ADMIN</li> </ul>

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetRootLevel

SetRootLevel(ctx, levelName)

Set the current log level for the root logger.

The authenticated user must have ADMIN permission or higher to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
levelName	string	the level to set the logger to. Either TRACE, DEBUG, INFO, WARN or ERROR

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetSenderAddress

SetSenderAddress(ctx, )

Updates the server email address The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetSettings

SetSettings(ctx, hookKey)

Modify the settings for a repository hook for this repository.

The service will reject any settings which are too large, the current limit is 32KB once serialized.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

A JSON document can be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetSettings_0

SetSettings_0(ctx, hookKey)

Modify the settings for a repository hook for this project.

The service will reject any settings which are too large, the current limit is 32KB once serialized.

The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.

A JSON document can be provided to use as the settings for the hook. These structure and validity of the document is decided by the plugin providing the hook.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
hookKey	string

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Stream

Stream(ctx, optional)

Streams files in the requested path with the last commit to modify each file. Commit modifications are traversed starting from the at commit or, if not specified, from the tip of the default branch.

Unless the repository is public, the authenticated user must have REPO_READ access to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
at	string	the commit to use as the starting point when listing files and calculating modifications

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamChanges

StreamChanges(ctx, optional)

Gets the file changes available in the {@code from} commit but not in the {@code to} commit.

If either the {@code from} or {@code to} commit are not specified, they will be replaced by the default branch of their containing repository.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
from	string	the source commit (can be a partial/full commit ID or qualified/unqualified ref name)
to	string	the target commit (can be a partial/full commit ID or qualified/unqualified ref name)
fromRepo	string	an optional parameter specifying the source repository containing the source commit if that commit is not present in the current repository; the repository can be specified by either its ID <em>fromRepo=42</em> or by its project key plus its repo slug separated by a slash: <em>fromRepo=projectKey/repoSlug</em>	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamChanges_0

StreamChanges_0(ctx, optional)

Gets changes for the specified PullRequest.

If the {@code changeScope} query parameter is set to {@code unreviewed}, the application will attempt to stream unreviewed changes based on the {@code lastReviewedCommit} of the current user, which are the changes between the {@code lastReviewedCommit} and the latest commit of the source branch. The current user is considered to not have any unreviewed changes for the pull request when the {@code lastReviewedCommit} is either {@code null} (everything is unreviewed, so all changes are streamed), equal to the latest commit of the source branch (everything is reviewed), or no longer on the source branch (the source branch has been rebased). In these cases, the application will fall back to streaming all changes (the default), which is the effective diff for the pull request. The type of changes streamed can be determined by the {@code changeScope} parameter included in the properties map of the response.

Note: This resource is currently not paged. The server will return at most one page. The server will truncate the number of changes to either the request's page limit or an internal maximum, whichever is smaller. The start parameter of the page request is also ignored.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
changeScope	string	{@code UNREVIEWED} to stream the unreviewed changes for the current user (if they exist); {@code RANGE} to stream changes between two arbitrary commits (requires {@code sinceId} and {@code untilId}); otherwise {@code ALL} to stream all changes (the default)	[default to ALL]
sinceId	string	the since commit hash to stream changes for a {@code RANGE} arbitrary change scope
untilId	string	the until commit hash to stream changes for a {@code RANGE} arbitrary change scope
withComments	bool	{@code true} to apply comment counts in the changes (the default); otherwise, {@code false} to stream changes without comment counts	[default to true]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamCommits

StreamCommits(ctx, optional)

Gets the commits accessible from the {@code from} commit but not in the {@code to} commit.

If either the {@code from} or {@code to} commit are not specified, they will be replaced by the default branch of their containing repository.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
from	string	the source commit (can be a partial/full commit ID or qualified/unqualified ref name)
to	string	the target commit (can be a partial/full commit ID or qualified/unqualified ref name)
fromRepo	string	an optional parameter specifying the source repository containing the source commit if that commit is not present in the current repository; the repository can be specified by either its ID <em>fromRepo=42</em> or by its project key plus its repo slug separated by a slash: <em>fromRepo=projectKey/repoSlug</em>	[default to ]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamDiff

StreamDiff(ctx, commitId, optional)

Retrieve the diff between two provided revisions.

Note: This resource is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded. In the event that the cap is reached, the diff will be cut short and one or more {@code truncated} flags will be set to {@code true} on the {@code "segments"}, {@code "hunks"} and {@code "diffs"} properties, as well as the top-level object, in the returned JSON response.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
commitId	string
autoSrcPath	bool	{@code true} to automatically try to find the source path when it's not provided, {@code false} otherwise. Requires the {@code path} to be provided.	[default to false]
contextLines	int32	the number of context lines to include around added/removed lines in the diff	[default to -1]
since	string	the base revision to diff from. If omitted the parent revision of the until revision is used
srcPath	string	the source path for the file, if it was copied, moved or renamed
whitespace	string	optional whitespace flag which can be set to {@code ignore-all}
withComments	bool	{@code true} to embed comments in the diff (the default); otherwise {@code false} to stream the diff without comments	[default to true]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamDiff_0

StreamDiff_0(ctx, commitId, path, commitId2, optional)

Retrieve the diff between two provided revisions.

Note: This resource is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded. In the event that the cap is reached, the diff will be cut short and one or more {@code truncated} flags will be set to {@code true} on the {@code "segments"}, {@code "hunks"} and {@code "diffs"} properties, as well as the top-level object, in the returned JSON response.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string
path	string	the path to the file which should be diffed (optional)
commitId2	string
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
commitId	string
path	string	the path to the file which should be diffed (optional)
commitId2	string
autoSrcPath	bool	{@code true} to automatically try to find the source path when it's not provided, {@code false} otherwise. Requires the {@code path} to be provided.	[default to false]
contextLines	int32	the number of context lines to include around added/removed lines in the diff	[default to -1]
since	string	the base revision to diff from. If omitted the parent revision of the until revision is used
srcPath	string	the source path for the file, if it was copied, moved or renamed
whitespace	string	optional whitespace flag which can be set to {@code ignore-all}
withComments	bool	{@code true} to embed comments in the diff (the default); otherwise {@code false} to stream the diff without comments	[default to true]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamDiff_1

StreamDiff_1(ctx, path, optional)

Gets a diff of the changes available in the {@code from} commit but not in the {@code to} commit.

If either the {@code from} or {@code to} commit are not specified, they will be replaced by the default branch of their containing repository.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
path	string	the path to the file to diff (optional)
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
path	string	the path to the file to diff (optional)
from	string	the source commit (can be a partial/full commit ID or qualified/unqualified ref name)
to	string	the target commit (can be a partial/full commit ID or qualified/unqualified ref name)
fromRepo	string	an optional parameter specifying the source repository containing the source commit if that commit is not present in the current repository; the repository can be specified by either its ID <em>fromRepo=42</em> or by its project key plus its repo slug separated by a slash: <em>fromRepo=projectKey/repoSlug</em>	[default to ]
srcPath	string
contextLines	int32	an optional number of context lines to include around each added or removed lines in the diff	[default to -1]
whitespace	string	an optional whitespace flag which can be set to <code>ignore-all</code>

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamDiff_2

StreamDiff_2(ctx, optional)

Retrieve the diff for a specified file path between two provided revisions.

Note: This resource is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded. In the event that the cap is reached, the diff will be cut short and one or more truncated flags will be set to true on the segments, hunks and diffs substructures in the returned JSON response.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
contextLines	int32	the number of context lines to include around added/removed lines in the diff	[default to -1]
since	string	the base revision to diff from. If omitted the parent revision of the until revision is used
srcPath	string	the source path for the file, if it was copied, moved or renamed
until	string	the target revision to diff to (required)
whitespace	string	optional whitespace flag which can be set to <code>ignore-all</code>

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamDiff_3

StreamDiff_3(ctx, path, optional)

Retrieve the diff for a specified file path between two provided revisions.

Note: This resource is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded. In the event that the cap is reached, the diff will be cut short and one or more truncated flags will be set to true on the segments, hunks and diffs substructures in the returned JSON response.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
path	string	the path to the file which should be diffed (required)
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
path	string	the path to the file which should be diffed (required)
contextLines	int32	the number of context lines to include around added/removed lines in the diff	[default to -1]
since	string	the base revision to diff from. If omitted the parent revision of the until revision is used
srcPath	string	the source path for the file, if it was copied, moved or renamed
until	string	the target revision to diff to (required)
whitespace	string	optional whitespace flag which can be set to <code>ignore-all</code>

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamDiff_4

StreamDiff_4(ctx, optional)

Streams a diff within a pull request.

If the specified file has been copied, moved or renamed, the srcPath must also be specified to produce the correct diff.

Note: This RESTful endpoint is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
contextLines	int32	the number of context lines to include around added/removed lines in the diff	[default to -1]
diffType	string	the type of diff being requested. When {@code withComments} is {@code true} this works as a hint to the system to attach the correct set of comments to the diff	[default to EFFECTIVE]
sinceId	string	the since commit hash to stream a diff between two arbitrary hashes
srcPath	string	the previous path to the file, if the file has been copied, moved or renamed
untilId	string	the until commit hash to stream a diff between two arbitrary hashes
whitespace	string	optional whitespace flag which can be set to <code>ignore-all</code>
withComments	bool	<code>true</code> to embed comments in the diff (the default); otherwise, <code>false</code> to stream the diff without comments	[default to true]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamDiff_5

StreamDiff_5(ctx, path, optional)

Streams a diff within a pull request.

If the specified file has been copied, moved or renamed, the srcPath must also be specified to produce the correct diff.

Note: This RESTful endpoint is currently not paged. The server will internally apply a hard cap to the streamed lines, and it is not possible to request subsequent pages if that cap is exceeded.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
path	string	the path to the file which should be diffed (optional)
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
path	string	the path to the file which should be diffed (optional)
contextLines	int32	the number of context lines to include around added/removed lines in the diff	[default to -1]
diffType	string	the type of diff being requested. When {@code withComments} is {@code true} this works as a hint to the system to attach the correct set of comments to the diff	[default to EFFECTIVE]
sinceId	string	the since commit hash to stream a diff between two arbitrary hashes
srcPath	string	the previous path to the file, if the file has been copied, moved or renamed
untilId	string	the until commit hash to stream a diff between two arbitrary hashes
whitespace	string	optional whitespace flag which can be set to <code>ignore-all</code>
withComments	bool	<code>true</code> to embed comments in the diff (the default); otherwise, <code>false</code> to stream the diff without comments	[default to true]

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamFiles

StreamFiles(ctx, optional)

Retrieve a page of files from particular directory of a repository. The search is done recursively, so all files from any sub-directory of the specified directory will be returned.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
at	string	the commit ID or ref (e.g. a branch or tag) to list the files at. If not specified the default branch will be used instead.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

StreamFiles_0

StreamFiles_0(ctx, path, optional)

Retrieve a page of files from particular directory of a repository. The search is done recursively, so all files from any sub-directory of the specified directory will be returned.

The authenticated user must have REPO_READ permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
path	string	the directory to list files for.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
path	string	the directory to list files for.
at	string	the commit ID or ref (e.g. a branch or tag) to list the files at. If not specified the default branch will be used instead.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Stream_0

Stream_0(ctx, path, optional)

Streams files in the requested path with the last commit to modify each file. Commit modifications are traversed starting from the at commit or, if not specified, from the tip of the default branch.

Unless the repository is public, the authenticated user must have REPO_READ access to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
path	string	the path within the repository whose files should be streamed
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
path	string	the path within the repository whose files should be streamed
at	string	the commit to use as the starting point when listing files and calculating modifications

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

TestWebhook

TestWebhook(ctx, optional)

Test connectivity to a specific endpoint.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
url	string	the url in which to connect to

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnassignParticipantRole

UnassignParticipantRole(ctx, pullRequestId, optional)

Unassigns a participant from the REVIEWER role they may have been given in a pull request.

If the participant has no explicit role this method has no effect.

Afterwards, the user will still remain a participant in the pull request but their role will be reduced to PARTICIPANT. This is because once made a participant of a pull request, a user will forever remain a participant. Only their role may be altered.

The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.

Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository
optional	map[string]interface{}	optional parameters	nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name	Type	Description	Notes
pullRequestId	int64	the id of the pull request within the repository
username	string	the participant's user name

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UnassignParticipantRole_0

UnassignParticipantRole_0(ctx, pullRequestId, userSlug, pullRequestId2)

Unassigns a participant from the REVIEWER role they may have been given in a pull request.

If the participant has no explicit role this method has no effect.

Afterwards, the user will still remain a participant in the pull request but their role will be reduced to PARTICIPANT. This is because once made a participant of a pull request, a user will forever remain a participant. Only their role may be altered.

The authenticated user must have REPO_WRITE permission for the repository that this pull request targets to call this resource.

Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository
userSlug	string	the slug for the user changing their status
pullRequestId2	int64	the id of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Unwatch

Unwatch(ctx, commitId)

Removes the authenticated user as a watcher for the specified commit.

The authenticated user must have REPO_READ permission for the repository containing the commit to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string	the <i>full {@link Commit#getId() ID}</i> of the commit within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Unwatch_0

Unwatch_0(ctx, pullRequestId)

Make the authenticated user stop watching the specified pull request.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update

Update(ctx, )

Decodes the provided encoded license and sets it as the active license. If no license was provided, a 400 is returned. If the license cannot be decoded, or cannot be applied, a 409 is returned. Some possible reasons a license may not be applied include:

• It is for a different product
• It is already expired

Otherwise, if the license is updated successfully, details for the new license are returned with a 200 response.

Warning: It is possible to downgrade the license during update, applying a license with a lower number of permitted users. If the number of currently-licensed users exceeds the limits of the new license, pushing will be disabled until the licensed user count is brought into compliance with the new license.

The authenticated user must have SYS_ADMIN permission. ADMIN users may view the current license details, but they may not update the license.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatePullRequestComment

UpdatePullRequestComment(projectKey, repositorySlug, pullRequestID, commentId, updateCommentRequest)

Update the text of a comment. Only the user who created a comment may update it.

Note: the supplied supplied JSON object must contain a version that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure.

The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.

Required Parameters

Name	Type	Description	Notes
projectKey	string	The project key
repositorySlug	string	The repository slug.
pullRequestId	int	The ID of the pull request within the repository
commentId	int	The ID the comment
updateCommentRequest	UpdatePullRequestCommentRequest	The update comment request body

Return type

RestComment

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateComment

UpdateComment(ctx, commitId, commentId, commitId2)

Update the text of a comment. Only the user who created a comment may update it.

Note: the supplied supplied JSON object must contain a version that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure.

The authenticated user must have REPO_READ permission for the repository that the commit is in to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string	the commit to which the comments must be anchored
commentId	int64	the ID of the comment to retrieve
commitId2	string	the <i>full {@link Commit#getId() ID}</i> of the commit within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateComment_0

UpdateComment_0(ctx, commentId)

Update the text of a comment. Only the user who created a comment may update it.

Note: the supplied supplied JSON object must contain a version that must match the server's version of the comment or the update will fail. To determine the current version of the comment, the comment should be fetched from the server prior to the update. Look for the 'version' attribute in the returned JSON structure.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commentId	int64	the id of the comment to retrieve

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateProject

UpdateProject(ctx, )

Update the project matching the projectKey supplied in the resource path.

To include a custom avatar for the updated project, the project definition should contain an additional attribute with the key avatar and the value a data URI containing Base64-encoded image data. The URI should be in the following format: data:(content type, e.g. image/png);base64,(data) If the data is not Base64-encoded, or if a character set is defined in the URI, or the URI is otherwise invalid, project creation will fail.

The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatePullRequest

UpdatePullRequest(ctx, &EditPullRequestOptions{} )

Update the title, description, reviewers or destination branch of an existing pull request..

The authenticated user must have REPO_ADMIN permission for the context repository to call this resource.

This resource will call all RestFragments that are registered with the key bitbucket.repository.settings.pullRequests.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	The project key
pullRequestId	string	The ID of the pull request within the repository
repositorySlug	string	The repository slug.

Return type

RestPullRequest

Authorization

Authorization is required.

HTTP request headers

• Content-Type: application/json
• Accept: Not defined

UpdatePullRequestSettings

UpdatePullRequestSettings(ctx, )

Update the pull request settings for the context repository.

The authenticated user must have REPO_ADMIN permission for the context repository to call this resource.

This resource will call all RestFragments that are registered with the key bitbucket.repository.settings.pullRequests. If any fragment fails validations by returning a non-empty Map of errors, then no fragments will execute.

Only the settings that should be updated need to be included in the request.

The property keys for the settings that are bundled with the application are

• mergeConfig - the merge strategy configuration for pull requests
• requiredApprovers - (Deprecated, please use com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook instead) the number of approvals required on a pull request for it to be mergeable, or 0 to disable the merge check
• com.atlassian.bitbucket.server.bundled-hooks.requiredApproversMergeHook - a json map containing the keys 'enabled' (a boolean to enable or disable this merge check) and 'count' (an integer to set the number of required approvals)
• requiredAllApprovers - whether or not all approvers must approve a pull request for it to be mergeable
• requiredAllTasksComplete - whether or not all tasks on a pull request need to be completed for it to be mergeable
• requiredSuccessfulBuilds - (Deprecated, please use com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck instead) the number of successful builds on a pull request for it to be mergeable, or 0 to disable the merge check
• com.atlassian.bitbucket.server.bitbucket-build.requiredBuildsMergeCheck - a json map containing the keys 'enabled' (a boolean to enable or disable this merge check) and 'count' (an integer to set the number of required builds)
Merge strategy configuration deletion:

An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty "mergeConfig" attribute. i.e:

  {      "mergeConfig": {      }  }  

Upon completion of this request, the effective configuration will be:
• The configuration set for this repository's SCM type as set at the project level, if present, otherwise
• the configuration set for this repository's SCM type as set at the instance level, if present, otherwise
• the default configuration for this repository's SCM type

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdatePullRequestSettings_0

UpdatePullRequestSettings_0(ctx, scmId)

Update the pull request merge strategy configuration for this project and SCM.

The authenticated user must have PROJECT_ADMIN permission for the context repository to call this resource.

Only the strategies provided will be enabled, the default must be set and included in the set of strategies.

An explicitly set pull request merge strategy configuration can be deleted by POSTing a document with an empty "mergeConfig" attribute. i.e:

  {      "mergeConfig": {      }  }  

Upon completion of this request, the effective configuration will be the configuration explicitly set for the SCM, or if no such explicit configuration is set then the default configuration will be used.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
scmId	string	the SCM to get strategies for

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateRepository

UpdateRepository(ctx, projectKey, projectKey2, repositorySlug)

Update the repository matching the repositorySlug supplied in the resource path.

The repository's slug is derived from its name. If the name changes the slug may also change.

This API can be used to move the repository to a different project by setting the new project in the request, example: {@code {"project":{"key":"NEW_KEY"}}} .

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
projectKey	string	the parent project key
projectKey2	string	the parent project key
repositorySlug	string	the repository slug

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateSettings

UpdateSettings(ctx, )

Update the entries of a map of user setting key/values for a specific user identified by the user slug.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateStatus

UpdateStatus(ctx, pullRequestId, userSlug, pullRequestId2)

Change the current user's status for a pull request. Implicitly adds the user as a participant if they are not already. If the current user is the author, this method will fail.

The possible values for {@code status} are UNAPPROVED, NEEDS_WORK, or APPROVED.

If the new {@code status} is NEEDS_WORK or APPROVED then the {@code lastReviewedCommit} for the participant will be updated to the latest commit of the source branch of the pull request.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository
userSlug	string	the slug for the user changing their status
pullRequestId2	int64	the id of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateTask

UpdateTask(ctx, taskId)

Update a existing task.

As of Stash 3.3, only the state and text of a task can be updated.

Updating the state of a task is allowed for any user having READ access to the repository. However only the task's creator, the context's author or an admin of the context's repository can update the task's text. (For a pull request task, those are the task's creator, the pull request's author or an admin on the repository containing the pull request). Additionally the task's text cannot be updated if it has been resolved.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
taskId	int64	the id identifying the task to delete

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUserDetails

UpdateUserDetails(ctx, )

Update a user's details.

The authenticated user must have the ADMIN permission to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUserDetails_0

UpdateUserDetails_0(ctx, )

Update the currently authenticated user's details. The update will always be applied to the currently authenticated user.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUserPassword

UpdateUserPassword(ctx, )

Update a user's password.

The authenticated user must have the ADMIN permission to call this resource, and may not update the password of a user with greater permissions than themselves.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateUserPassword_0

UpdateUserPassword_0(ctx, )

Update the currently authenticated user's password.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateWebhook

UpdateWebhook(ctx, webhookId)

Update an existing webhook.

The authenticated user must have REPO_ADMIN permission for the specified repository to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
webhookId	int32	the existing webhook id

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Update_0

Update_0(ctx, pullRequestId)

Update the title, description, reviewers or destination branch of an existing pull request.

Note: the reviewers list may be updated using this resource. However the author and participants list may not.

The authenticated user must either:

• be the author of the pull request and have the REPO_READ permission for the repository that this pull request targets; or
• have the REPO_WRITE permission for the repository that this pull request targets
to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the ID of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UploadAvatar

UploadAvatar(ctx, )

Update the avatar for the project matching the supplied projectKey.

This resource accepts POST multipart form data, containing a single image in a form-field named 'avatar'.

There are configurable server limits on both the dimensions (1024x1024 pixels by default) and uploaded file size (1MB by default). Several different image formats are supported, but PNG and JPEG are preferred due to the file size limit.

This resource has Cross-Site Request Forgery (XSRF) protection. To allow the request to pass the XSRF check the caller needs to send an X-Atlassian-Token HTTP header with the value no-check.

An example <a href="http://curl.haxx.se/">curl request to upload an image name 'avatar.png' would be:

  curl -X POST -u username:password -H "X-Atlassian-Token: no-check" http://example.com/rest/api/1.0/projects/STASH/avatar.png -F avatar=@avatar.png  

The authenticated user must have PROJECT_ADMIN permission for the specified project to call this resource.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UploadAvatar_0

UploadAvatar_0(ctx, )

Update the avatar for the user with the supplied slug.

This resource accepts POST multipart form data, containing a single image in a form-field named 'avatar'.

There are configurable server limits on both the dimensions (1024x1024 pixels by default) and uploaded file size (1MB by default). Several different image formats are supported, but PNG and JPEG are preferred due to the file size limit.

This resource has Cross-Site Request Forgery (XSRF) protection. To allow the request to pass the XSRF check the caller needs to send an X-Atlassian-Token HTTP header with the value no-check.

An example <a href="http://curl.haxx.se/">curl request to upload an image name 'avatar.png' would be:

  curl -X POST -u username:password -H "X-Atlassian-Token: no-check" http://example.com/rest/api/latest/users/jdoe/avatar.png -F avatar=@avatar.png  

Users are always allowed to update their own avatar. To update someone else's avatar the authenticated user must have global ADMIN permission, or global SYS_ADMIN permission to update a SYS_ADMIN user's avatar.

Required Parameters

This endpoint does not need any parameter.

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Watch

Watch(ctx, commitId)

Adds the authenticated user as a watcher for the specified commit.

The authenticated user must have REPO_READ permission for the repository containing the commit to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
commitId	string	the <i>full {@link Commit#getId() ID}</i> of the commit within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Watch_0

Watch_0(ctx, pullRequestId)

Make the authenticated user watch the specified pull request.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

WithdrawApproval

WithdrawApproval(ctx, pullRequestId)

Remove approval from a pull request as the current user. This does not remove the user as a participant.

The authenticated user must have REPO_READ permission for the repository that this pull request targets to call this resource.

Deprecated since 4.2. Use /rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/pull-requests/{pullRequestId}/participants/{userSlug} instead

Required Parameters

Name	Type	Description	Notes
ctx	context.Context	context for logging, tracing, authentication, etc.
pullRequestId	int64	the id of the pull request within the repository

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]