Repositories - Update

Reference

Service:: Git

API Version:: 7.1-preview.1

Updates the Git repository with either a new repo name or a new default branch.

PATCH https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}?api-version=7.1-preview.1

URI Parameters

Name	In	Required	Type	Description
organization	path	True	string	The name of the Azure DevOps organization.
repositoryId	path	True	string uuid	The ID of the repository.
project	path		string	Project ID or project name
api-version	query	True	string	Version of the API to use. This should be set to '7.1-preview.1' to use this version of the api.

Request Body

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
defaultBranch	string
id	string
isDisabled	boolean	True if the repository is disabled. False otherwise.
isFork	boolean	True if the repository was created as a fork.
isInMaintenance	boolean	True if the repository is in maintenance. False otherwise.
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Represents a shallow reference to a TeamProject.
remoteUrl	string
size	integer	Compressed size (bytes) of the repository.
sshUrl	string
url	string
validRemoteUrls	string[]
webUrl	string

Responses

Name	Type	Description
200 OK	GitRepository	The operation succeeded. The response contains the updated repository information.

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Description
vso.code_manage	Grants the ability to read, update, and delete source code, access metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to create and manage code repositories, create and manage pull requests and code reviews, and to receive notifications about version control events via service hooks.

Examples

Disable repository

Update a respository while specifying the project

Update a respository without specifying the project

Disable repository

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6?api-version=7.1-preview.1

{
  "isDisabled": true
}

Sample Response

Status code:: 200

{
  "id": "5febef5a-833d-4e14-b9c0-14cb638f91e6",
  "name": "RenamedRepository",
  "RenamedRepository": true,
  "isDisabled": true,
  "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6",
  "project": {
    "id": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
    "name": "Fabrikam-Fiber-Git",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
    "state": "wellFormed"
  },
  "defaultBranch": "refs/heads/live",
  "remoteUrl": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_git/RenamedRepository",
  "type": "normal"
}

Update a respository while specifying the project

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6?api-version=7.1-preview.1

{
  "name": "RenamedRepository",
  "defaultBranch": "refs/heads/live"
}

Sample Response

Status code:: 200

{
  "id": "5febef5a-833d-4e14-b9c0-14cb638f91e6",
  "name": "RenamedRepository",
  "isDisabled": false,
  "url": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6",
  "project": {
    "id": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
    "name": "Fabrikam-Fiber-Git",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
    "state": "wellFormed"
  },
  "defaultBranch": "refs/heads/live",
  "remoteUrl": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_git/RenamedRepository",
  "type": "normal"
}

Update a respository without specifying the project

Sample Request

HTTP

PATCH https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6?api-version=7.1-preview.1

{
  "name": "RenamedRepository",
  "defaultBranch": "refs/heads/live"
}

Sample Response

Status code:: 200

{
  "id": "5febef5a-833d-4e14-b9c0-14cb638f91e6",
  "name": "RenamedRepository",
  "isDisabled": false,
  "url": "https://dev.azure.com/fabrikam/_apis/git/repositories/5febef5a-833d-4e14-b9c0-14cb638f91e6",
  "project": {
    "id": "6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
    "name": "Fabrikam-Fiber-Git",
    "url": "https://dev.azure.com/fabrikam/_apis/projects/6ce954b1-ce1f-45d1-b94d-e6bf2464ba2c",
    "state": "wellFormed"
  },
  "defaultBranch": "refs/heads/live",
  "remoteUrl": "https://dev.azure.com/fabrikam/Fabrikam-Fiber-Git/_git/RenamedRepository",
  "type": "normal"
}

Definitions

Name	Description
GitRepository
GitRepositoryRef
ProjectState	Project state.
ProjectVisibility	Project visibility.
ReferenceLinks	The class to represent a collection of REST reference links.
TeamProjectCollectionReference	Reference object for a TeamProjectCollection.
TeamProjectReference	Represents a shallow reference to a TeamProject.

GitRepository

Name	Type	Description
_links	ReferenceLinks	The class to represent a collection of REST reference links.
defaultBranch	string
id	string
isDisabled	boolean	True if the repository is disabled. False otherwise.
isFork	boolean	True if the repository was created as a fork.
isInMaintenance	boolean	True if the repository is in maintenance. False otherwise.
name	string
parentRepository	GitRepositoryRef
project	TeamProjectReference	Represents a shallow reference to a TeamProject.
remoteUrl	string
size	integer	Compressed size (bytes) of the repository.
sshUrl	string
url	string
validRemoteUrls	string[]
webUrl	string

GitRepositoryRef

Name	Type	Description
collection	TeamProjectCollectionReference	Team Project Collection where this Fork resides
id	string
isFork	boolean	True if the repository was created as a fork
name	string
project	TeamProjectReference	Represents a shallow reference to a TeamProject.
remoteUrl	string
sshUrl	string
url	string

ProjectState

Project state.

Name	Type	Description
all	string	All projects regardless of state except Deleted.
createPending	string	Project has been queued for creation, but the process has not yet started.
deleted	string	Project has been deleted.
deleting	string	Project is in the process of being deleted.
new	string	Project is in the process of being created.
unchanged	string	Project has not been changed.
wellFormed	string	Project is completely created and ready to use.

ProjectVisibility

Project visibility.

Name	Type	Description
private	string	The project is only visible to users with explicit access.
public	string	The project is visible to all.

ReferenceLinks

The class to represent a collection of REST reference links.

Name	Type	Description
links	object	The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.

TeamProjectCollectionReference

Reference object for a TeamProjectCollection.

Name	Type	Description
avatarUrl	string	Collection avatar Url.
id	string	Collection Id.
name	string	Collection Name.
url	string	Collection REST Url.

TeamProjectReference

Represents a shallow reference to a TeamProject.

Name	Type	Description
abbreviation	string	Project abbreviation.
defaultTeamImageUrl	string	Url to default team identity image.
description	string	The project's description (if any).
id	string	Project identifier.
lastUpdateTime	string	Project last update time.
name	string	Project name.
revision	integer	Project revision.
state	ProjectState	Project state.
url	string	Url to the full version of the object.
visibility	ProjectVisibility	Project visibility.

Repositories - Update

URI Parameters

Request Body

Responses

Security

oauth2

Scopes

Examples

Disable repository

Sample Request

Sample Response

Update a respository while specifying the project

Sample Request

Sample Response

Update a respository without specifying the project

Sample Request

Sample Response

Definitions

GitRepository

GitRepositoryRef

ProjectState

ProjectVisibility

ReferenceLinks

TeamProjectCollectionReference

TeamProjectReference

Feedback

Additional resources