Team Repositories API

Automate repository connection management for teams

The Repository Management API (released with 5.27.0) allows admins to automate repository connection management for teams.

All repo management endpoints follow this structure:

/api/team/v1/{teamId}/connections/repositories

As of 5.27.0, only Admins have permission for this endpoint.

OpenAPI reference

Get team repositories

GET

Retrieve all repository connections configured for a specific team

Authorizations

BearerAuth

AuthorizationstringRequired

JWT ID Token obtained from authentication endpoints.

Required Role: Admin

Include in the Authorization header as: Bearer {token}

Path parameters

teamIdstring · uuidRequired

The unique identifier of the team

Example: 123e4567-e89b-12d3-a456-426614174000

Responses

200

Successfully retrieved team repositories

application/json

repository_linkstringRequired

The URL or path to the repository

Example: https://github.com/example/repo

repo_typestring · enumRequired

The type of repository

Example: gitPossible values:

authentication_methodstring · enumOptional

Authentication method (Git only)

Example: httpsPossible values:

authentication_credentials_namestringOptional

Name of the credentials to use for authentication

Example: github-pat-token

view_source_link_patternstringOptional

Template pattern for generating links to view source code. Use {path} for file path and {line} for line number.

Example: https://github.com/example/repo/blob/main/{path}#L{line}

401

Unauthorized - Missing or invalid authentication token

application/json

403

Forbidden - User does not have required permissions (Admin role required)

application/json

500

Internal server error

application/json

GET

/{teamId}/connections/repositories

HTTPcURLJavaScriptPython

GET /api/team/v1/{teamId}/connections/repositories HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "repository_link": "https://github.com/example/repo1",
    "repo_type": "git",
    "authentication_method": "https",
    "authentication_credentials_name": "github-creds",
    "view_source_link_pattern": "https://github.com/example/repo1/blob/main/{path}#L{line}"
  },
  {
    "repository_link": "perforce://perforce.company.com:1666",
    "repo_type": "perforce",
    "authentication_credentials_name": "p4-creds"
  }
]

Add team repository

POST

Add a new repository connection to a team.

Git repositories can optionally include authentication_method and authentication_credentials_name. Perforce repositories require authentication_credentials_name.

Authorizations

BearerAuth

AuthorizationstringRequired

JWT ID Token obtained from authentication endpoints.

Required Role: Admin

Include in the Authorization header as: Bearer {token}

Path parameters

teamIdstring · uuidRequired

The unique identifier of the team

Example: 123e4567-e89b-12d3-a456-426614174000

Body

application/json

repository_linkstringRequired

The URL or path to the repository

Example: https://github.com/example/repo

repo_typestring · enumRequired

The type of repository

Example: gitPossible values:

authentication_methodstring · enumOptional

Authentication method for Git repositories. Optional for Git, not applicable for Perforce.

Example: httpsPossible values:

authentication_credentials_namestringOptional

Name of the credentials to use for authentication. Optional for Git, required for Perforce.

Example: github-pat-token

view_source_link_patternstringOptional

Template pattern for generating links to view source code. Use {path} for file path and {line} for line number. Optional for both Git and Perforce.

Example: https://github.com/example/repo/blob/main/{path}#L{line}

Responses

200

Repository connection successfully added

application/json

repository_linkstringRequired

The URL or path to the repository

Example: https://github.com/example/repo

repo_typestring · enumRequired

The type of repository

Example: gitPossible values:

authentication_methodstring · enumOptional

Authentication method (Git only)

Example: httpsPossible values:

authentication_credentials_namestringOptional

Name of the credentials to use for authentication

Example: github-pat-token

view_source_link_patternstringOptional

Template pattern for generating links to view source code. Use {path} for file path and {line} for line number.

Example: https://github.com/example/repo/blob/main/{path}#L{line}

201

Repository connection successfully created

application/json

400

Bad request - Invalid input parameters

application/json

401

Unauthorized - Missing or invalid authentication token

application/json

403

Forbidden - User does not have required permissions (Admin role required)

application/json

409

Repository connection already exists

application/json

500

Internal server error

application/json

POST

/{teamId}/connections/repositories

HTTPcURLJavaScriptPython

POST /api/team/v1/{teamId}/connections/repositories HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 236

{
  "repository_link": "https://github.com/example/repo",
  "repo_type": "git",
  "authentication_method": "https",
  "authentication_credentials_name": "github-pat",
  "view_source_link_pattern": "https://github.com/example/repo/blob/main/{path}#L{line}"
}

{
  "repository_link": "https://github.com/example/repo",
  "repo_type": "git",
  "authentication_method": "https",
  "authentication_credentials_name": "github-pat-token",
  "view_source_link_pattern": "https://github.com/example/repo/blob/main/{path}#L{line}"
}

Edit team repository

PUT

Update an existing repository connection. All fields are optional - only provided fields will be updated (partial update).

Authorizations

BearerAuth

AuthorizationstringRequired

JWT ID Token obtained from authentication endpoints.

Required Role: Admin

Include in the Authorization header as: Bearer {token}

Path parameters

teamIdstring · uuidRequired

The unique identifier of the team

Example: 123e4567-e89b-12d3-a456-426614174000

repositoryLinkstringRequired

The full repository link/URL. Can contain slashes and special characters. This should match the repository_link used when adding the repository.

Example: {"value":"https://github.com/example/repo","summary":"GitHub HTTPS URL"}

Body

application/json

All fields are optional for editing (partial update)

repo_typestring · enumOptional

The type of repository

Example: gitPossible values:

authentication_methodstring · enumOptional

Authentication method for Git repositories

Example: sshPossible values:

authentication_credentials_namestringOptional

Name of the credentials to use for authentication

Example: github-ssh-key

view_source_link_patternstringOptional

Template pattern for generating links to view source code. Use {path} for file path and {line} for line number.

Example: https://github.com/example/repo/blob/develop/{path}#L{line}

Responses

200

Repository connection successfully updated

application/json

repository_linkstringRequired

The URL or path to the repository

Example: https://github.com/example/repo

repo_typestring · enumRequired

The type of repository

Example: gitPossible values:

authentication_methodstring · enumOptional

Authentication method (Git only)

Example: httpsPossible values:

authentication_credentials_namestringOptional

Name of the credentials to use for authentication

Example: github-pat-token

view_source_link_patternstringOptional

Template pattern for generating links to view source code. Use {path} for file path and {line} for line number.

Example: https://github.com/example/repo/blob/main/{path}#L{line}

400

Bad request - Invalid input parameters

application/json

401

Unauthorized - Missing or invalid authentication token

application/json

403

Forbidden - User does not have required permissions (Admin role required)

application/json

404

Repository connection not found

application/json

500

Internal server error

application/json

PUT

/{teamId}/connections/repositories/{repositoryLink}

HTTPcURLJavaScriptPython

PUT /api/team/v1/{teamId}/connections/repositories/{repositoryLink} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 79

{
  "authentication_method": "ssh",
  "authentication_credentials_name": "new-ssh-key"
}

{
  "repository_link": "https://github.com/example/repo",
  "repo_type": "git",
  "authentication_method": "https",
  "authentication_credentials_name": "github-pat-token",
  "view_source_link_pattern": "https://github.com/example/repo/blob/main/{path}#L{line}"
}

Delete team repository

DELETE

Remove a repository connection from a team

Authorizations

BearerAuth

AuthorizationstringRequired

JWT ID Token obtained from authentication endpoints.

Required Role: Admin

Include in the Authorization header as: Bearer {token}

Path parameters

teamIdstring · uuidRequired

The unique identifier of the team

Example: 123e4567-e89b-12d3-a456-426614174000

repositoryLinkstringRequired

The full repository link/URL. Can contain slashes and special characters. This should match the repository_link used when adding the repository.

Example: {"value":"https://github.com/example/repo","summary":"GitHub HTTPS URL"}

Responses

200

Repository connection successfully deleted

application/json

messagestringOptionalExample: Repository connection deleted successfully

204

Repository connection successfully deleted (no content)

400

Bad request - Invalid input parameters

application/json

401

Unauthorized - Missing or invalid authentication token

application/json

403

Forbidden - User does not have required permissions (Admin role required)

application/json

404

Repository connection not found

application/json

500

Internal server error

application/json

DELETE

/{teamId}/connections/repositories/{repositoryLink}

HTTPcURLJavaScriptPython

DELETE /api/team/v1/{teamId}/connections/repositories/{repositoryLink} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "message": "Repository connection deleted successfully"
}

Field Descriptions

Common Fields

Field	Type	Required	Description
repo_type	string	Yes	Repository type: "git" or "perforce"
repository_link	string	Yes	Git: Repository URL (SSH or HTTPS format)<br>Perforce: Depot path (e.g., //depot/main)
latest_status	string	Read-only	Current indexing status (see Status Values below)
last_indexed_successfully	string or null	Read-only	ISO 8601 timestamp of last successful indexing, or null if never indexed

Git-Specific Fields

Field	Type	Required	Description
authentication_method	string	Yes	"ssh" or "https"
authentication_credentials_name	string	Conditional	Required when authentication_method is "https"<br>Must match an existing HTTP credential name for the team
view_source_link_pattern	string	No	URL pattern for viewing source code<br>Supports placeholders: {sha}, {path}, {line}

Perforce-Specific Fields

Field	Type	Required	Description
authentication_credentials_name	string	Yes	Must match an existing Perforce credential name for the team
view_source_link_pattern	string	No	Currently not used for Perforce

Status Values

The latest_status field can have the following values:

Status	Description
pending	Repository is queued for initial indexing
cloning	Repository is being cloned (Git only)
indexing	Repository is currently being indexed
success	Repository was successfully indexed
failed	Last indexing attempt failed

Perforce depots typically skip the cloning status and go directly to indexing.