Repositories - Restore Repository From Recycle Bin

Recover a soft-deleted Git repository. Recently deleted repositories go into a soft-delete state for a period of time before they are hard deleted and become unrecoverable.

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

URI Parameters

Name In Required Type Description
organization
path True
  • string

The name of the Azure DevOps organization.

project
path True
  • string

Project ID or project name

repositoryId
path True
  • string
uuid

The ID of the repository.

api-version
query True
  • string

Version of the API to use. This should be set to '5.1-preview.1' to use this version of the api.

Request Body

Name Type Description
deleted
  • boolean

Setting to false will undo earlier deletion and restore the repository.

Responses

Name Type Description
200 OK

successful operation

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.

Definitions

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

GitRecycleBinRepositoryDetails

Name Type Description
deleted
  • boolean

Setting to false will undo earlier deletion and restore the repository.

GitRepository

Name Type Description
_links

The class to represent a collection of REST reference links.

defaultBranch
  • string
id
  • string
isFork
  • boolean

True if the repository was created as a fork

name
  • string
parentRepository
project

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

Team Project Collection where this Fork resides

id
  • string
isFork
  • boolean

True if the repository was created as a fork

name
  • string
project

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.

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.

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

Project state.

url
  • string

Url to the full version of the object.

visibility

Project visibility.