RepositoryResource

The following resources are part of this group:

/repositories

Mount Point: /api/rest/repositories

POST

Creates a new repository.
This method requires admin privileges.

Status codes:

Request Body

element: repositories
media types: application/xml
application/json

the repository to be created

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

GET

Returns all repositories.

Status codes:

Parameters

name description type default
start the start value for paging query 0
limit the limit value for paging query -1
sortby sort parameter query
desc sort direction desc or aesc query false

Response Body

element: (custom)
media types: application/xml
application/json

all repositories

/repositories/{id}

Mount Point: /api/rest/repositories/{id}

The following operations are supported on this resource:

DELETE

Deletes a repository.
This method requires owner privileges.

Status codes:

Parameters

name description type default
id the id of the repository to delete. path

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

PUT

Modifies the given repository.
This method requires owner privileges.

Status codes:

Parameters

name description type default
id id of the repository to be modified path

Request Body

element: repositories
media types: application/xml
application/json

repository object to modify

Response Body

element: (custom)
media types: */*
application/xml

(no documentation provided)

GET

Returns the Repository with the specified id.

Status codes:

Parameters

name description type default
id the id/name of the user path

Response Body

element: repositories
media types: application/xml
application/json

the Repository with the specified id

/repositories/{id}/blame

Mount Point: /api/rest/repositories/{id}/blame

GET

Returns a annotate/blame view for the given path.

Status codes:

Parameters

name description type default
id the id of the repository path
revision the revision of the file query
path the path of the file query

Response Body

element: blame-result
media types: application/xml
application/json

a annotate/blame view for the given path

/repositories/{id}/branches

Mount Point: /api/rest/repositories/{id}/branches

Available Since: 1.18

GET

Available Since: 1.18

Returns all Branches of a repository.

Status codes:

Parameters

name description type default
id the id of the repository path

Response Body

element: (custom)
media types: */*
application/xml

all Branches of a repository

/repositories/{id}/browse

Mount Point: /api/rest/repositories/{id}/browse

GET

Returns a list of folders and files for the given folder.

Status codes:

Parameters

name description type default
id the id of the repository path
revision the revision of the file query
path the path of the folder query

Response Body

element: browser-result
media types: application/xml
application/json

a list of folders and files for the given folder

/repositories/{id}/changesets

Mount Point: /api/rest/repositories/{id}/changesets

GET

Returns a list of Changeset for the given repository.

Status codes:

Parameters

name description type default
id the id of the repository path
path path of a file query
revision the revision of the file specified by the path parameter query
branch (no documentation provided) query
start the start value for paging query 0
limit the limit value for paging query 20

Response Body

element: changeset-paging
media types: application/xml
application/json

a list of Changeset for the given repository

/repositories/{id}/content

Mount Point: /api/rest/repositories/{id}/content

GET

Returns the content of a file.

Status codes:

Parameters

name description type default
id the id of the repository path
revision the revision of the file query
path path to the file query

Response Body

element: (custom)
media types: application/octet-stream

the content of a file

/repositories/{id}/diff

Mount Point: /api/rest/repositories/{id}/diff

GET

Returns the modifications of a Changeset.

Status codes:

Parameters

name description type default
id the id of the repository path
revision the revision of the file query
path path to the file query

Response Body

element: (custom)
media types: application/octet-stream

the modifications of a Changeset

/repositories/{id}/tags

Mount Point: /api/rest/repositories/{id}/tags

Available Since: 1.18

GET

Available Since: 1.18

Returns all Tags of a repository.

Status codes:

Parameters

name description type default
id the id of the repository path

Response Body

element: (custom)
media types: */*
application/xml

all Tags of a repository

/repositories/{type}/{name}

Mount Point: /api/rest/repositories/{type}/{name}

GET

Returns the Repository with the specified type and name.

Status codes:

Parameters

name description type default
type the type of the repository path
name the name of the repository path

Response Body

element: repositories
media types: application/xml
application/json

the Repository with the specified type and name

/repositories/{id}/changeset/{revision}

Mount Point: /api/rest/repositories/{id}/changeset/{revision}

GET

Returns the Changeset from the given repository with the specified revision.

Status codes:

Parameters

name description type default
id the id of the repository path
revision the revision of the changeset path

Response Body

element: (custom)
media types: */*
application/xml

a Changeset from the given repository