JetBrains Space Help

Projects

Create project

post /api/http/projects

Create a new project.

Request arguments
object with fields:

  • key: ProjectKey( Required )

  • name: string( Required )

  • description: string( Nullable and Optional , defaults to null)

  • private: boolean( Optional , defaults to false)

  • tags: array of string( Optional , defaults to [])

Response
PR_Project

Get all projects

get /api/http/projects

Get/search all projects. Parameters are applied as 'AND' filters.

Request arguments
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
term: string (Query) ( Nullable and Optional , defaults to null)
tag: string (Query) ( Nullable and Optional , defaults to null)
starred: boolean (Query) ( Nullable and Optional , defaults to null)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PR_Project( Required )

Get all projects by member

get /api/http/projects/member:{member}

Get all projects for a member.

Request arguments
member: string in one of the formats

  • me

  • id: string

  • username: string

(Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PR_Project( Required )

Get all projects with right

get /api/http/projects/right-code:{rightCode}
Request arguments
rightCode: string (Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
term: string (Query) ( Nullable and Optional , defaults to null)
path: string (Query) ( Nullable and Optional , defaults to null)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PR_Project( Required )

Get all projects by team

get /api/http/projects/team:{team}

Get all projects for a team.

Request arguments
team: string (Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PR_Project( Required )

Get project

get /api/http/projects/{project}

Get project by id or project key.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
PR_Project

Update project

patch /api/http/projects/{project}

Update an existing project. Optional parameters will be ignored when not specified, and updated otherwise.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • key: ProjectKey( Nullable and Optional , defaults to null)

  • name: string( Nullable and Optional , defaults to null)

  • description: string( Nullable and Optional , defaults to null)

  • private: boolean( Nullable and Optional , defaults to null)

  • tags: array of string( Nullable and Optional , defaults to null)

  • icon: string( Nullable and Optional )

Response
PR_Project

Archive project

delete /api/http/projects/{project}

Archive a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
No arguments

Stop

post /api/http/projects/automation/graph-executions/{id}/stop

Stop execution by ExecutionId.

Rights, that may be checked: Stop

Request arguments
id: string (Path) ( Required )
Response
No arguments

Get graph execution

get /api/http/projects/automation/graph-executions/{id}

Rights, that may be checked: View

Request arguments
id: string (Path) ( Required )
Response
JobExecutionDTO

Get parameter

get /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}
Request arguments
stepExecId: string (Path) ( Required )
key: string (Path) ( Required )
Response
string

Update parameter

patch /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}
Request arguments
stepExecId: string (Path) ( Required )
key: string (Path) ( Required )
object with fields:

  • value: string( Required )

Response
No arguments

Delete parameter

delete /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}
Request arguments
stepExecId: string (Path) ( Required )
key: string (Path) ( Required )
Response
No arguments

Create param

post /api/http/projects/params

Create a new project parameter in a parameter bundle

Rights, that may be checked: Modify parameters

Request arguments
object with fields:

  • bundleId: string( Required )

  • key: string( Required )

  • value: string( Required )

Response
string

Get all params

get /api/http/projects/params

List project parameters in a parameter bundle

Rights, that may be checked: View parameters

Request arguments
bundleId: string (Query) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PlainParameterRecord( Required )

Update param

patch /api/http/projects/params/{id}

Update an existing project parameter.

Rights, that may be checked: Modify parameters

Request arguments
id: string (Path) ( Required )
object with fields:

  • value: string( Required )

Response
No arguments

Delete param

delete /api/http/projects/params/{id}

Delete an existing project parameter.

Rights, that may be checked: Delete parameters

Request arguments
id: string (Path) ( Required )
Response
No arguments

Create in default bundle

post /api/http/projects/params/in-default-bundle

Create a new project parameter in the default parameter bundle

Rights, that may be checked: Modify parameters

Request arguments
object with fields:

  • projectId: string( Required )

  • key: string( Required )

  • value: string( Required )

Response
string

Request access to project

post /api/http/projects/private-projects/{project}/request-access

Request access to a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
No arguments

Get all private projects

get /api/http/projects/private-projects

List private projects in the current organisation.

Request arguments
No arguments
Response
array of PR_PrivateProject

Add responsibility

post /api/http/projects/responsibilities

Add a responsibility for a given subject id.

Request arguments
object with fields:

  • subjectId: string( Required )

  • summary: string( Required )

  • notes: string( Nullable and Optional , defaults to null)

Response
string

Update responsibility

patch /api/http/projects/responsibilities/{responsibilityId}

Edit an existing responsibility.

Request arguments
responsibilityId: string (Path) ( Required )
object with fields:

  • summary: string( Required )

  • notes: string( Nullable and Optional , defaults to null)

Response
No arguments

Delete responsibility

delete /api/http/projects/responsibilities/{responsibilityId}

Delete an existing responsibility.

Request arguments
responsibilityId: string (Path) ( Required )
Response
No arguments

Delete responsibility subject

delete /api/http/projects/responsibilities/subjects/{subjectId}

Delete an existing responsibility subject for a given project id.

Request arguments
subjectId: string (Path) ( Required )
project: string in one of the formats

  • id: string

  • key: string

(Query) ( Nullable and Optional , defaults to null)
Response
No arguments

Create secret

post /api/http/projects/secrets

Create a new secret in a parameter bundle. Value is base64 encoded bytes of the secret value, possibly after client side encryption. If the secret value bytes are encrypted then the id of the Space public key must be provided

Rights, that may be checked: Create secrets

Request arguments
object with fields:

  • bundleId: string( Required )

  • key: string( Required )

  • valueBase64: string( Required )

  • publicKeyId: string( Nullable and Optional , defaults to null)

Response
string

Get all secrets

get /api/http/projects/secrets

List project secrets in a parameter bundle

Rights, that may be checked: View keys of secrets

Request arguments
bundleId: string (Query) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of SecretParameterRecord( Required )

Update secret

patch /api/http/projects/secrets/{id}

Update an existing project secret.

Rights, that may be checked: Edit secrets

Request arguments
id: string (Path) ( Required )
object with fields:

  • valueBase64: string( Required )

  • publicKeyId: string( Nullable and Optional , defaults to null)

Response
No arguments

Delete secret

delete /api/http/projects/secrets/{id}

Delete an existing project secret.

Rights, that may be checked: Delete secrets

Request arguments
id: string (Path) ( Required )
Response
No arguments

Create in default bundle

post /api/http/projects/secrets/in-default-bundle

Create a new secret in the default parameter bundle. Value is base64 encoded bytes of the secret value, possibly after client side encryption. If the secret value bytes are encrypted then the id of the Space public key must be provided

Rights, that may be checked: Create secrets

Request arguments
object with fields:

  • projectId: string( Required )

  • key: string( Required )

  • valueBase64: string( Required )

  • publicKeyId: string( Nullable and Optional , defaults to null)

Response
string

Track tag access

post /api/http/projects/tags/track-access

Track a tag has been accessed.

Request arguments
object with fields:

  • tag: string( Required )

Response
No arguments

Get all tags

get /api/http/projects/tags

List all tags, mapped to the number of projects they are used in.

Request arguments
No arguments
Response
array of PR_Tag

Get all admins

get /api/http/projects/{project}/access/admins

Returns the list of all project administrators

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
array of TD_MemberProfile

Add administrator

post /api/http/projects/{project}/access/admins/profiles

Add a member as administrator to a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:
Response
No arguments

Remove administrator

delete /api/http/projects/{project}/access/admins/profiles/{profile}

Remove a member as administrator from a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
profile: string in one of the formats

  • me

  • id: string

  • username: string

(Path) ( Required )
Response
No arguments

Add administrators team

post /api/http/projects/{project}/access/admins/teams

Add a team as administrators to a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • teamId: string( Required )

Response
No arguments

Remove administrators team

delete /api/http/projects/{project}/access/admins/teams/{teamId}

Remove a team as administrators from a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
teamId: string (Path) ( Required )
Response
No arguments

Get all collaborators' profiles

get /api/http/projects/{project}/access/collaborators
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
array of TD_MemberProfile

Add a collaborator

post /api/http/projects/{project}/access/collaborators/profiles
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:
Response
No arguments

Get all individual collaborators

get /api/http/projects/{project}/access/collaborators/profiles
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
array of TD_MemberProfile

Remove an individual collaborators

delete /api/http/projects/{project}/access/collaborators/profiles
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
profile: string in one of the formats

  • me

  • id: string

  • username: string

(Query) ( Required )
Response
No arguments

Add a collaborators team

post /api/http/projects/{project}/access/collaborators/teams
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • teamId: string( Required )

Response
No arguments

Get all collaborators teams

get /api/http/projects/{project}/access/collaborators/teams
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
array of TD_Team

Remove a collaborators team

delete /api/http/projects/{project}/access/collaborators/teams
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
teamId: string (Query) ( Required )
Response
No arguments

Get all member profiles

get /api/http/projects/{project}/access/member-profiles

Get project members for a given project key.

Rights, that may be checked: View project data

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
query: string (Query) ( Optional , defaults to "")
includingAdmins: boolean (Query) ( Optional , defaults to false)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of TD_MemberProfile( Required )

Add member

post /api/http/projects/{project}/access/members/profiles

Add a member to a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:
Response
No arguments

Remove member

delete /api/http/projects/{project}/access/members/profiles/{profile}

Remove a member from a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
profile: string in one of the formats

  • me

  • id: string

  • username: string

(Path) ( Required )
Response
No arguments

Add team

post /api/http/projects/{project}/access/members/teams

Add a team to a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • teamId: string( Required )

Response
No arguments

Remove team

delete /api/http/projects/{project}/access/members/teams/{teamId}

Remove a team from a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
teamId: string (Path) ( Required )
Response
No arguments

Organization profiles who can view the project

get /api/http/projects/{project}/access/viewers

Get organization members who can view a project.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
term: string (Query) ( Required )
meOnTop: boolean (Query) ( Optional , defaults to false)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of TD_MemberProfile( Required )

Get all graph executions

get /api/http/projects/{project}/automation/graph-executions

Search executions. Parameters are applied as 'AND' filters.

Rights, that may be checked: View

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
jobId: string (Query) ( Required )
branchFilter: string (Query) ( Nullable and Optional , defaults to null)
statusFilter: ExecutionStatus (Query) ( Nullable and Optional , defaults to null)
jobTriggerFilter: JobTriggerType (Query) ( Nullable and Optional , defaults to null)
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of JobExecutionDTO( Required )

Start

post /api/http/projects/{project}/automation/jobs/{jobId}/start

Start Job. Returns Execution id, see projects/automation/graph-executions/{id}

Rights, that may be checked: Start

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
jobId: string (Path) ( Required )
object with fields:
Response
LaunchResult

Get all jobs

get /api/http/projects/{project}/automation/jobs

Search jobs. Parameters are applied as 'AND' filters.

Rights, that may be checked: View

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repoFilter: string (Query) ( Required )
branchFilter: string (Query) ( Required )
trigger: JobTriggerType (Query) ( Nullable and Optional , defaults to null)
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of JobDTO( Required )

Get job

get /api/http/projects/{project}/automation/jobs/{jobId}

Rights, that may be checked: View

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
jobId: string (Path) ( Required )
Response
JobDTO

Get all code reviews

get /api/http/projects/{project}/code-reviews
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
state: CodeReviewStateFilter (Query) ( Nullable and Optional , defaults to "Opened")
text: string (Query) ( Nullable and Optional , defaults to null)
author: string in one of the formats

  • me

  • id: string

  • username: string

(Query) ( Nullable and Optional , defaults to null)
from: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)
to: string (format: full-date) (Query) ( Nullable and Optional , defaults to null)
sort: ReviewSorting (Query) ( Optional , defaults to "CreatedAtAsc")
reviewer: string in one of the formats

  • me

  • id: string

  • username: string

(Query) ( Nullable and Optional , defaults to null)
type: ReviewType (Query) ( Nullable and Optional , defaults to null)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of CodeReviewWithCount( Required )

Get review counts

get /api/http/projects/{project}/code-reviews/review-counts
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
ReviewCounts

Get code review

get /api/http/projects/{project}/code-reviews/{reviewId}
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
Response
CodeReviewRecord

Get review details

get /api/http/projects/{project}/code-reviews/{reviewId}/details
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
Response
CodeReviewDetailedInfo

Add review participant

post /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
user: string in one of the formats

  • me

  • id: string

  • username: string

(Path) ( Required )
object with fields:
Response
No arguments

Remove review participant

delete /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
user: string in one of the formats

  • me

  • id: string

  • username: string

(Path) ( Required )
role: CodeReviewParticipantRole (Query) ( Required )
Response
No arguments

Add revisions to review

post /api/http/projects/{project}/code-reviews/{reviewId}/revisions
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
object with fields:
Response
No arguments

Remove revisions from review

delete /api/http/projects/{project}/code-reviews/{reviewId}/revisions
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
revisions: array of string (Query) ( Required )
Response
No arguments

Edit review state

patch /api/http/projects/{project}/code-reviews/{reviewId}/state
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
object with fields:
Response
No arguments

Get all suggested reviewers

get /api/http/projects/{project}/code-reviews/{reviewId}/suggested-reviewers
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
Response
array of TD_MemberProfile

Edit review title

patch /api/http/projects/{project}/code-reviews/{reviewId}/title
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
object with fields:

  • title: string( Required )

Response
No arguments

Get all unread revisions

get /api/http/projects/{project}/code-reviews/{reviewId}/unread-revisions
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
reviewId: string in one of the formats

  • id: string

  • key: string

  • number: integer (format: int32)

(Path) ( Required )
Response
array of RevisionInReview

Create new repository

post /api/http/projects/{project}/packages/repositories

Creates a new package repository for a given project id.

Rights, that may be checked: Create

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • type: string( Required )

  • name: string( Required )

  • description: string( Nullable and Optional , defaults to null)

  • public: boolean( Required )

  • settings: ES_PackageRepositorySettings( Required )

  • mirror: PackageRepositoryMirror( Nullable and Optional , defaults to null)

Response
ProjectPackageRepository

Get repositories

get /api/http/projects/{project}/packages/repositories

Gets a list of package repositories for a given project id.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
type: string (Query) ( Nullable and Optional , defaults to null)
query: string (Query) ( Nullable and Optional , defaults to null)
Response
array of ProjectPackageRepository

Get repository

get /api/http/projects/{project}/packages/repositories/{repository}

Gets a package repository for a given project id by type and name.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
ProjectPackageRepository

Update repository

patch /api/http/projects/{project}/packages/repositories/{repository}

Updates package repository settings for a given project id.

Rights, that may be checked: Admin

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • name: string( Nullable and Optional , defaults to null)

  • description: string( Nullable and Optional , defaults to null)

  • public: boolean( Nullable and Optional , defaults to null)

  • settings: ES_PackageRepositorySettings( Nullable and Optional , defaults to null)

Response
No arguments

Delete repository

delete /api/http/projects/{project}/packages/repositories/{repository}

Removes package repository for a given project id.

Rights, that may be checked: Admin

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
No arguments

Get all packages

get /api/http/projects/{project}/packages/repositories/{repository}/packages

Gets a list of repository packages for a given project id.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
query: string (Query) ( Required )
mirrorId: string (Query) ( Nullable and Optional , defaults to null)
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PackageData( Required )

Get all package versions

get /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions

Gets a list of repository package versions for a given project id.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
packageName: string (Path) ( Required )
query: string (Query) ( Required )
mirrorId: string (Query) ( Nullable and Optional , defaults to null)
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PackageVersionData( Required )

Get package version details

get /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions/version:{packageVersion}

Gets a details for repository package version for a given project id.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
packageName: string (Path) ( Required )
packageVersion: string (Path) ( Required )
Response
PackageVersionDetails

Delete package version

delete /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions/version:{packageVersion}

Removes a package version in repository for a given project id.

Rights, that may be checked: Write

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
packageName: string (Path) ( Required )
packageVersion: string (Path) ( Required )
Response
No arguments

Get repository url

get /api/http/projects/{project}/packages/repositories/{repository}/url

Gets a package repository URL for a given project id.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
string

Get all packages

get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages

Gets a list of repository packages for a given project id.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
type: string (Path) ( Required )
repositoryName: string (Path) ( Required )
query: string (Query) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PackageData( Required )

Get all package versions

get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions

Gets a list of repository package versions for a given project id.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
type: string (Path) ( Required )
repositoryName: string (Path) ( Required )
packageName: string (Path) ( Required )
query: string (Query) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PackageVersionData( Required )

Get package version details

get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions/version:{packageVersion}

Gets a details for repository package version for a given project id.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
type: string (Path) ( Required )
repositoryName: string (Path) ( Required )
packageName: string (Path) ( Required )
packageVersion: string (Path) ( Required )
Response
PackageVersionDetails

Delete package version

delete /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions/version:{packageVersion}

Removes a package version in repository for a given project id.

Rights, that may be checked: Write

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
type: string (Path) ( Required )
repositoryName: string (Path) ( Required )
packageName: string (Path) ( Required )
packageVersion: string (Path) ( Required )
Response
No arguments

Find packages in repository

get /api/http/projects/{project}/packages/search

Executes a package search for a given project id.

Rights, that may be checked: Read

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
type: string (Query) ( Required )
query: string (Query) ( Required )
mirrorId: string (Query) ( Nullable and Optional , defaults to null)
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PackageVersionData( Required )

Get all types

get /api/http/projects/{project}/packages/types

Creates a new package repository for a given project id.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
array of PackageType

Create checklist

post /api/http/projects/{project}/planning/checklists
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • name: string( Required )

Response
Checklist

Get all checklists

get /api/http/projects/{project}/planning/checklists
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
query: string (Query) ( Nullable and Optional , defaults to null)
sorting: ChecklistSorting (Query) ( Optional , defaults to "UPDATED")
descending: boolean (Query) ( Optional , defaults to false)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of Checklist( Required )

Import checklist

post /api/http/projects/{project}/planning/checklists/import
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • name: string( Required )

  • tabIndentedLines: string( Required )

Response
Checklist

Import checklist lines

post /api/http/projects/{project}/planning/checklists/{checklistId}/import
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
checklistId: string (Path) ( Required )
object with fields:

  • targetParentId: string( Required )

  • afterItemId: string( Nullable and Optional , defaults to null)

  • tabIndentedLines: string( Required )

Response
No arguments

Update checklist

patch /api/http/projects/{project}/planning/checklists/{checklistId}
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
checklistId: string (Path) ( Required )
object with fields:

  • name: string( Optional )

  • description: string( Nullable and Optional )

  • owner: string( Nullable and Optional )

  • tag: string( Nullable and Optional )

Response
No arguments

Delete checklist

delete /api/http/projects/{project}/planning/checklists/{checklistId}
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
checklistId: string (Path) ( Required )
Response
No arguments

Get all starred checklists

get /api/http/projects/{project}/planning/checklists/starred
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
array of Checklist

Get full checklist tree

get /api/http/projects/{project}/planning/checklists/{checklistId}/full-checklist-tree
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
checklistId: string (Path) ( Required )
Response
array of PlanItemChildren

Create issue

post /api/http/projects/{project}/planning/issues

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • title: string( Required )

  • description: string( Nullable and Optional , defaults to null)

  • assignee: ProfileIdentifier( Nullable and Optional , defaults to null)

  • status: string( Required )

  • dueDate: string (format: full-date)( Nullable and Optional , defaults to null)

  • tags: array of string( Optional , defaults to [])

  • checklists: array of string( Optional , defaults to [])

  • sprints: array of string( Optional , defaults to [])

  • attachments: array of Attachment( Nullable and Optional , defaults to [])

  • fromMessage: MessageLink( Nullable and Optional , defaults to null)

  • customFields: array of CustomFieldValue( Nullable and Optional , defaults to null)

Response
Issue

Get all issues

get /api/http/projects/{project}/planning/issues

Rights, that may be checked: View issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
assigneeId: array of ProfileIdentifier (Query) ( Required )
createdByProfileId: string in one of the formats

  • me

  • id: string

  • username: string

(Query) ( Nullable and Optional , defaults to null)
statuses: array of string (Query) ( Required )
tagId: string (Query) ( Nullable and Optional , defaults to null)
query: string (Query) ( Nullable and Optional , defaults to null)
sorting: IssuesSorting (Query) ( Required )
descending: boolean (Query) ( Required )
tags: array of string (Query) ( Nullable and Optional , defaults to null)
customFields: array of string (Query) ( Nullable and Optional , defaults to null)
importTransaction: string (Query) ( Nullable and Optional , defaults to null)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of Issue( Required )

Toggle issue resolved

post /api/http/projects/{project}/planning/issues/{issueId}/toggle-resolved

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
object with fields:

  • resolved: boolean( Required )

Response
No arguments

Get issue by number

get /api/http/projects/{project}/planning/issues/number:{number}

Rights, that may be checked: View issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
number: integer (format: int32) (Path) ( Required )
Response
Issue

Update issue

patch /api/http/projects/{project}/planning/issues/{issueId}

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
object with fields:

  • title: string( Optional )

  • description: string( Nullable and Optional )

  • assignee: string( Nullable and Optional )

  • status: string( Optional )

  • dueDate: string (format: full-date)( Nullable and Optional )

Response
No arguments

Delete issue

delete /api/http/projects/{project}/planning/issues/{issueId}

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
Response
No arguments

Get all issue statuses

get /api/http/projects/{project}/planning/issues/statuses

Rights, that may be checked: View issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
array of IssueStatus

Update status

patch /api/http/projects/{project}/planning/issues/statuses

Rights, that may be checked: Manage issues statuses

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:
Response
No arguments

Get issue status distribution

get /api/http/projects/{project}/planning/issues/statuses/distribution

Rights, that may be checked: View issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
array of IssueStatusWithUsages

Add attachments

post /api/http/projects/{project}/planning/issues/{issueId}/attachments

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
object with fields:
Response
No arguments

Remove attachments

delete /api/http/projects/{project}/planning/issues/{issueId}/attachments

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
identities: array of string (Query) ( Required )
Response
No arguments

Add issue checklist

post /api/http/projects/{project}/planning/issues/{issueId}/checklists/{checklistId}

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
checklistId: string (Path) ( Required )
Response
No arguments

Remove issue checklist

delete /api/http/projects/{project}/planning/issues/{issueId}/checklists/{checklistId}

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
checklistId: string (Path) ( Required )
Response
No arguments

Import issue comment history

post /api/http/projects/{project}/planning/issues/{issueId}/comments/import

Rights, that may be checked: View issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
object with fields:
Response
array of string

Add issue tag

post /api/http/projects/{project}/planning/issues/{issueId}/tags/{tagId}

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
tagId: string (Path) ( Required )
Response
No arguments

Remove issue tag

delete /api/http/projects/{project}/planning/issues/{issueId}/tags/{tagId}

Rights, that may be checked: Edit issues

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
issueId: string (Path) ( Required )
tagId: string (Path) ( Required )
Response
No arguments

Create hierarchical tag

post /api/http/projects/{project}/planning/tags
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • parentTagId: string( Nullable and Optional , defaults to null)

  • path: array of string( Required )

Response
PlanningTag

Get all hierarchical tags

get /api/http/projects/{project}/planning/tags
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
query: string (Query) ( Nullable and Optional , defaults to null)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of PlanningTag( Required )

Create new repository

post /api/http/projects/{project}/repositories/{repository}
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string (Path) ( Required )
object with fields:

  • description: string( Optional , defaults to "")

  • defaultBranch: string( Nullable and Optional , defaults to null)

  • initialize: boolean( Optional , defaults to true)

  • defaultSetup: boolean( Optional , defaults to false)

Response
PR_RepositoryInfo

Delete repository

delete /api/http/projects/{project}/repositories/{repository}
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string (Path) ( Required )
Response
No arguments

Invoke garbage collection on repository [not available in multi-org mode]

post /api/http/projects/{project}/repositories/{repository}/gc
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string (Path) ( Required )
Response
No arguments

Create commit set review

post /api/http/projects/{project}/repositories/{repository}/commit-set-reviews
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string (Path) ( Required )
object with fields:

  • revisions: array of string( Required )

  • title: string( Nullable and Optional , defaults to null)

Response
CommitSetReviewRecord

Create merge request

post /api/http/projects/{project}/repositories/{repository}/merge-requests
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string (Path) ( Required )
object with fields:

  • sourceBranch: string( Required )

  • targetBranch: string( Required )

  • title: string( Required )

  • reviewers: array of MergeRequestReviewer( Nullable and Optional , defaults to null)

Response
MergeRequestRecord

Create code discussion

post /api/http/projects/{project}/repositories/{repository}/revisions/{revision}/code-discussions
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string (Path) ( Required )
revision: string (Path) ( Required )
object with fields:

  • text: string( Required )

  • diffContext: DiffContext( Nullable and Optional , defaults to null)

  • filename: string( Nullable and Optional , defaults to null)

  • line: integer (format: int32)( Nullable and Optional , defaults to null)

  • oldLine: integer (format: int32)( Nullable and Optional , defaults to null)

  • pending: boolean( Optional , defaults to false)

Response
CodeDiscussionRecord

Report external check status

post /api/http/projects/{project}/repositories/{repository}/revisions/{revision}/external-checks
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string (Path) ( Required )
revision: string (Path) ( Required )
object with fields:

  • branch: string( Nullable and Optional , defaults to null)

  • changes: array of string( Nullable and Optional , defaults to null)

  • executionStatus: CommitExecutionStatus( Required )

  • url: string( Required )

  • externalServiceName: string( Required )

  • taskName: string( Required )

  • taskId: string( Required )

  • timestamp: integer (format: int64)( Nullable and Optional , defaults to null)

  • description: string( Nullable and Optional , defaults to null)

Response
No arguments

Get external checks for commit

get /api/http/projects/{project}/repositories/{repository}/revisions/{revision}/external-checks
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string (Path) ( Required )
revision: string (Path) ( Required )
Response
array of ExternalCheckDTO

Get project responsibility scheme

get /api/http/projects/{project}/responsibilities/scheme

Get the responsibilities schema for a given project id.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
Response
array of SubjectResponsibilitiesTable

Add responsibility subject

post /api/http/projects/{project}/responsibilities/subjects

Add a responsibility subject for a given project id.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
object with fields:

  • name: string( Nullable and Optional , defaults to null)

Response
string

Edit responsibility subject

patch /api/http/projects/{project}/responsibilities/subjects/{subjectId}

Update an existing responsibility subject for a given project id.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
subjectId: string (Path) ( Required )
object with fields:

  • name: string( Nullable and Optional , defaults to null)

Response
No arguments

Assign responsible

post /api/http/projects/{project}/responsibilities/{responsibilityId}/assignees/{profileId}

Assign a responsible person for a given project id and responsibility id.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
responsibilityId: string (Path) ( Required )
profileId: string (Path) ( Required )
object with fields:

  • role: string( Nullable and Optional , defaults to null)

Response
No arguments

Remove responsible

delete /api/http/projects/{project}/responsibilities/{responsibilityId}/assignees/{profileId}

Remove a responsible person for a given project id and responsibility id.

Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
responsibilityId: string (Path) ( Required )
profileId: string (Path) ( Required )
role: string (Query) ( Nullable and Optional , defaults to null)
Response
No arguments

List commits matching query

get /api/http/projects/{project}/{repository}/commits
Request arguments
project: string in one of the formats

  • id: string

  • key: string

(Path) ( Required )
repository: string (Path) ( Required )
$skip: string (Query) ( Nullable and Optional , defaults to null)
$top: integer (format: int32) (Query) ( Nullable and Optional , defaults to 100)
query: string (Query) ( Nullable and Optional , defaults to null)
Response
object with fields:

  • next: string( Required )

  • totalCount: integer (format: int32)( Nullable and Optional , defaults to null)

  • data: array of GitCommitInfo( Required )

Last modified: 15 March 2021
Permissions Public Holidays