Forks - List

Service:

Git

API Version:

5.0-preview.1

Retrieve all forks of a repository in the collection.

GET https://{instance}/{collection}/{project}/_apis/git/repositories/{repositoryNameOrId}/forks/{collectionId}?api-version=5.0-preview.1

With optional parameters:

GET https://{instance}/{collection}/{project}/_apis/git/repositories/{repositoryNameOrId}/forks/{collectionId}?includeLinks={includeLinks}&api-version=5.0-preview.1

URI Parameters

Name	In	Required	Type	Description
collection	path	True	string	The name of the Azure DevOps collection.
collectionId	path	True	string uuid	Team project collection ID.
instance	path	True	string	Azure DevOps server name ({server:port})
repositoryNameOrId	path	True	string	The name or 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 '5.0-preview.1' to use this version of the api.
includeLinks	query		boolean	True to include links.

Responses

Name	Type	Description
200 OK	GitRepositoryRef[]	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	Grants the ability to read source code and metadata about commits, changesets, branches, and other version control artifacts. Also grants the ability to search code and get notified about version control events via service hooks.

Definitions

Name	Description
GitRepositoryRef
ProjectState	Project state.
ProjectVisibility	Project visibility.
TeamProjectCollectionReference	Reference object for a TeamProjectCollection.
TeamProjectReference	Represents a shallow reference to a TeamProject.

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.
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
public	string

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