REST Resources Provided By: Bitbucket Server - REST

GET

/rest/api/1.0/admin/users?filter

This is a paged API.

Retrieve a page of users.

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

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL","directoryName":"Bitbucket Internal Directory","deletable":true,"lastAuthenticationTimestamp":1368145580548,"mutableDetails":true,"mutableGroups":true}],"start":0}

  A page of users.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not a licensed user.

PUT

Update a user's details.

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

Example request representations:

• application/json [expand]

  Example

  {"name":"jcitizen","displayName":"Jane Citizen","email":"jane@example.com"}

Example response representations:

• 200 - application/json (detailedUser) [expand]

  Example

  {"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL","directoryName":"Bitbucket Internal Directory","deletable":true,"lastAuthenticationTimestamp":1368145580548,"mutableDetails":true,"mutableGroups":true}

  The updated user.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission or has a lower permission level than the user being deleted.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user does not exist.

POST

/rest/api/1.0/admin/users?name&password&displayName&emailAddress&addToDefaultGroup&notify

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.

request query parameters

Example response representations:

• 204 [expand]

  The user was successfully created.

• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user is not an administrator.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  Adding the user to the default group would exceed the server's license limit.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  Another user with the same name already exists.

DELETE

/rest/api/1.0/admin/users?name

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.

request query parameters

Example response representations:

• 200 - application/json (detailedUser) [expand]

  Example

  {"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL","directoryName":"Bitbucket Internal Directory","deletable":true,"lastAuthenticationTimestamp":1368145580548,"mutableDetails":true,"mutableGroups":true}

  The deleted user.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as the authenticated user has a lower permission level than the user being deleted.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as a user can not delete themselves.

PUT

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.

Example request representations:

• application/json [expand]

  Example

  {"password":"secret","passwordConfirm":"secret","name":"jcitizen"}

Example response representations:

• 204 [expand]

  The user's password was successfully updated.

• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission or has a lower permission level than the user being deleted.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user does not exist.

POST

Rename a user.

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

Example request representations:

• application/json [expand]

  Example

  {"name":"jcitizen","newName":"jcitizen-new"}

Example response representations:

• 200 - application/json (detailedUser) [expand]

  Example

  {"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL","directoryName":"Bitbucket Internal Directory","deletable":true,"lastAuthenticationTimestamp":1368145580548,"mutableDetails":true,"mutableGroups":true}

  The renamed user.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission or has a lower permission level than the user being deleted.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user does not exist.

DELETE

/rest/api/1.0/admin/users/captcha?name

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.

request query parameters

Example response representations:

• 204 - application/json [expand]

  The CAPTCHA was successfully cleared.

• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as the authenticated user has a lower permission level than the group being deleted.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user does not exist.

DELETE

/rest/api/1.0/admin/groups?name

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.

request query parameters

Example response representations:

• 200 - application/json (detailedGroup) [expand]

  Example

  {"name":"group-a","deletable":true}

  The deleted group.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as the authenticated user has a lower permission level than the group being deleted.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified group does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would lower the authenticated user's permission level.

GET

/rest/api/1.0/admin/groups?filter

This is a paged API.

Retrieve a page of groups.

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

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"group-a","deletable":true}],"start":0}

  A page of groups.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not a licensed user.

POST

/rest/api/1.0/admin/groups?name

Create a new group.

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

request query parameters

Example response representations:

• 200 - application/json (restDetailedGroup) [expand]

  Example

  {"name":"group-a","deletable":true}

  The newly created group.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not an administrator.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  A group with this name already exists.

POST

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.

Example request representations:

• application/json [expand]

  Example

  {"context":"group_a","itemName":"user_a"}

Example response representations:

• 200 [expand]

  The user was added to the group

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would exceed the server's licensing limit, or the groups permissions exceed the authenticated user's permission level.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user or group does not exist.

POST

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.

Example request representations:

• application/json [expand]

  Example

  {"context":"user_a","itemName":"group_a"}

Example response representations:

• 200 [expand]

  The user was added to the group

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would exceed the server's licensing limit, or the groups permissions exceed the authenticated user's permission level.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user or group does not exist.

POST

Add multiple users to a group.

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

Example request representations:

• application/json [expand]

  Example

  {"group":"group","users":["user1","user2"]}

Example response representations:

• 200 [expand]

  >All

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would exceed the server's licensing limit, or the group's permissions exceed the authenticated user's permission level.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified group or users do not exist.

POST

Add a user to one or more groups.

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

Example request representations:

• application/json [expand]

  Example

  {"user":"user","groups":["group_a","group_b"]}

Example response representations:

• 200 [expand]

  The user was added to all the groups

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would exceed the server's licensing limit, or the groups permissions exceed the authenticated user's permission level.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user or groups do not exist.

POST

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.

Example request representations:

• application/json [expand]

  Example

  {"context":"group_a","itemName":"user_a"}

Example response representations:

• 200 [expand]

  The user was removed from the group.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as the group has a higher permission level than the context user.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user or group does not exist.

POST

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.

Example request representations:

• application/json [expand]

  Example

  {"context":"user_a","itemName":"group_a"}

Example response representations:

• 200 [expand]

  The user was removed from the group.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The authenticated user does not have the ADMIN permission.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as the group has a higher permission level than the context user.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user or group does not exist.

GET

/rest/api/1.0/admin/groups/more-members?context&filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL","directoryName":"Bitbucket Internal Directory","deletable":true,"lastAuthenticationTimestamp":1368145580548,"mutableDetails":true,"mutableGroups":true}],"start":0}

  A page of users.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not a licensed user.

GET

/rest/api/1.0/admin/groups/more-non-members?context&filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL","directoryName":"Bitbucket Internal Directory","deletable":true,"lastAuthenticationTimestamp":1368145580548,"mutableDetails":true,"mutableGroups":true}],"start":0}

  A page of users.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not a licensed user.

GET

/rest/api/1.0/admin/users/more-members?context&filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"group-a","deletable":true}],"start":0}

  A page of groups.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not a licensed user.

GET

/rest/api/1.0/admin/users/more-non-members?context&filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"group-a","deletable":true}],"start":0}

  A page of groups.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not a licensed user.

GET

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.

Example response representations:

• 200 - application/json [expand]

  Example

  {"localNode":{"id":"d4fde8b1-2504-4998-a0ba-14fbe98edd4d","name":"foo","address":{"hostName":"foo","port":5000},"local":true},"nodes":[{"id":"d4fde8b1-2504-4998-a0ba-14fbe98edd4d","name":"foo","address":{"hostName":"foo","port":5000},"local":true},{"id":"73518909-8e86-445b-8345-fcbf2e0934b6","name":"bar","address":{"hostName":"bar","port":5001},"local":true}],"running":true}

  Information about the cluster

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve the cluster information.

GET

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.

Example response representations:

• 200 - application/json (license) [expand]

  Example

  {"creationDate":1331038800000,"purchaseDate":1331038800000,"expiryDate":1372493732817,"numberOfDaysBeforeExpiry":0,"maintenanceExpiryDate":1372493732817,"numberOfDaysBeforeMaintenanceExpiry":0,"gracePeriodEndDate":1372493732817,"numberOfDaysBeforeGracePeriodExpiry":0,"maximumNumberOfUsers":12,"unlimitedNumberOfUsers":false,"serverId":"<server ID embedded in license>","supportEntitlementNumber":"<support entitlement number embedded in license>","license":"<encoded license text>","status":{"serverId":"<actual server ID>","currentNumberOfUsers":2}}

  The currently-installed license.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to view the license, or the request is anonymous.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  No license has been installed.

POST

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

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.

Example request representations:

• application/json [expand]

  Example

  {"license":"<encoded license text>"}

Example response representations:

• 200 - application/json (license) [expand]

  Example

  {"creationDate":1331038800000,"purchaseDate":1331038800000,"expiryDate":1372493732817,"numberOfDaysBeforeExpiry":0,"maintenanceExpiryDate":1372493732817,"numberOfDaysBeforeMaintenanceExpiry":0,"gracePeriodEndDate":1372493732817,"numberOfDaysBeforeGracePeriodExpiry":0,"maximumNumberOfUsers":12,"unlimitedNumberOfUsers":false,"serverId":"<server ID embedded in license>","supportEntitlementNumber":"<support entitlement number embedded in license>","license":"<encoded license text>","status":{"serverId":"<actual server ID>","currentNumberOfUsers":2}}

  The newly-installed license.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  No encoded license was provided in the JSON body for the POST.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to update the license.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The encoded license could not be decoded, or it is not valid for use on this server. For example, it may be for a different product, or it may have already expired.

DELETE

Deletes the current mail configuration.

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

Example response representations:

• 204 - application/json [expand]

  The mail configuration was successfully deleted.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to delete the mail server configuration.

GET

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

Example response representations:

• 200 - application/json (mailHostConfiguration) [expand]

  Example

  {"hostname":"smtp.example.com","port":465,"protocol":"SMTP","use-start-tls":true,"require-start-tls":false,"username":"user","sender-address":"stash-no-reply@company.com"}

  The mail configuration.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve the mail configuration.
• 404 - application/json [expand]

  The mail server hasn't been configured

PUT

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

Example request representations:

• application/json [expand]

  Example

  {"hostname":"smtp.example.com","port":465,"protocol":"SMTP","use-start-tls":true,"require-start-tls":false,"username":"user","sender-address":"stash-no-reply@company.com"}

Example response representations:

• 200 - application/json (mailConfiguration) [expand]

  Example

  {"hostname":"smtp.example.com","port":465,"protocol":"SMTP","use-start-tls":true,"require-start-tls":false,"username":"user","sender-address":"stash-no-reply@company.com"}

  The updated mail configuration.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The mail configuration was not updated due to a validation error.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to update the mail configuration.

DELETE

Clears the server email address.

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

Example response representations:

• 204 - application/json [expand]

  The server email address was successfully cleared.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to clear the server email address.

GET

Retrieves the server email address

Example response representations:

• 200 - application/json (server email address) [expand]

  Example

  "stash-no-reply@company.com"

  The server email address
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve the server email address.
• 404 - application/json [expand]

  The server email address is not set

PUT

Updates the server email address The authenticated user must have the ADMIN permission to call this resource.

Example request representations:

• application/json [expand]

  Example

  "stash-no-reply@company.com"

Example response representations:

• 200 - application/json (senderAddress) [expand]

  Example

  "stash-no-reply@company.com"

  The updated server email address.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The server email address was not updated due to a validation error.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to update the server email address.

GET

/rest/api/1.0/admin/permissions/groups?filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"group":{"name":"group_a"},"permission":"ADMIN"}],"start":0}

  A page of groups and their highest global permissions.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not an administrator.

DELETE

/rest/api/1.0/admin/permissions/groups?name

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)

request query parameters

Example response representations:

• 204 [expand]

  All global permissions were revoked from the group.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not an administrator.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified group does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would reduce the currently authenticated user's permission level or the currently authenticated user has a lower permission level than the group they are attempting to modify.

PUT

/rest/api/1.0/admin/permissions/groups?permission&name

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

• LICENSED_USER
• PROJECT_CREATE
• ADMIN
• SYS_ADMIN

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)

request query parameters

Example response representations:

• 204 [expand]

  The specified permission was granted to the specified user.

• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed or the specified permission does not exist.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not an administrator or doesn't have the specified permission they are attempting to grant.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would exceed the server's license limits.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified group does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would reduce the currently authenticated user's permission level or the currently authenticated user has a lower permission level than the group they are attempting to modify.

GET

/rest/api/1.0/admin/permissions/groups/none?filter

This is a paged API.

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

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

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"group-a","deletable":true}],"start":0}

  A page of groups that have not been granted any global permissions.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not an administrator.

GET

/rest/api/1.0/admin/permissions/users?filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"user":{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL"},"permission":"ADMIN"}],"start":0}

  A page of users and their highest global permissions.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not an administrator.

DELETE

/rest/api/1.0/admin/permissions/users?name

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)

request query parameters

Example response representations:

• 204 [expand]

  All global permissions were revoked from the user.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not an administrator.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would reduce the currently authenticated user's permission level or the currently authenticated user has a lower permission level than the user they are attempting to modify.

PUT

/rest/api/1.0/admin/permissions/users?name&permission

Promote or demote the global permission level of a user. Available global permissions are:

• LICENSED_USER
• PROJECT_CREATE
• ADMIN
• SYS_ADMIN

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)

request query parameters

Example response representations:

• 204 [expand]

  The requested permission was granted.

• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed or the specified permission does not exist.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not an administrator or doesn't have the specified permission they are attempting to grant.
• 403 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would exceed the server's license limits.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified user does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The action was disallowed as it would reduce the currently authenticated user's permission level or the currently authenticated user has a lower permission level than the user they are attempting to modify.

GET

/rest/api/1.0/admin/permissions/users/none?filter

This is a paged API.

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

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

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL"}],"start":0}

  A page of users that have not been granted any global permissions.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not an administrator.

GET

This is a paged API.

Retrieve the merge strategies available for this instance.

The user must be authenticated to call this resource.

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"defaultStrategy":{"description":"Always create a merge commit","enabled":true,"flag":"--no-ff","id":"no-ff","name":"Merge commit"},"strategies":[{"description":"Always create a merge commit","enabled":true,"flag":"--no-ff","id":"no-ff","name":"Merge commit"}],"type":"repository"}

  The merge configuration of this instance.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to see the request repository.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request repository does not exist.

POST

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": {
     }
 }
 

Example request representations:

• application/json [expand]

  Example

  {"defaultStrategy":{"id":"no-ff"},"strategies":[{"id":"no-ff"}]}

Example response representations:

• 200 - application/json (strategies) [expand]

  Example

  {"defaultStrategy":{"description":"Always create a merge commit","enabled":true,"flag":"--no-ff","id":"no-ff","name":"Merge commit"},"strategies":[{"description":"Always create a merge commit","enabled":true,"flag":"--no-ff","id":"no-ff","name":"Merge commit"}],"type":"repository"}

  The repository pull request merge strategies for the context repository.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The repository pull request merge strategies were not updated due to a validation error.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to administrate the specified repository.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified repository does not exist.

GET

Retrieve version information and other application properties.

No authentication is required to call this resource.

Example response representations:

• 200 - application/json (applicationProperties) [expand]

  Example

  {"version":"2.1.0","buildNumber":"20130123103656677","buildDate":"1358897885952000","displayName":"Example.com Bitbucket"}

  The application properties.

GET

/rest/api/1.0/dashboard/pull-requests?state&role&participantStatus&order&closedSince

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"id":101,"version":1,"title":"Talking Nerdy","description":"It’s a kludge, but put the tuple from the database in the cache.","state":"OPEN","open":true,"closed":false,"createdDate":1359075920,"updatedDate":1359085920,"fromRef":{"id":"refs/heads/feature-ABC-123","repository":{"slug":"my-repo","name":null,"project":{"key":"PRJ"}}},"toRef":{"id":"refs/heads/master","repository":{"slug":"my-repo","name":null,"project":{"key":"PRJ"}}},"locked":false,"author":{"user":{"name":"tom","emailAddress":"tom@example.com","id":115026,"displayName":"Tom","active":true,"slug":"tom","type":"NORMAL"},"role":"AUTHOR","approved":true,"status":"APPROVED"},"reviewers":[{"user":{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL"},"lastReviewedCommit":"7549846524f8aed2bd1c0249993ae1bf9d3c9998","role":"REVIEWER","approved":true,"status":"APPROVED"}],"participants":[{"user":{"name":"harry","emailAddress":"harry@example.com","id":99049120,"displayName":"Harry","active":true,"slug":"harry","type":"NORMAL"},"role":"PARTICIPANT","approved":true,"status":"APPROVED"},{"user":{"name":"dick","emailAddress":"dick@example.com","id":3083181,"displayName":"Dick","active":true,"slug":"dick","type":"NORMAL"},"role":"PARTICIPANT","approved":false,"status":"UNAPPROVED"}],"links":{"self":[{"href":"http://link/to/pullrequest"}]}}],"start":0}

  A page of pull requests that match the search criteria.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The current user is not authenticated

GET

/rest/api/1.0/dashboard/pull-request-suggestions?changesSince&limit

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  A page of pull requests that match the search criteria.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The current user is not authenticated

GET

/rest/api/1.0/groups?filter

This is a paged API.

Retrieve a page of group names.

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

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":2,"limit":25,"isLastPage":true,"values":["group_a","group_b"],"start":0}

  A page of group names.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user is not a project administrator.

GET

/rest/api/1.0/hooks/{hookKey}/avatar?version

Retrieve the avatar for the project matching the supplied moduleKey.

request query parameters

Example response representations:

• 200 - image/png [expand]

  The avatar of the project matching the supplied projectKey.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to view the project.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified project does not exist.

GET

/rest/api/1.0/inbox/pull-requests?start&limit&role

request query parameters

Example response representations:

• application/json; charset=UTF-8 [expand]

GET

Example response representations:

• application/json; charset=UTF-8 [expand]

GET

/rest/api/1.0/labels?prefix

Returns a paged response of all the labels in the system.

The user needs to be authenticated to use this resource.

request query parameters

Example response representations:

• 201 - application/json (label) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"labelName"}],"start":0}

  Page of returned labels.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The user is currently not authenticated.

GET

Returns a label.

The user needs to be authenticated to use this resource.

Example response representations:

• 200 - application/json (label) [expand]

  Example

  {"name":"labelName"}

  The label.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The user is currently not authenticated.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified label does not exist.

GET

/rest/api/1.0/labels/{labelName}/labeled?type

Returns a page of labelables for a given label.

The authenticated user must have REPO_ADMIN permission for the specified repository.

request query parameters

Example response representations:

• 200 - application/json (labelables) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]},"labelableType":"REPOSITORY"}],"start":0}

  The page of labelables.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The type of labelable is incorrect, correct values are REPOSITORY.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve the labelables
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified label does not exist.

GET

Retrieve the current log level for a given logger.

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

Example response representations:

• 200 - application/json (logLevel) [expand]

  Example

  {"logLevel":"DEBUG"}

  The log level of the logger.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve the log level.

PUT

Set the current log level for a given logger.

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

Example response representations:

• 204 - application/json [expand]

  The log level was successfully changed.

• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The log level was invalid.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to set the log level.

GET

Retrieve the current log level for the root logger.

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

Example response representations:

• 200 - application/json (logLevel) [expand]

  Example

  {"logLevel":"DEBUG"}

  The log level of the logger.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve the log level.

PUT

Set the current log level for the root logger.

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

Example response representations:

• 204 - application/json [expand]

  The log level was successfully changed.

• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The log level was invalid.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve the log level.

POST

Preview generated HTML for the given markdown content.

Only authenticated users may call this resource.

Example request representations:

• */* [expand]

  Example

  # Hello World!

Example response representations:

• 200 - application/json (markup) [expand]

  Example

  {
       "html" : "<h1>Hello World!</h1>"
   }

  The rendered markdown.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The markdown was invalid.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions preview rendered markdown.

POST

Requests the cancellation of an export job.

The request to cancel a job will be processed successfully if the job is actually still running. If it has already finished (successfully or with errors) or if it has already been canceled before, then an error will be returned.

There might be a small delay between accepting the request and actually cancelling the job. In most cases, the delay will be close to instantaneously. In the unlikely case of communication issues across a cluster, it can however take a few seconds to cancel a job.

A client should always actively query the job status to confirm that a job has been successfully canceled.

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

Example response representations:

• 204 [expand]

  The job has successfully been marked for cancellation.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to cancel this job.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified job does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The job was in a state that does not allow cancellation, e.g. it has already finished.

POST

Requests the cancellation of an import job.

The request to cancel a job will be processed successfully if the job is actually still running. If it has already finished (successfully or with errors) or if it has already been canceled before, then an error will be returned.

Note that import jobs are not canceled as instantaneously as export jobs. Rather, once the request has been accepted, there are a number of checkpoints at which the job will actually apply it and stop. This is to keep the system in a reasonably consistent state:

• After the current fork hierarchy has been imported and verified.
• Before the next repository is imported.
• Before the next pull request is imported.

A client should always actively query the job status to confirm that a job has been successfully canceled.

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

Example response representations:

• 204 [expand]

  The job has successfully been marked for cancellation.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to cancel this job.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified job does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The job was in a state that does not allow cancellation, e.g. it has already finished.

GET

Gets the details, including the current status and progress, of the export job identified by the given ID.

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

Example response representations:

• 200 - application/json (job) [expand]

  Example

  {"id":1,"nodeId":"1bec7499-077a-4b58-b27c-996a9c2187a4","progress":{"message":"Working on it...","percentage":42},"startDate":1497657601000,"state":"RUNNING","type":"com.atlassian.bitbucket.migration.export","updateDate":1497657603000,"initiator":{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL"}}

  The job, including status and progress information.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve information about this job.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified job does not exist.

GET

/rest/api/1.0/migration/exports/{jobId}/messages?severity&subject

This is a paged API.

Gets the messages generated by the job.

Without any filter, all messages will be returned, but the response can optionally be filtered for the following severities. The severity parameter can be repeated to include multiple severities in one response.

• INFO
• WARN
• ERROR

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

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":3,"limit":25,"isLastPage":true,"values":[{"createdDate":1497657601250,"id":617,"severity":"INFO","subject":"job","text":"Something of interest happened"},{"createdDate":1497657601500,"id":618,"severity":"WARN","subject":"repo: PRJ/my-repo","text":"Something did not work perfectly"},{"createdDate":1497657601750,"id":619,"severity":"ERROR","subject":"job","text":"Something has failed"}],"start":0}

  The messages generated by this job.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve information about this job.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified job does not exist.

GET

Gets the details, including the current status and progress, of the import job identified by the given ID.

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

Example response representations:

• 200 - application/json (job) [expand]

  Example

  {"id":1,"nodeId":"1bec7499-077a-4b58-b27c-996a9c2187a4","progress":{"message":"Working on it...","percentage":42},"startDate":1497657601000,"state":"RUNNING","type":"com.atlassian.bitbucket.migration.import","updateDate":1497657603000,"initiator":{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL"}}

  The job, including status and progress information.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve information about this job.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified job does not exist.

GET

/rest/api/1.0/migration/imports/{jobId}/messages?severity&subject

This is a paged API.

Gets the messages generated by the job.

Without any filter, all messages will be returned, but the response can optionally be filtered for the following severities. The severity parameter can be repeated to include multiple severities in one response.

• INFO
• WARN
• ERROR

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

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":3,"limit":25,"isLastPage":true,"values":[{"createdDate":1497657601250,"id":617,"severity":"INFO","subject":"job","text":"Something of interest happened"},{"createdDate":1497657601500,"id":618,"severity":"WARN","subject":"repo: PRJ/my-repo","text":"Something did not work perfectly"},{"createdDate":1497657601750,"id":619,"severity":"ERROR","subject":"job","text":"Something has failed"}],"start":0}

  The messages generated by this job.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to retrieve information about this job.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified job does not exist.

POST

Enumerates the projects and repositories that would be exported for a given export request.

All affected repositories will be enumerated explicitly, and while projects are listed as individual items in responses from this endpoint, their presence does not imply that all their repositories are included.

While this endpoint can be used to verify that all selectors in the request apply as intended, it should be noted that a subsequent, actual export might contain a different set of repositories, as they might have been added or deleted in the meantime.

Note that the overall response from this endpoint can become very large when a lot of repositories end up in the selection. This is why the server is streaming the response while it is being generated (as opposed to creating it in memory and then sending it all at once) and it can be consumed in a streaming way, too.

Also, due to the potential size of the response, projects and repositories are listed with fewer details than in other REST responses.

For a more detailed description of selectors, see the endpoint documentation for starting an export.

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

Example request representations:

• application/json [expand]

  Example

  {"repositoriesRequest":{"includes":[{"projectKey":"PRJ","slug":"my-repo"}]}}

Example response representations:

• 200 - application/json (scopes) [expand]

  Example

  {"scopes":[{"key":"PRJ","id":1,"name":"My Cool Project","public":true,"type":"NORMAL","scope":"PROJECT"},{"slug":"my-repo","id":1,"name":"My repo","forkable":true,"project":"PRJ","public":true,"scope":"REPOSITORY"}]}

  The effectively selected projects and repositories.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to generate a preview.

POST

Starts a background job that exports the selected repositories.

Only 2 concurrent exports are supported per cluster node. If a request ends up on a node that is already running that many export jobs, the request will be rejected and an error returned.

The response includes a description of the job that has been started, and its ID can be used to query these details again, including the current progress, warnings and errors that occurred while processing the job, and to interrupt and cancel the execution of this job.

The request to start an export is similar to the one for previewing an export. Additionally, it accepts an optional parameter, exportLocation, which can be used to specify a relative path within data/migration/export in the shared home directory. No locations outside of that directory will be accepted for exports.

There are essentially three ways to select repositories for export. Regardless of which you use, a few general rules apply:

• You can supply a list of selectors. The selection will be additive.
• Repositories that are selected more than once due to overlapping selectors will be de-duplicated and effectively exported only once.
• For every selected repository, its full fork hierarchy will be considered selected, even if parts of that hierarchy would otherwise not be matched by the provided selectors. For example, when you explicitly select a single repository only, but that repository is a fork, then its origin will be exported (and eventually imported), too.

Now, a single repository can be selected like this:

     {
        "projectKey": "PRJ",
        "slug": "my-repo"
     }
     

Second, all repositories in a specific project can be selected like this:

     {
        "projectKey": "PRJ",
        "slug": *"
     }
     

And third, all projects and repositories in the system would be selected like this:

     {
        "projectKey": "*",
        "slug": *"
     }
     

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

Example request representations:

• application/json [expand]

  Example

  {"exportLocation":"example/sub/directory","repositoriesRequest":{"includes":[{"projectKey":"PRJ","slug":"my-repo"}]}}

Example response representations:

• 200 - application/json (job) [expand]

  Example

  {"id":1,"nodeId":"1bec7499-077a-4b58-b27c-996a9c2187a4","progress":{"message":"Working on it...","percentage":42},"startDate":1497657601000,"state":"RUNNING","type":"com.atlassian.bitbucket.migration.export","updateDate":1497657603000,"initiator":{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL"}}

  Details about the export job.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to start an an export.
• 503 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The export could not be started because the limit of concurrent migration jobs has been reached.

POST

Starts a background job that imports the specified archive.

Only 1 import at a time is supported per cluster. If another request is made while an import is already running, the request will be rejected and an error returned.

The path in the request must point to a valid archive file. It can be either absolute, or will be interpreted as relative to the data/migration/import directory in the shared home directory.

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

Example request representations:

• application/json [expand]

  Example

  {"archivePath":"Bitbucket_export_1.tar"}

Example response representations:

• 200 - application/json (job) [expand]

  Example

  {"id":1,"nodeId":"1bec7499-077a-4b58-b27c-996a9c2187a4","progress":{"message":"Working on it...","percentage":42},"startDate":1497657601000,"state":"RUNNING","type":"com.atlassian.bitbucket.migration.import","updateDate":1497657603000,"initiator":{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL"}}

  Details about the export job.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to start an an import.
• 503 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The import could not be started because the limit of concurrent migration jobs has been reached.

GET

/rest/api/1.0/profile/recent/repos?permission

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]}}],"start":0}

  A page of recently accessed repositories.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The permission level is unknown or not related to repository.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request is unauthenticated.

GET

/rest/api/1.0/projects?name&permission

This is a paged API.

Retrieve a page of projects.

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

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}}],"start":0}

  A page of projects.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The permission level is unknown or not related to projects.

POST

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)
 

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

Example request representations:

• application/json [expand]

  Example

  {"key":"PRJ","name":"My Cool Project","description":"The description for my cool project.","avatar":"data:image/png;base64,<base64-encoded-image-data>"}

Example response representations:

• 201 - application/json (project) [expand]

  Example

  {"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}}

  The newly created project.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The project was not created due to a validation error.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to create a project.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The project key or name is already in use.

GET

Retrieve the project matching the supplied projectKey.

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

Example response representations:

• 200 - application/json (project) [expand]

  Example

  {"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}}

  The project matching the supplied projectKey.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to view the project.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified project does not exist.

DELETE

Delete the project matching the supplied projectKey.

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

Example response representations:

• 204 [expand]

  The project matching the supplied projectKey was deleted.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to delete the project.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified project does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The project can not be deleted as it contains repositories.

PUT

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.

Example request representations:

• application/json [expand]

  Example

  {"key":"PRJ","name":"My Cool Project","description":"The description for my cool project.","avatar":"data:image/png;base64,<base64-encoded-image-data>"}

Example response representations:

• 200 - application/json (project) [expand]

  Example

  {"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}}

  The updated project. The project's key was not updated.
• 201 - application/json (project) [expand]

  Example

  {"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}}

  The updated project. The project's key was updated.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The project was not updated due to a validation error.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to update the project.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified project does not exist.

POST

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 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.

Example response representations:

• 201 [expand]

  The avatar was uploaded successfully.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to update the project.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified project does not exist.

GET

/rest/api/1.0/projects/{projectKey}/avatar.png?s

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.

request query parameters

Example response representations:

• 200 - image/png [expand]

  The avatar of the project matching the supplied projectKey.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to view the project.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified project does not exist.

GET

/rest/api/1.0/projects/{projectKey}/permissions/groups?filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"group":{"name":"group_a"},"permission":"ADMIN"}],"start":0}

  A page of groups and their highest permissions for the specified project.
• 401 [expand]

  The currently authenticated user is not a project administrator for the specified project.

• 404 [expand]

  The specified project does not exist.

DELETE

/rest/api/1.0/projects/{projectKey}/permissions/groups?name

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.

request query parameters

Example response representations:

• 204 [expand]

  All project permissions were revoked from the group for the specified project.

• 401 [expand]

  The currently authenticated user is not an administrator of the specified project.

• 404 [expand]

  The specified project or group does not exist.

• 409 [expand]

  The action was disallowed as it would reduce the currently authenticated user's permission level.

PUT

/rest/api/1.0/projects/{projectKey}/permissions/groups?permission&name

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.

request query parameters

Example response representations:

• 204 [expand]

  The requested permission was granted.

• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed or the specified permission does not exist.
• 401 [expand]

  The currently authenticated user is not an administrator for the specified project.

• 403 [expand]

  The action was disallowed as it would reduce the currently authenticated user's permission level.

• 404 [expand]

  The specified project or group does not exist.

GET

/rest/api/1.0/projects/{projectKey}/permissions/groups/none?filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"group-a","deletable":true}],"start":0}

  A page of groups that have not been granted any permissions for the specified project.
• 401 [expand]

  The currently authenticated user is not a project administrator for the specified project.

• 404 [expand]

  The specified project does not exist.

GET

/rest/api/1.0/projects/{projectKey}/permissions/users?filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"user":{"name":"jcitizen","emailAddress":"jane@example.com","id":101,"displayName":"Jane Citizen","active":true,"slug":"jcitizen","type":"NORMAL"},"permission":"ADMIN"}],"start":0}

  A page of users and their highest permissions for the specified project.
• 401 [expand]

  The currently authenticated user is not a project administrator for the specified project.

• 404 [expand]

  The specified project does not exist.

DELETE

/rest/api/1.0/projects/{projectKey}/permissions/users?name

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.

request query parameters

Example response representations:

• 204 [expand]

  All project permissions were revoked from the user for the specified project.

• 401 [expand]

  The currently authenticated user is not an administrator of the specified project.

• 404 [expand]

  The specified project or group does not exist.

• 409 [expand]

  The action was disallowed as it would reduce the currently authenticated user's permission level.

PUT

/rest/api/1.0/projects/{projectKey}/permissions/users?name&permission

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.

request query parameters

Example response representations:

• 204 [expand]

  The requested permission was granted.

• 400 [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed or the specified permission does not exist.

• 401 [expand]

  The currently authenticated user is not an administrator for the specified project.

• 403 [expand]

  The action was disallowed as it would reduce the currently authenticated user's permission level.

• 404 [expand]

  The specified project or user does not exist.

GET

/rest/api/1.0/projects/{projectKey}/permissions/users/none?filter

This is a paged API.

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.

request query parameters

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"name":"group-a","deletable":true}],"start":0}

  A page of users that have not been granted any permissions for the specified project.
• 401 [expand]

  The currently authenticated user is not a project administrator for the specified project.

• 404 [expand]

  The specified project does not exist.

GET

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.

Example response representations:

• 200 - application/json (permitted) [expand]

  Example

  {"permitted":true}

  A simple entity indicating whether the specified permission is the default permission for this project.
• 400 [expand]

  The request was malformed or the specified permission does not exist.

• 401 [expand]

  The currently authenticated user is not an administrator of the specified project.

• 404 [expand]

  The specified project does not exist.

POST

/rest/api/1.0/projects/{projectKey}/permissions/{permission}/all?allow

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.

request query parameters

Example response representations:

• 204 [expand]

  The requested permission was successfully granted or revoked.

• 400 [expand]

  Example

  {"errors":[{"context":"field_a","message":"A detailed validation error message for field_a.","exceptionName":null},{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request was malformed or the specified permission does not exist.

• 401 [expand]

  The currently authenticated user is not an administrator of the specified project.

• 404 [expand]

  The specified project does not exist.

POST

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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.

Example request representations:

• application/json [expand]

  Example

  {"name":"My repo","scmId":"git","forkable":true}

Example response representations:

• 201 - application/json (repository) [expand]

  Example

  {"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]}}

  The newly created repository.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The repository was not created due to a validation error.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to create a repository.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  A repository with same name already exists.

GET

This is a paged API. This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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.

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]}}],"start":0}

  The repositories matching the supplied projectKey.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to see the specified project.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified project does not exist.

GET

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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.

Example response representations:

• 200 - application/json (repository) [expand]

  Example

  {"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]}}

  The repository which matches the supplied projectKey and repositorySlug.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to see the specified repository.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified repository does not exist.

DELETE

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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.

Example response representations:

• 202 - application/json (message) [expand]

  Example

  {"context":null,"message":"Repository scheduled for deletion.","exceptionName":null}

  The repository has been scheduled for deletion.
• 204 [expand]

  No repository matching the supplied projectKey and repositorySlug was found.

• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to delete the repository.

POST

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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.

Example request representations:

• application/json [expand]

  Example

  {"slug":"my-repo","name":null,"project":{"key":"PRJ"}}

Example response representations:

• 201 - application/json (repository) [expand]

  Example

  {"slug":"my-repo","id":2,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"origin":{"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]}},"project":{"key":"~JDOE","id":2,"name":"John Doe","type":"PERSONAL","links":{"self":[{"href":"http://link/to/project"}]}},"links":{"clone":[{"href":"https://<baseURL>/scm/JDOE/my-repo.git","name":"http"},{"href":"ssh://git@<baseURL>/JDOE/my-repo.git","name":"ssh"}],"self":[{"href":"http://link/to/repository"}]}}

  The newly created fork.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  A validation error prevented the fork from being created. Possible validation errors include: The name or slug for the fork collides with another repository in the target project; an SCM type was specified in the JSON body; a project was specified in the JSON body without a "key" property.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to create a fork.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified repository does not exist, or, if a target project was specified, the target project does not exist.

PUT

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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.

Example request representations:

• application/json [expand]

  Example

  {"name":"My repo","forkable":false,"project":{"key":"PRJ"},"public":true}

Example response representations:

• 201 - application/json (repository) [expand]

  Example

  {"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]}}

  The updated repository.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The repository was not updated due to a validation error.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to update a repository
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified repository does not exist.
• 409 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  A repository with same name as the target already exists

HEAD

Example response representations:

• application/json; charset=UTF-8 [expand]

GET

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

Retrieves the contributing guidelines for the repository, if they've been defined.

This checks the repository for a

CONTRIBUTING

md

txt

?markup

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

Example response representations:

• */* [expand]

GET

This is a paged API. This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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.

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"slug":"my-repo","id":2,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"origin":{"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]}},"project":{"key":"~JDOE","id":2,"name":"John Doe","type":"PERSONAL","links":{"self":[{"href":"http://link/to/project"}]}},"links":{"clone":[{"href":"https://<baseURL>/scm/JDOE/my-repo.git","name":"http"},{"href":"ssh://git@<baseURL>/JDOE/my-repo.git","name":"ssh"}],"self":[{"href":"http://link/to/repository"}]}}],"start":0}

  A page of repositories related to the request repository.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to see the request repository.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request repository does not exist.

HEAD

Example response representations:

• application/json; charset=UTF-8 [expand]

GET

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

Retrieves the license for the repository, if it's been defined.

This checks the repository for a

LICENSE

md

txt

?markup

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

Example response representations:

• */* [expand]

HEAD

Example response representations:

• application/json; charset=UTF-8 [expand]

GET

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

Retrieves the README for the repository, if it's been defined.

This checks the repository for a

README

md

txt

?markup

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

Example response representations:

• */* [expand]

POST

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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.

Example response representations:

• 201 - application/json (repository) [expand]

  Example

  {"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]}}

  The newly created repository.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The repository was not created due to a validation error.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to create a repository.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The specified repository does not exist.

GET

This is a paged API. This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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.

Example response representations:

• 200 - application/json (page) [expand]

  Example

  {"size":1,"limit":25,"isLastPage":true,"values":[{"slug":"my-repo","id":2,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"origin":{"slug":"my-repo","id":1,"name":"My repo","scmId":"git","state":"AVAILABLE","statusMessage":"Available","forkable":true,"project":{"key":"PRJ","id":1,"name":"My Cool Project","description":"The description for my cool project.","public":true,"type":"NORMAL","links":{"self":[{"href":"http://link/to/project"}]}},"public":true,"links":{"clone":[{"href":"ssh://git@<baseURL>/PRJ/my-repo.git","name":"ssh"},{"href":"https://<baseURL>/scm/PRJ/my-repo.git","name":"http"}],"self":[{"href":"http://link/to/repository"}]}},"project":{"key":"~JDOE","id":2,"name":"John Doe","type":"PERSONAL","links":{"self":[{"href":"http://link/to/project"}]}},"links":{"clone":[{"href":"https://<baseURL>/scm/JDOE/my-repo.git","name":"http"},{"href":"ssh://git@<baseURL>/JDOE/my-repo.git","name":"ssh"}],"self":[{"href":"http://link/to/repository"}]}}],"start":0}

  A page of repositories related to the request repository.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to see the request repository.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The request repository does not exist.

GET

/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/archive?at&filename&format&path&prefix

This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

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 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.

request query parameters

Example response representations:

• 200 - application/octet-stream; application/x-tar (archive) [expand]

  An archive or the requested commit, in zip, tar or gzipped-tar format.
• 400 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The requested format is not supported.
• 401 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The currently authenticated user has insufficient permissions to view the repository.
• 404 - application/json (errors) [expand]

  Example

  {"errors":[{"context":null,"message":"A detailed error message.","exceptionName":null}]}

  The repository does not exist or does not contain the at commit.

GET

/rest/api/1.0/projects/{projectKey}/repos/{repositorySlug}/branches?base&details&filterText&orderBy

This is a paged API. This API can also be invoked via a user-centric URL when addressing repositories in personal projects.

Retrieve the branches matching the supplied filterText param.

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

request query parameters