Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

name path methods description
AuthenticationResource
  • /api/rest/authentication
  • /api/rest/authentication/login
  • /api/rest/authentication/logout
  • /api/rest/authentication/state
  • GET
  • POST
  • GET
  • GET
Authentication related RESTful Web Service endpoint.
ChangePasswordResource
  • /api/rest/action/change-password
  • POST
Resource to change the password of the authenticated user.
CipherResource
  • /api/rest/security/cipher/encrypt
  • POST
Rest resource to encrypt values.
GroupResource
  • /api/rest/groups
  • /api/rest/groups/{id}
  • GET POST
  • DELETE GET PUT
RESTful Web Service Resource to manage groups and their members.
KeyResource
  • /api/rest/security/key
  • GET
Rest resource to generate unique keys.
PluginResource
  • /api/rest/plugins
  • /api/rest/plugins/available
  • /api/rest/plugins/install-package
  • /api/rest/plugins/install-package.html
  • /api/rest/plugins/installed
  • /api/rest/plugins/overview
  • /api/rest/plugins/updates
  • /api/rest/plugins/install/{id}
  • /api/rest/plugins/uninstall/{id}
  • /api/rest/plugins/update/{id}
  • GET
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
  • POST
  • POST
  • POST
RESTful Web Service Endpoint to manage plugins.
RepositoryImportResource
  • /api/rest/import/repositories
  • /api/rest/import/repositories/{type}
  • /api/rest/import/repositories/{type}/bundle
  • /api/rest/import/repositories/{type}/bundle.html
  • /api/rest/import/repositories/{type}/directory
  • /api/rest/import/repositories/{type}/url
  • GET POST
  • POST
  • POST
  • POST
  • POST
  • POST
Rest resource for importing repositories.
RepositoryResource
  • /api/rest/repositories
  • /api/rest/repositories/{id}
  • /api/rest/repositories/{id}/blame
  • /api/rest/repositories/{id}/branches
  • /api/rest/repositories/{id}/browse
  • /api/rest/repositories/{id}/changesets
  • /api/rest/repositories/{id}/content
  • /api/rest/repositories/{id}/diff
  • /api/rest/repositories/{id}/healthcheck
  • /api/rest/repositories/{id}/tags
  • /api/rest/repositories/{type}/{name}
  • /api/rest/repositories/{id}/changeset/{revision}
  • GET POST
  • DELETE GET PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET
  • GET
  • GET
Repository related RESTful Web Service Endpoint.
SearchResource
  • /api/rest/search/groups
  • /api/rest/search/users
  • GET
  • GET
RESTful Web Service Resource to search users and groups. This endpoint can be used to implement typeahead input fields for permissions.
SecuritySystemResource
  • /api/rest/security/permission/group/{group}
  • /api/rest/security/permission/user/{user}
  • /api/rest/security/permission/group/{group}/{id}
  • /api/rest/security/permission/user/{user}/{id}
  • GET POST
  • GET POST
  • DELETE GET PUT
  • DELETE GET PUT
Resource for managing system security permissions.
UserResource
  • /api/rest/users
  • /api/rest/users/{id}
  • GET POST
  • DELETE GET PUT
RESTful Web Service Resource to manage users.