GIT MultiSite API: RepositoryResource

Application REST endpoint to access and manipulate specific Repository data.

POST /repository

Deploy a repository to a replication group.

Request Parameters
name	type	description	default
createEmptyRepo	query		false
denyNonFastForwards	query
gerritRepo	query	- Whether this repo has been added through Gerrit.	false
replicationGroupId	query
timeout	query	- if defined, the number of seconds before a deploy operation will abort.

Request Body
media type	data type
application/json	GitRepositoryDTO (JSON)
application/xml	gitRepositoryDTO (XML)

Response Codes
code	condition
202	Accepted
400	Bad Request - see Exception
404	Replication Group not found
409	Conflict - see Exception
503	Repository deployment timed out or failed due to proposal being rejected.
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Response Headers
name	description
Content Location	Path to relevant Task

Example

Request

POST /repository
Content-Type: application/json
Accept: application/xml

                
{
  "repositoryIdentity" : "...",
  "name" : "...",
  "fileSystemPath" : "...",
  "globalReadOnly" : true,
  "localReadOnly" : true,
  "readOnlyReason" : "...",
  "readOnlyTime" : 12345,
  "latestRevision" : {
    "revision" : "...",
    "timestamp" : 12345
  },
  "state" : { },
  "replicationGroupId" : "...",
  "pendingTransactions" : 12345,
  "pendingTransactionsForAllNodes" : {
    "repositoryNodesTransactions" : [ {
      "nodeId" : "...",
      "lastOutput" : 12345,
      "lastDelivered" : 12345,
      "pendingTransactions" : 12345
    }, {
      "nodeId" : "...",
      "lastOutput" : 12345,
      "lastDelivered" : 12345,
      "pendingTransactions" : 12345
    } ]
  },
  "dsmId" : "...",
  "denyNonFastForwards" : true
}

Response

HTTP/1.1 202 Accepted
Content-Type: application/xml
Content Location: ...

                
...

DELETE /repository/deleteRepository

Remove a repository by the FS Path

Request Parameters
name	type	description	default
fsPath	query

Response Codes
code	condition
200	Ok
202	Accepted
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/json	object (JSON)
application/xml	anyType (XML)

Response Headers
name	description
Content Location	Path to relevant Task

Example

Request

DELETE /repository/deleteRepository
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json
Content Location: ...

                
...

GET /repository/search

Find the repository with the specified parameter(s)

Request Parameters
name	type	description	default	constraints
filesystemPath	query
withPendingTransactions	query	true/false	false	boolean
withPendingTransactionsForAllNodes	query		false	boolean

Response Codes
code	condition
200	Ok
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	gitRepositoryDTO (XML)

Example

Request

GET /repository/search
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
<git-repository>
  <repositoryIdentity>...</repositoryIdentity>
  <name>...</name>
  <fileSystemPath>...</fileSystemPath>
  <globalReadOnly>...</globalReadOnly>
  <localReadOnly>...</localReadOnly>
  <readOnlyReason>...</readOnlyReason>
  <readOnlyTime>...</readOnlyTime>
  <latestRevision>
    <timestamp>...</timestamp>
  </latestRevision>
  <state/>
  <replicationGroupId>...</replicationGroupId>
  <pendingTransactions>...</pendingTransactions>
  <pendingTransactionsForAllNodes>
    <repositoryNodesTransactions>
      <nodeId>...</nodeId>
      <lastOutput>...</lastOutput>
      <lastDelivered>...</lastDelivered>
      <pendingTransactions>...</pendingTransactions>
    </repositoryNodesTransactions>
  </pendingTransactionsForAllNodes>
  <dsmId>...</dsmId>
  <denyNonFastForwards>...</denyNonFastForwards>
</git-repository>

PUT /repository/setHead

Request Parameters
name	type	description	default
newHead	query
repositoryId	query
repositoryPath	query

Response Codes
code	condition
200	OK
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/json	object (JSON)
application/xml	anyType (XML)

Example

Request

PUT /repository/setHead
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json

                
...

PUT /repository/stophelperall

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description	constraints
helperNodeId	query	- node id to operate on.
threshold	query	- threshold of sync stop operation - will be set per repo later.	long

Request Body
media type	data type	description
application/xml	repositoryAndHelperListDTO (XML)	- repository ids list

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	repositoryGsnListDTO (XML)

Example

Request

PUT /repository/stophelperall
Content-Type: application/xml
Accept: application/xml

                
<repositoryAndHelperList>
  <repoList>...</repoList>
  <nodeList>
    <node>
      <nodeIdentity>...</nodeIdentity>
      <locationIdentity>...</locationIdentity>
      <isLocal>...</isLocal>
      <isUp>...</isUp>
      <isStopped>...</isStopped>
      <lastStatusChange>...</lastStatusChange>
      <attributes/>
    </node>
  </nodeList>
</repositoryAndHelperList>

Response

HTTP/1.1 204 No Content
Content-Type: application/xml

                
<repositoryGsnList>
  <list>
    <repositoryIdentity>...</repositoryIdentity>
    <gsn>...</gsn>
  </list>
</repositoryGsnList>

PUT /repository/update-config

Updates the git repository with the specified file path, given the XML for the properties to update. Notes on usage:

ADD/UPDATE: To add or update a property, provide all of the details [section, subsection (optional), property, value]

NO-CHANGE: Properties which do not need to be updated do not need to be provided.

DELETE-SECTION: Where a section is to be deleted, the section name should be specified, with no other details.

DELETE-SUB-SECTION: Where a sub-section is to be deleted, the section name and subSection should be specified, with no other details.

DELETE-PROPERTY: Where a property is to be deleted, the section name, subSection, and property should be specified, and no value set.

Request Parameters
name	type	description
path	query	- path to repository on the file system.

Request Body
media type	data type	description
application/xml	gitConfigPropertyListDTO (XML)	Config Properties DTO.

Response Codes
code	condition
202	Accepted
400	Bad Request - see Exception
404	Repository not found
500	Internal Server Error
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/json	object (JSON)	HTTP Response
application/xml	anyType (XML)	HTTP Response

Example

Request

PUT /repository/update-config
Content-Type: application/xml
Accept: application/json

                
<git-config-properties>
  <config>
    <section>...</section>
    <subsection>...</subsection>
    <property>...</property>
    <value>...</value>
  </config>
</git-config-properties>

Response

HTTP/1.1 202 Accepted
Content-Type: application/json

                
...

DELETE /repository/{repositoryId}

Remove repository by id

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
200	Ok
202	Accepted
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/json	object (JSON)
application/xml	anyType (XML)

Response Headers
name	description
Content Location	Path to relevant Task

Example

Request

DELETE /repository/{repositoryId}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/json
Content Location: ...

                
...

GET /repository/{repositoryId}

Get the specified Repository by Id

Request Parameters
name	type	description	default	constraints
repositoryId	path
withPendingTransactions	query	true/false	false	boolean
withPendingTransactionsForAllNodes	query		false	boolean

Response Codes
code	condition
200	Ok
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	gitRepositoryDTO (XML)

Example

Request

GET /repository/{repositoryId}
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
<git-repository>
  <repositoryIdentity>...</repositoryIdentity>
  <name>...</name>
  <fileSystemPath>...</fileSystemPath>
  <globalReadOnly>...</globalReadOnly>
  <localReadOnly>...</localReadOnly>
  <readOnlyReason>...</readOnlyReason>
  <readOnlyTime>...</readOnlyTime>
  <latestRevision>
    <timestamp>...</timestamp>
  </latestRevision>
  <state/>
  <replicationGroupId>...</replicationGroupId>
  <pendingTransactions>...</pendingTransactions>
  <pendingTransactionsForAllNodes>
    <repositoryNodesTransactions>
      <nodeId>...</nodeId>
      <lastOutput>...</lastOutput>
      <lastDelivered>...</lastDelivered>
      <pendingTransactions>...</pendingTransactions>
    </repositoryNodesTransactions>
  </pendingTransactionsForAllNodes>
  <dsmId>...</dsmId>
  <denyNonFastForwards>...</denyNonFastForwards>
</git-repository>

GET /repository/{repositoryId}/config

Get the configuration details for the specified git repository as it appears on the local node.

Request Parameters
name	type	description
repositoryId	path	ID of repository for which config should be made available.

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)	XML representation of git configuration.

Example

Request

GET /repository/{repositoryId}/config
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
...

GET /repository/{repositoryId}/consistencycheck

get the consistency check result for the specified repo

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
200	Ok
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	checkpointListDTO (XML)

Example

Request

GET /repository/{repositoryId}/consistencycheck
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
<checkpoints>
  <checkpoint>
    <gsn>...</gsn>
    <nodeId>...</nodeId>
    <repoId>...</repoId>
    <hash>...</hash>
  </checkpoint>
</checkpoints>

POST /repository/{repositoryId}/consistencycheck

Kick of a global repository check.

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
202	Accepted
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/json	object (JSON)
application/xml	anyType (XML)

Example

Request

POST /repository/{repositoryId}/consistencycheck
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 202 Accepted
Content-Type: application/json

                
...

POST /repository/{repositoryId}/fork_repository

Request Parameters
name	type	default
repositoryId	path
cloneDir	query
gerritRepo	query	false
repositoryName	query

Response Codes
code	condition
202	Accepted
404	Repository not found
400	Bad Request - see Exception
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Response Headers
name	description
Content Location	Path to relevant Task

Example

Request

POST /repository/{repositoryId}/fork_repository
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 202 Accepted
Content-Type: application/xml
Content Location: ...

                
...

POST /repository/{repositoryId}/git-gc

Kick off a global Git-GC

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
202	Accepted
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/json	object (JSON)
application/xml	anyType (XML)

Example

Request

POST /repository/{repositoryId}/git-gc
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 202 Accepted
Content-Type: application/json

                
...

GET /repository/{repositoryId}/history

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

GET /repository/{repositoryId}/history
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
...

GET /repository/{repositoryId}/nodeCount

Finds the number of nodes that the specified repository is deployed to.

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
200	Ok
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
text/plain	string

Example

Request

GET /repository/{repositoryId}/nodeCount
Content-Type: */*
Accept: text/plain

                
...

Response

HTTP/1.1 200 OK
Content-Type: text/plain

                
...

PUT /repository/{repositoryId}/prepareToUnsideline

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/json	object (JSON)
application/xml	anyType (XML)
text/plain	object

Example

Request

PUT /repository/{repositoryId}/prepareToUnsideline
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 204 No Content
Content-Type: application/json

                
...

PUT /repository/{repositoryId}/removeSkipThreshold

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description
repositoryId	path

Request Body
media type	data type
application/xml	nodeListDTO (XML)

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/removeSkipThreshold
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>

Response

HTTP/1.1 204 No Content
Content-Type: application/xml

                
...

GET /repository/{repositoryId}/replicationGroup

Get the replicationGroup associated with the given Repository Id.

Request Parameters
name	type	description	default	constraints
repositoryId	path
withPendingTransactions	query		false	boolean

Response Codes
code	condition
200	Ok
400	Bad Request - see Exception
404	Repository/ReplicationGroup not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	VCSReplicationGroupDTO (XML)

Example

Request

GET /repository/{repositoryId}/replicationGroup
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
<replicationGroup>
  <state>...</state>
  <replicationGroupName>...</replicationGroupName>
  <schedule>
    <scheduledNodeLists>
      <dayOfWeek>...</dayOfWeek>
      <hourOfDay>...</hourOfDay>
      <scheduled>...</scheduled>
      <scheduledNodes/>
      <membershipId>...</membershipId>
      <quorum>...</quorum>
    </scheduledNodeLists>
  </schedule>
  <replicationGroupIdentity>...</replicationGroupIdentity>
  <repositoryIds>...</repositoryIds>
  <scheduleManagingNodeId>...</scheduleManagingNodeId>
  <rotationSuspended>...</rotationSuspended>
  <pendingTransactions>...</pendingTransactions>
  <dsmId>...</dsmId>
  <nodes>
    <replicationGroupNodes>
      <node/>
      <role>...</role>
      <managingNode>...</managingNode>
    </replicationGroupNodes>
  </nodes>
</replicationGroup>

GET /repository/{repositoryId}/size

Get the size of the given Repository Id.

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
200	Ok
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	repositorySizeDTO (XML)

Example

Request

GET /repository/{repositoryId}/size
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
<size>
  <size>...</size>
</size>

GET /repository/{repositoryId}/skipThreshold

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	string (XML)

Example

Request

GET /repository/{repositoryId}/skipThreshold
Content-Type: application/xml
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
...

PUT /repository/{repositoryId}/startinput

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description
repositoryId	path

Request Body
media type	data type
application/xml	nodeListDTO (XML)

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/startinput
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>

Response

HTTP/1.1 204 No Content
Content-Type: application/xml

                
...

PUT /repository/{repositoryId}/startoutput

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description	default	constraints
repositoryId	path
consistencyCheck	query		false	boolean

Request Body
media type	data type
application/xml	nodeListDTO (XML)

Response Codes
code	condition
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/startoutput
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>

Response

HTTP/1.1 204 No Content
Content-Type: application/xml

                
...

GET /repository/{repositoryId}/stats

Get the Repository Statistics associated with the given Repository Id.

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
200	Ok
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	repositoryStatsDTO (XML)

Example

Request

GET /repository/{repositoryId}/stats
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
<stats>
  <revisions>
    <revision>
      <timestamp>...</timestamp>
    </revision>
  </revisions>
</stats>

PUT /repository/{repositoryId}/stophelper

Advanced use only. See User Manual for usage.

Request Parameters
name	type	constraints
repositoryId	path
helperNodeId	query
threshold	query	long

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/stophelper
Content-Type: application/xml
Accept: application/xml

                
...

Response

HTTP/1.1 204 No Content
Content-Type: application/xml

                
...

PUT /repository/{repositoryId}/stopoutput

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description
repositoryId	path

Request Body
media type	data type
application/xml	nodeListDTO (XML)

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/stopoutput
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>

Response

HTTP/1.1 204 No Content
Content-Type: application/xml

                
...

PUT /repository/{repositoryId}/uncoordinated-stopoutput

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description
repositoryId	path

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/uncoordinated-stopoutput
Content-Type: application/xml
Accept: application/xml

                
...

Response

HTTP/1.1 204 No Content
Content-Type: application/xml

                
...

PUT /repository/{repositoryId}/unsideline

Request Parameters
name	type	description
repositoryId	path
membershipId	query
resumeFrom	query

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/unsideline
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 204 No Content
Content-Type: application/xml

                
...

PUT /repository/{repositoryId}/globalReadOnly/{readOnly}

Set the globalReadOnly flag of specified repository

Request Parameters
name	type	description
readOnly	path	true/false
repositoryId	path

Response Codes
code	condition
202	Accepted
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/json	object (JSON)
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/globalReadOnly/{readOnly}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 202 Accepted
Content-Type: application/json

                
...

GET /repository/{repositoryId}/lastdelivered/{nodeName}

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description
nodeName	path
repositoryId	path

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	string (XML)

Example

Request

GET /repository/{repositoryId}/lastdelivered/{nodeName}
Content-Type: application/xml
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
...

GET /repository/{repositoryId}/lastkey/{nodeName}

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description
nodeName	path
repositoryId	path

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	string (XML)

Example

Request

GET /repository/{repositoryId}/lastkey/{nodeName}
Content-Type: application/xml
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
...

GET /repository/{repositoryId}/lastoutput/{nodeName}

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description
nodeName	path
repositoryId	path

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	string (XML)
text/plain	string

Example

Request

GET /repository/{repositoryId}/lastoutput/{nodeName}
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 200 OK
Content-Type: application/xml

                
...

PUT /repository/{repositoryId}/localReadOnly/{readOnly}

Set/Reset the local read-only on the repository. Calling this method will result in any pending proposals to be retried.

If readOnly flag is 'true', then the repository will be sent into read-only mode.

Request Parameters
name	type	description
readOnly	path
repositoryId	path

Response Codes
code	condition
202	Accepted
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/json	object (JSON)
application/xml	anyType (XML)

Response Headers
name	description
TODO	Path to relevant Task

Example

Request

PUT /repository/{repositoryId}/localReadOnly/{readOnly}
Content-Type: */*
Accept: application/json

                
...

Response

HTTP/1.1 202 Accepted
Content-Type: application/json
TODO: ...

                
...

PUT /repository/{repositoryId}/replicationGroup/{replicationGroupId}

Change the replication group associated with a repository.

Request Parameters
name	type	description	default
replicationGroupId	path
repositoryId	path

Response Codes
code	condition
202	Accepted
400	Bad Request - see Exception
404	Repository not found
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/replicationGroup/{replicationGroupId}
Content-Type: */*
Accept: application/xml

                
...

Response

HTTP/1.1 202 Accepted
Content-Type: application/xml

                
...

PUT /repository/{repositoryId}/skipThreshold/{key}

Advanced use only. See User Manual for usage.

Request Parameters
name	type	description
key	path
repositoryId	path

Request Body
media type	data type
application/xml	nodeListDTO (XML)

Response Codes
code	condition
401	Authentication required.
403	Authorization required - access forbidden

Response Body
media type	data type	description
application/xml	anyType (XML)

Example

Request

PUT /repository/{repositoryId}/skipThreshold/{key}
Content-Type: application/xml
Accept: application/xml

                
<nodes>
  <node>
    <nodeIdentity>...</nodeIdentity>
    <locationIdentity>...</locationIdentity>
    <isLocal>...</isLocal>
    <isUp>...</isUp>
    <isStopped>...</isStopped>
    <lastStatusChange>...</lastStatusChange>
    <attributes>
      <attribute/>
    </attributes>
  </node>
</nodes>

Response

HTTP/1.1 204 No Content
Content-Type: application/xml

                
...

RepositoryResource Resource

POST /repository

Example

Request

Response

DELETE /repository/deleteRepository

Example

Request

Response

GET /repository/search

Example

Request

Response

PUT /repository/setHead

Example

Request

Response

PUT /repository/stophelperall

Example

Request

Response

PUT /repository/update-config

Example

Request

Response

DELETE /repository/{repositoryId}

Example

Request

Response

GET /repository/{repositoryId}

Example

Request

Response

GET /repository/{repositoryId}/config

Example

Request

Response

GET /repository/{repositoryId}/consistencycheck

Example

Request

Response

POST /repository/{repositoryId}/consistencycheck

Example

Request

Response

POST /repository/{repositoryId}/fork_repository

Example

Request

Response

POST /repository/{repositoryId}/git-gc

Example

Request

Response

GET /repository/{repositoryId}/history

Example

Request

Response

GET /repository/{repositoryId}/nodeCount

Example

Request

Response

PUT /repository/{repositoryId}/prepareToUnsideline

Example

Request

Response

PUT /repository/{repositoryId}/removeSkipThreshold

Example

Request

Response

GET /repository/{repositoryId}/replicationGroup

Example

Request

Response

GET /repository/{repositoryId}/size

Example

Request

Response

GET /repository/{repositoryId}/skipThreshold

Example

Request