Projects

Create project

post /api/http/projects

Create a new project

Required permissions: Create projects

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 [])
icon: string ( Nullable and Optional , defaults to null)

Response
`PR_Project`

Get all projects

get /api/http/projects

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

Required permissions: View project details

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 collaborator

get /api/http/projects/collaborator:{profile}

Get all projects in which given user is a collaborator

Required permissions: View project details

Request arguments

profile: string in one of the formats

externalId: string
id: string
me
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 by member

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

Get all projects for a member

Required permissions: View project details

Request arguments

member: string in one of the formats

externalId: string
id: string
me
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}

Required permissions: View project details

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`)
`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 with right code

get /api/http/projects/right-unique-code:{right}

Required permissions: View project details

Request arguments
`right`: string in one of the formats `Emojis.AddCustomEmoji` `Profile.Create` `Channel.AddMembersOrTeams` `Channel.AddMessageReactions` `Chat.AddChannels` `Profile.CreateGuest` `Project.CodeReview.AddParticipants` `Project.Issues.AddParticipants` `Article.Comments.AddReactions` `Project.CodeReview.AddReactions` `Profile.DirectMessages.AddReactions` `Project.Issues.AddReactions` `Team.Create` `PackageRepository.Admin` `Vision.Admin` `Profile.Absences.Approve` `Documents.Archive` `Automation.ComputePools.AttacheWorkers` `Unfurl.App.Authorize` `HRM.Bonus.User` `Chat.BrowseChannels` `Telekom.CustomBackgrounds.Change` `Fleet.Workspaces.Connect` `Applications.Create` `Project.Planning.Boards.Create` Create issue boards `Project.CodeReview.Create` `Rd.DevConf.Create` `Rd.Workspaces.Create` Allows to create dev environments and manage their lifecycle `DocumentFolders.Create` `Book.Create` `Project.Issues.Create` Create issues in a project `Automation.Workers.Create` `PackageRepository.Create` `Profile.PermanentTokens.Create` `Automation.Workers.CreateProject` `Project.Secrets.Create` `Project.Create` `Project.SuggestedEdit.Create` `Applications.DelegateGlobalPermissions` `Applications.Delete` `Documents.DeleteForever` `Project.Hosting.DeleteSite` Allow delete hosted site with all site ' s history `Profile.Delete` `PackageRepository.Delete` `Project.Params.Delete` `Project.Secrets.Delete` `Project.VaultConnection.Delete` Delete Vault connections `HRM.Bonus.Events.Edit` `HRM.Bonus.Questionnaires.Edit` `Project.CodeReview.Edit` `Rd.Settings.Edit` Allows to edit the organization ' s dev environments settings ( like default IDE version ) `Documents.Edit` `Book.Items.Edit` `Profile.Locations.Edit` `Profile.HRM.VacationPeriods.Edit` `Team.History.Edit` `HRM.Bonus.Supervisor` `Superadmin` `Article.Import` `Project.Issues.Import` Import issues `Channel.ImportMessages` `Chat.ImportMessages` `Rd.Workspaces.Unattended.Join` Allows to join dev environments from hot pool and become their owner `Applications.ListCommands` `Project.Hosting.ListSites` Allow get list of hosted sites `Project.ViewPrivate` `Absences.EditTypes` `Project.TimeTracking.EditOthers` Add, update and delete spent time items for any user `AuthModule.Manage` `Profile.AuthenticationSessions.Edit` `Automation.ComputePools.Admin` `Automation.ComputePools.AdminProject` `Automation.Manage` `Automation.Execution.Admin` `Automation.Workers.Admin` `Project.Planning.Boards.Manage` Update issue board settings and delete issue boards `HRM.BusinessEntities.Edit` `Channel.Admin` `Project.Planning.Manage` Add, edit or remove checklists, as well as manage planning tags `CustomFields.Edit` `DeployTargets.CustomFields.Edit` `Rd.Workspaces.Manage` Allows to manage the lifecycle of dev environments that the user doesn ' t own ( users can always manage their own environments ) `Documents.Manage2` `Documents.Manage` `Emojis.Manage` `HRM.Bonus.Salary.Manage` `Unfurl.ExternalLinkPatterns.Manage` `FeatureFlags.Edit` `Book.Administrate` `VcsRepository.Admin` `Profile.Absences.EditPast` `Project.Hosting.ManageSite` Allow delete, undelete hosted site, add aliases and so on `Project.Planning.Boards.EditContent` Add issues to and remove issues from issue boards `Project.Issues.Manage` Manage settings of the issue tracker `Unfurl.BlackList` `Loggers.Edit` `MaintenanceData.Manage` `Meetings.ManageRooms` `Meetings.Manage` `Hints.Edit` `Project.TimeTracking.EditOwn` Add, update and delete own spent time items `Profile.PermanentTokens.Edit` `Profile.Tables.Manage` `Project.Admin` `Project.ManagePins` `HRM.Bonus.TeamLead` `Stickers.Manage` `Project.Tables.Manage` Manage tables in a project `Project.Issues.ManageTags` Add, edit or remove planning tags `ThrottledLogins.Manage` `Project.Topics.Manage` `Profile.TwoFactorAuthentication.Edit` `HRM.Vacations.Manage` `Rd.Warmup.Triggering.Manage` `Project.SuggestedEdit.Moderate` `Project.Deployments.Targets.Modify` Modify deployment targets in a project `Project.Deployments.Modify` Modify deployments in a project `Project.Params.Modify` `Project.VaultConnection.Modify` Create or edit Vault connections `Project.Issue.Move` Move issues into other projects `Profile.DirectMessages.EditPinnedMessagesList` `Project.Issues.EditPinnedCommentsList` `Channel.EditPinnedMessagesList` `Article.Comments.Post` `Project.CodeReview.PostComments` `Project.Issues.PostComments` `Book.Import` `Channel.PostMessages` `Channel.PostMessagesInThreads` `Unfurl.App.ProvideInline` `Unfurl.App.ProvideAttachment` `Article.Publish` `Project.Hosting.Publish` Allow publish static web sites or applications `Vision.Publish` `VcsRepository.Read` `PackageRepository.Read` `Vision.Read` `Channel.RemoveMembersOrTeams` `VcsRepository.CodeIssues.Push` `VcsRepository.CommitStatus.Push` `Project.Issues.Restore` Restore issues that were created by other users `Profile.DirectMessages.SendMessages` `Profile.TwoFactorAuthentication.Create` `Automation.Execution.Start` `Chat.StartConversation` `Automation.Execution.Stop` `HRM.Bonus.Questionnaires.Answers.Submit` `ApplicationState.Track` `Article.Unpublish` `Profile.Absences.Edit` `Applications.Edit` `Channel.UpdateChannelInfo` `Channel.UpdateChannelSubscriptions` `Profile.Salary.Write` `Project.Issues.Edit` Update issues that were created by other users `Profile.Languages.Edit` `Locations.Edit` `Meeting.EditRsvp` `Meeting.Edit` `Profile.HRM.BusinessEntities.Edit` `Profile.Edit.2` `Profile.Edit` `Profile.NotificationSettings.Edit` `Organization.Edit` `Organization.UpdateOverdrafts` `Profile.Tables.Edit` `Roles.Edit` `Project.Secrets.Edit` `Project.Tables.Edit` `Reactions.Edit` `Project.Responsibilities.Manage` `Team.Edit` `Todo.Task.Edit` `Profile.WorkingDays.Edit` `Telekom.CallSession.Create` `Project.Secrets.Use` `Profile.Absences.ViewApproval` `Profile.Absences.ViewReason` `Absences.ViewTypes` `Profile.Absences.View` `Profile.ViewAllGuests` `Profile.ApplicationConsents.Edit` `HRM.Bonus.Questionnaires.Answers.View` `Project.Hosting.ViewAppLogs` Allow to view application logs `Applications.ViewSecrets` `Applications.View` `Article.Comments.View` `Article.View` `HRM.Atelier.View` `Automation.ComputePools.View` `Automation.View` `Automation.Execution.View` `Automation.Workers.View` `Project.Planning.Boards.View` View issue boards `HRM.Bonus.Events.View` `HRM.Bonus.Questionnaires.View` `Organization.ViewBouncedEmailData` `HRM.BusinessEntities.View` `Channel.ViewChannel` `Channel.ViewChannelParticipants` `Project.CodeReview.ViewParticipants` `Project.CodeReview.ViewComments` `Project.CodeReview.View` `Profile.CustomFields.ViewPrivate` `Emojis.ViewEmojiList` `Project.Deployments.View` View deployments in a project `Rd.Workspaces.ViewInternals` `Rd.DebugData.View` Allows to view debug data `Rd.Workspaces.View` Allows to view dev environments that the user doesn ' t own ( users can always view their own environments ) `Rd.Settings.View` Allows to view the organization ' s dev environments settings ( like default IDE version ) `Profile.DirectMessages.ReadMessages` `Documents.View` `Profile.Salary.Read` `Unfurl.ExternalLinkPatterns.View` `Book.Items.View` `DocumentFolders.ViewMetadata` `Book.View` `Profile.View.GoogleAccountStatus` `Project.Issues.View` View issues in a project `Project.Secrets.ViewKeys` `Profile.Languages.View` `HRM.Bonus.Events.List` `Profile.Locations.Map.View` `Locations.View` `MaintenanceData.View` `Applications.Market.ViewMarketApps` `Meeting.View` `Profile.HRM.BusinessEntities.View` `Profile.Locations.View` `Profile.View.Basic` `Profile.View` `Profile.HRM.VacationPeriods.View` `HRM.MembershipRatioReport.View` `Profile.Memberships.View` `Channel.ViewMessageReactions` `Channel.ViewMessages` `Profile.NotificationSettings.View` `Permissions.OrgMember` `Organization.ViewOrganizationInfo` `Article.Comments.ViewParticipants` `Project.Issues.ViewParticipants` `Permissions.View` `Profile.Tables.View` `Roles.View` `Project.View` `Project.Params.View` `Article.Comments.ViewReactions` `Project.CodeReview.ViewReactions` `Profile.DirectMessages.ViewReactions` `Project.Issues.ViewReactions` `Project.Responsibilities.View` `Profile.CustomFields.ViewRestricted` `Project.TimeTracking.View` View spent time in the project `Project.Tables.View` View tables in a project `Team.View` `Todo.Task.View` `Organization.ViewUsageData` `Project.VaultConnection.View` View Vault connections `Profile.WorkingDays.View` `VcsRepository.Write` `PackageRepository.Write2` `PackageRepository.Write` `Vision.Write` (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`)
`starred`: `boolean` (Query) ( Nullable and Optional , defaults to `null`)
`private`: `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 team

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

Get all projects for a team

Required permissions: View project details

Request arguments

team: string in one of the formats

externalId: string
id: string
name: 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

Required permissions: View project details

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.

Required permissions: Manage project permission scheme

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`

Delete project

delete /api/http/projects/{project}

Delete a project

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

Response
No arguments

Search

post /api/http/projects/automation/deployment-targets/search

Required permissions: View deployments

Request arguments

object with fields:

expression: DeployTargetsSearchExpression ( Required )
batchInfo: BatchInfo ( Nullable and Optional )

Response

object with fields:

next: string ( Required )
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of DeployTargetRecord ( Required )

Get all deployment targets

get /api/http/projects/automation/deployment-targets

Required permissions: View deployments

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`search`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`customFilters`: array of `string` (Query) ( Nullable and Optional , defaults to `null`)
`sortBy`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sortOrder`: `ColumnSortOrder` (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 DeployTargetRecord ( Required )

Get deployment target by full number id

get /api/http/projects/automation/deployment-targets/{fullNumberId}

Required permissions: View deployments

Request arguments
`fullNumberId`: `string` (Path) ( Required )

Response
`DeployTargetRecord`

Get audit messages

get /api/http/projects/automation/deployment-targets/audit-log

Required permissions: View deployments

Request arguments

targetIdentifier: string in one of the formats

{ project: ProjectIdentifier , target: TargetIdentifier }
number: 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 DeployTargetAuditLogEntry ( Required )

Get dsl evaluation configuration

get /api/http/projects/automation/dsl-evaluations/config

Request arguments
No arguments

Response
`DslEvaluationConfig`

Stop execution

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

Stop execution by ExecutionId

Required permissions: Stop automation jobs

Request arguments
`id`: `string` (Path) ( Required )

Response
No arguments

Get graph execution

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

Required permissions: View automation jobs

Request arguments
`id`: `string` (Path) ( Required )

Response
`JobExecutionDTO`

Get current

get /api/http/projects/automation/job-executions/current

Returns the job execution associated to the currently authenticated principal. This endpoint can only be used with the credentials provided to an Automation job.

Required permissions: View automation jobs

Request arguments
No arguments

Response
`JobExecutionDTO`

Get job

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

Required permissions: View automation jobs

Request arguments

jobId: string (Path) ( Required )

project: string in one of the formats

id: string
key: string

(Query) ( Required )

Response
`JobDTO`

Get param

get /api/http/projects/automation/step-executions/used-parameters/param/{parameterId}

Request arguments
`parameterId`: `string` (Path) ( Required )

Response
array of `ParameterLastUsageDTO`

Get secret

get /api/http/projects/automation/step-executions/used-parameters/secret/{secretId}

Request arguments
`secretId`: `string` (Path) ( Required )

Response
array of `ParameterLastUsageDTO`

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

Delete legacy channels

delete /api/http/projects/automation/subscriptions/legacy-channels

Delete the legacy subscription channels matching the given filters ( applied as AND ) . If no filter is provided, all subscription channels corresponding to unsubscribed jobs for the logged in user are deleted.

Request arguments

project: string in one of the formats

id: string
key: string

(Query) ( Nullable and Optional , defaults to null)

Only delete the channels of the subscriptions from this project

jobId: string (Query) ( Nullable and Optional , defaults to null)

Only delete the channels of the subscriptions from this job. You can find the job ID in the URL of the job page.

unsubscribedOnly: boolean (Query) ( Optional , defaults to true)

When true ( the default ) , only channels corresponding to unsubscribed subscriptions will be deleted, active subscriptions won ' t be affected

Response
No arguments

Update param

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

Update an existing project parameter

Required permissions: Modify project parameters

Request arguments

id: string (Path) ( Required )

object with fields:

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

Response
No arguments

Delete param

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

Delete an existing project parameter

Required permissions: Delete project parameters

Request arguments
`id`: `string` (Path) ( Required )

Response
No arguments

Create default bundle

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

Create a new project parameter in the default parameter bundle

Required permissions: Modify project parameters

Request arguments

object with fields:

project: ProjectIdentifier ( Required )
key: string ( Required )
value: string ( Required )
description: string ( Nullable and Optional , defaults to null)

Response
`string`

Get all default bundle

get /api/http/projects/params/default-bundle

List project parameters in a parameter bundle

Required permissions: View project parameters

Request arguments

project: string in one of the formats

id: string
key: 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 )

Create in default bundle

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

Required permissions: Modify project parameters

Request arguments

object with fields:

projectId: string ( Required )
key: string ( Required )
value: string ( Required )

Response
`string`

Get all in default bundle

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

List project parameters in a parameter bundle

Required permissions: View project parameters

Request arguments
`projectId`: `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 )

Get board

get /api/http/projects/planning/boards/{board}

Get a board by identifier

Required permissions: View boards

Request arguments

board: string in one of the formats

id: string

(Path) ( Required )

Response
`BoardRecord`

Update board

patch /api/http/projects/planning/boards/{board}

Update an existing board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Required permissions: Manage boards

Request arguments

board: string in one of the formats

id: string

(Path) ( Required )

object with fields:

name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional )
swimlaneKey: string ( Nullable and Optional )
columns: BoardColumns ( Nullable and Optional , defaults to null)
issueFields: array of BoardIssueInputField ( Nullable and Optional , defaults to null)
memberOwners: array of string ( Nullable and Optional , defaults to null)
teamOwners: array of string ( Nullable and Optional , defaults to null)
backlogType: BacklogTypeIn ( Nullable and Optional , defaults to null)

Response
No arguments

Delete board

delete /api/http/projects/planning/boards/{board}

Delete an existing board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Required permissions: Manage boards

Request arguments

board: string in one of the formats

id: string

(Path) ( Required )

Response
No arguments

Create sprint

post /api/http/projects/planning/boards/sprints

Create a new sprint in a board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Required permissions: Manage boards

Request arguments

object with fields:

board: BoardIdentifier ( Required )
name: string ( Required )
description: string ( Nullable and Optional , defaults to null)
from: string (format: full-date) ( Required )
to: string (format: full-date) ( Required )
launch: SprintLaunch ( Optional )

Response
`SprintRecord`

Launch planned sprint

post /api/http/projects/planning/boards/sprints/{sprint}/launch

Launch a planned sprint. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Required permissions: Manage boards

Request arguments

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path) ( Required )

object with fields:

moveUnresolvedIssuesFromCurrentSprint: boolean ( Required )
notifySubscribers: boolean ( Optional , defaults to true)

Response
No arguments

Update sprint

patch /api/http/projects/planning/boards/sprints/{sprint}

Update an existing sprint in a board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Required permissions: Manage boards

Request arguments

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path) ( Required )

object with fields:

name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional )
from: string (format: full-date) ( Nullable and Optional , defaults to null)
to: string (format: full-date) ( Nullable and Optional , defaults to null)
launch: SprintLaunch ( Nullable and Optional , defaults to null)

Response
No arguments

Archive sprint

delete /api/http/projects/planning/boards/sprints/{sprint}/archive

Archive closed or planned sprint. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Required permissions: Manage boards

Request arguments

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path) ( Required )

Response
No arguments

Add issue to sprint

post /api/http/projects/planning/boards/sprints/{sprint}/issues/{issue}

Add an existing issue in a project to a sprint

Required permissions: Manage issue assignment

Request arguments

issue: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path) ( Required )

Response
No arguments

Remove issue from sprint

delete /api/http/projects/planning/boards/sprints/{sprint}/issues/{issue}

Remove an existing issue in a project from a sprint.

Required permissions: Manage issue assignment

Request arguments

issue: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

sprint: string in one of the formats

board: BoardIdentifier
id: string

(Path) ( Required )

Response
No arguments

Get all issues in sprint

get /api/http/projects/planning/boards/sprints/{sprint}/issues

Fetch issues from an existing non-archived sprint

Required permissions: View boards

Request arguments
`sprint`: string in one of the formats `board`: `BoardIdentifier` `id`: `string` (Path) ( Required )
`$skip`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`$top`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `100`)
`unresolvedOnly`: `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 Issue ( Required )

Add issue to board

post /api/http/projects/planning/boards/{board}/issues/{issue}

Add an existing issue in a project to a board or its current sprint

Required permissions: Manage issue assignment

Request arguments

issue: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

board: string in one of the formats

id: string

(Path) ( Required )

Response
No arguments

Remove issue from board

delete /api/http/projects/planning/boards/{board}/issues/{issue}

Remove an existing issue in a project from a board or all of its sprints

Required permissions: Manage issue assignment

Request arguments

issue: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

board: string in one of the formats

id: string

(Path) ( Required )

Response
No arguments

Get all issues on board

get /api/http/projects/planning/boards/{board}/issues

Fetch issues from the board across all its non-archived sprints

Required permissions: View boards

Request arguments

board: string in one of the formats

id: 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 Issue ( Required )

Request access to project

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

Request access to a project

Required permissions: List restricted projects

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 organization

Required permissions: List restricted projects, View project details

Request arguments
No arguments

Response
array of `PR_PrivateProject`

Find repositories

get /api/http/projects/repositories/find

Find repositories by name substring.

Required permissions: Read Git repositories

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) ( Required )

Specifies a substring that should be found in repository name.

Response

object with fields:

next: string ( Required )
totalCount: integer (format: int32) ( Nullable and Optional , defaults to null)
data: array of RepositoryDetails ( Required )

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

Update secret

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

Update an existing project secret

Required permissions: Update project secrets

Request arguments

id: string (Path) ( Required )

object with fields:

valueBase64: string ( Nullable and Optional , defaults to null)
publicKeyId: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
secretReference: string ( Nullable and Optional , defaults to null)
Can contain reference to a single project secret in a {{ project:... }} format, or a Vault secret reference in a vault:.. format.

Response
No arguments

Delete secret

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

Delete an existing project secret

Required permissions: Delete project secrets

Request arguments
`id`: `string` (Path) ( Required )

Response
No arguments

Create default bundle

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

Create a new project secret. The secret value should be provided either as a base64-encoded value in [ valueBase64 ] , or as a reference to another secret in [ secretReference ] .

Required permissions: Create project secrets

Request arguments

object with fields:

project: ProjectIdentifier ( Required )
key: string ( Required )
valueBase64: string ( Nullable and Optional , defaults to null)
publicKeyId: string ( Nullable and Optional , defaults to null)
Not supported at the moment
description: string ( Nullable and Optional , defaults to null)
secretReference: string ( Nullable and Optional , defaults to null)
Can contain reference to a single project secret in a {{ project:... }} format, or a Vault secret reference in a vault:.. format.

Response
`string`

Get all default bundle

get /api/http/projects/secrets/default-bundle

List project secrets in a parameter bundle

Required permissions: View keys of project secrets

Request arguments

project: string in one of the formats

id: string
key: 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 )

Create in default bundle

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

Required permissions: Create project 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`

Get all in default bundle

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

Required permissions: View keys of project secrets

Request arguments
`projectId`: `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 )

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

Required permissions: View project details

Request arguments
No arguments

Response
array of `PR_Tag`

Create vault

post /api/http/projects/vault

Create a new Vault connection for the project. Vault ' s AppRole Secret Id must be provided as base64 encoded string

Required permissions: Modify Vault connections

Request arguments

object with fields:

project: ProjectIdentifier ( Required )
url: string ( Required )
name: string ( Required )
namespace: string ( Nullable and Optional , defaults to null)
vaultNamespace: string ( Nullable and Optional , defaults to null)
appRoleEndpointPath: string ( Required )
appRoleId: string ( Required )
appRoleSecretIdBase64: string ( Required )

Response
`string`

Get vault

get /api/http/projects/vault

Get an existing Vault connections for project

Required permissions: View Vault connections

Request arguments

project: string in one of the formats

id: string
key: string

(Query) ( Required )

Response
array of `VaultConnectionRecord`

Update vault

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

Update an existing Vault connection

Required permissions: Modify Vault connections

Request arguments

id: string (Path) ( Required )

object with fields:

url: string ( Required )
name: string ( Required )
namespace: string ( Nullable and Optional , defaults to null)
vaultNamespace: string ( Nullable and Optional , defaults to null)
appRoleEndpointPath: string ( Required )
appRoleId: string ( Required )
appRoleSecretIdBase64: string ( Nullable and Optional , defaults to null)

Response
No arguments

Delete vault

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

Delete an existing Vault connection

Required permissions: Delete Vault connections

Request arguments
`id`: `string` (Path) ( Required )

Response
No arguments

Get all admins

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

Returns the list of all project administrators

Required permissions: View project details

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

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

profile: ProfileIdentifier ( Required )

Response
No arguments

Remove administrator

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

Remove a member as administrator from a project

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

profile: string in one of the formats

externalId: string
id: string
me
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

Required permissions: Manage project permission scheme

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

Required permissions: Manage project permission scheme

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

Required permissions: View project details

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

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

profile: ProfileIdentifier ( Required )

Response
No arguments

Get all individual collaborators

get /api/http/projects/{project}/access/collaborators/profiles

Required permissions: View project details

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

Response
array of `TD_MemberProfile`

Remove a collaborator

delete /api/http/projects/{project}/access/collaborators/profiles

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

profile: string in one of the formats

externalId: string
id: string
me
username: string

(Query) ( Required )

Response
No arguments

Add a collaborators' team

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

Required permissions: Manage project permission scheme

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

Required permissions: View project details

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

Required permissions: Manage project permission scheme

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

Required permissions: View project details

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

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

profile: ProfileIdentifier ( Required )

Response
No arguments

Remove member

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

Remove a member from a project

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

profile: string in one of the formats

externalId: string
id: string
me
username: string

(Path) ( Required )

Response
No arguments

Remove team

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

Remove a team from a project

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

teamId: string (Path) ( Required )

Response
No arguments

Organization profiles that can view the project

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

Get organization members who can view a project

Required permissions: View project details

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 )

Create deployment target

post /api/http/projects/{project}/automation/deployment-targets

Required permissions: Modify deployment targets

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

key: string ( Required )
name: string ( Required )
description: string ( Required )
repositories: array of DeployTargetRepositoryDTO ( Optional , defaults to [])
manualControl: boolean ( Nullable and Optional , defaults to null)
singleScheduled: boolean ( Nullable and Optional , defaults to null)
hangTimeoutMinutes: integer (format: int32) ( Nullable and Optional , defaults to null)
failTimeoutMinutes: integer (format: int32) ( Nullable and Optional , defaults to null)
responsibleUsers: array of string ( Nullable and Optional , defaults to null)
responsibleTeams: array of string ( Nullable and Optional , defaults to null)
links: array of DeployTargetLink ( Nullable and Optional , defaults to null)
customFields: array of CustomFieldInputValue ( Nullable and Optional , defaults to null)

Response
`DeployTargetRecord`

Get all deployment targets

get /api/http/projects/{project}/automation/deployment-targets

Required permissions: View deployments

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`search`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`customFilters`: array of `string` (Query) ( Nullable and Optional , defaults to `null`)
`showArchived`: `boolean` (Query) ( Nullable and Optional , defaults to `null`)
`sortBy`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sortOrder`: `ColumnSortOrder` (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 DeployTargetRecord ( Required )

List favorites

get /api/http/projects/{project}/automation/deployment-targets/favorites

Required permissions: View deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

sortBy: string (Query) ( Nullable and Optional , defaults to null)

sortOrder: ColumnSortOrder (Query) ( Nullable and Optional , defaults to null)

Response
array of `DeployTargetRecord`

Get deployment target

get /api/http/projects/{project}/automation/deployment-targets/{target}

Required permissions: View deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

target: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path) ( Required )

Response
`DeployTargetRecord`

Update deployment target

patch /api/http/projects/{project}/automation/deployment-targets/{target}

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

target: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path) ( Required )

object with fields:

name: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
repositories: array of DeployTargetRepositoryDTO ( Nullable and Optional , defaults to null)
manualControl: boolean ( Nullable and Optional , defaults to null)
singleScheduled: boolean ( Nullable and Optional , defaults to null)
hangTimeoutMinutes: integer (format: int32) ( Nullable and Optional , defaults to null)
failTimeoutMinutes: integer (format: int32) ( Nullable and Optional , defaults to null)
responsibleUsers: array of string ( Nullable and Optional , defaults to null)
responsibleTeams: array of string ( Nullable and Optional , defaults to null)
links: array of DeployTargetLink ( Nullable and Optional , defaults to null)
customFields: array of CustomFieldInputValue ( Nullable and Optional , defaults to null)
key: string ( Nullable and Optional , defaults to null)

Response
No arguments

Delete deployment target

delete /api/http/projects/{project}/automation/deployment-targets/{target}

Required permissions: Modify deployment targets

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

target: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path) ( Required )

Response
No arguments

Fail deployment

post /api/http/projects/{project}/automation/deployments/fail

Required permissions: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

targetIdentifier: TargetIdentifier ( Required )

Response
`DeploymentRecord`

Finish deployment

post /api/http/projects/{project}/automation/deployments/finish

Required permissions: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

targetIdentifier: TargetIdentifier ( Required )
deploymentIdentifier: DeploymentIdentifier ( Nullable and Optional , defaults to null)
version: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
commitRefs: array of DeploymentCommitReference ( Nullable and Optional , defaults to null)
externalLink: ExternalLink ( Nullable and Optional , defaults to null)

Response
`DeploymentRecord`

Schedule deployment

post /api/http/projects/{project}/automation/deployments/schedule

Required permissions: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

targetIdentifier: TargetIdentifier ( Required )
version: string ( Nullable and Optional , defaults to null)
scheduledStart: string (format: date-time) ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
commitRefs: array of DeploymentCommitReference ( Nullable and Optional , defaults to null)
externalLink: ExternalLink ( Nullable and Optional , defaults to null)

Response
`DeploymentRecord`

Start deployment

post /api/http/projects/{project}/automation/deployments/start

Required permissions: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

targetIdentifier: TargetIdentifier ( Required )
deploymentIdentifier: DeploymentIdentifier ( Nullable and Optional , defaults to null)
version: string ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
commitRefs: array of DeploymentCommitReference ( Nullable and Optional , defaults to null)
externalLink: ExternalLink ( Nullable and Optional , defaults to null)
syncWithAutomationJob: boolean ( Optional , defaults to false)

Response
`DeploymentRecord`

Get all deployments

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

Required permissions: View deployments

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`targetIdentifier`: string in one of the formats `id`: `string` `key`: `string` `number`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `null`)
`jobExecutionId`: `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 DeploymentRecord ( Required )

Update deployment

patch /api/http/projects/{project}/automation/deployments

Required permissions: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

targetIdentifier: TargetIdentifier ( Required )
deploymentIdentifier: DeploymentIdentifier ( Required )
version: string ( Nullable and Optional , defaults to null)
scheduledStart: string (format: date-time) ( Nullable and Optional , defaults to null)
description: string ( Nullable and Optional , defaults to null)
commitRefs: array of DeploymentCommitReference ( Nullable and Optional , defaults to null)
externalLink: ExternalLink ( Nullable and Optional , defaults to null)

Response
`DeploymentRecord`

Get deployment

get /api/http/projects/{project}/automation/deployments/{targetIdentifier}/{deploymentIdentifier}

Required permissions: View deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

targetIdentifier: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path) ( Required )

deploymentIdentifier: string in one of the formats

id: string
status: DeploymentIdentifierStatus
version: string

(Path) ( Required )

Response
`DeploymentRecord`

Delete deployment

delete /api/http/projects/{project}/automation/deployments/{targetIdentifier}/{deploymentIdentifier}

Required permissions: Modify deployments

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

targetIdentifier: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Path) ( Required )

deploymentIdentifier: string in one of the formats

id: string
status: DeploymentIdentifierStatus
version: string

(Path) ( Required )

Response
No arguments

Get all graph executions

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

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

Required permissions: View automation jobs

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 job

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

Start job. Returns ExecutionId, see projects/automation/graph-executions/{id}.

Required permissions: Start automation jobs

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

jobId: string (Path) ( Required )

object with fields:

branch: Branch ( Required )
parameters: array of JobParameter ( Nullable and Optional , defaults to null)
checkoutRevisions: array of CheckoutRevisionDTO ( Nullable and Optional , defaults to null)

Response
`LaunchResult`

Get all jobs

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

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

Required permissions: View automation jobs

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 )

Create review based on commit set

post /api/http/projects/{project}/code-reviews/commit-set-review

Required permissions: Create code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

repository: string ( Required )
revisions: array of string ( Required )
title: string ( Nullable and Optional , defaults to null)
authorProfileIds: array of string ( Nullable and Optional , defaults to null)
files: FileSetInReview ( Nullable and Optional , defaults to null)

Response
`CommitSetReviewRecord`

Create merge request

post /api/http/projects/{project}/code-reviews/merge-requests

Required permissions: Create code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

repository: string ( Required )
sourceBranch: string ( Required )
targetBranch: string ( Required )
title: string ( Required )
description: string ( Nullable and Optional , defaults to null)
reviewers: array of ReviewerParam ( Nullable and Optional , defaults to null)

Response
`MergeRequestRecord`

Get all code reviews

get /api/http/projects/{project}/code-reviews

Required permissions: View 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 `externalId`: `string` `id`: `string` `me` `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 `externalId`: `string` `id`: `string` `me` `username`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`type`: `ReviewType` (Query) ( Nullable and Optional , defaults to `null`)
`repository`: `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 CodeReviewWithCount ( Required )

Get code review

get /api/http/projects/{project}/code-reviews/{reviewId}

Required permissions: View code reviews

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

Required permissions: View code reviews

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`

Get the modified files in code review

get /api/http/projects/{project}/code-reviews/{reviewId}/files

List files changed in commits under code review

Required permissions: View code reviews

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 )
`$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 ChangeInReview ( Required )

Get the merge request files

get /api/http/projects/{project}/code-reviews/{reviewId}/merge-files

List files in merge request which will be merged into target branch

Required permissions: View code reviews

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 )
`$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 GitMergedFile ( Required )

Get suggested reviewers

get /api/http/projects/{project}/code-reviews/{reviewId}/suggested-reviewers

Required permissions: View code reviews

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 description

patch /api/http/projects/{project}/code-reviews/{reviewId}/description

Required permissions: Edit code reviews

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:

description: string ( Required )

Response
No arguments

Make review read-only

patch /api/http/projects/{project}/code-reviews/{reviewId}/make-read-only

Required permissions: Edit code reviews

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

Edit review state

patch /api/http/projects/{project}/code-reviews/{reviewId}/state

Required permissions: Edit code reviews

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:

state: CodeReviewState ( Required )

Response
No arguments

Edit review title

patch /api/http/projects/{project}/code-reviews/{reviewId}/title

Required permissions: Edit code reviews

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

Merge a merge request

put /api/http/projects/{project}/code-reviews/{reviewId}/merge

Required permissions: View code reviews, Write Git repositories

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:

deleteSourceBranch: boolean ( Required )
mergeMode: GitMergeMode ( Required )

Response
`GitMergeResultHttp`

Rebase a merge request

put /api/http/projects/{project}/code-reviews/{reviewId}/rebase

Required permissions: View code reviews, Write Git repositories

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:

deleteSourceBranch: boolean ( Required )
rebaseMode: GitRebaseMode ( Required )
squash: boolean ( Required )
squashedCommitMessage: string ( Nullable and Optional , defaults to null)

Response
`GitRebaseResultHttp`

Create code discussion

post /api/http/projects/{project}/code-reviews/code-discussions

Required permissions: View code reviews, Create suggested edit

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

text: string ( Required )
attachments: array of AttachmentIn ( Nullable and Optional , defaults to null)
diffContext: DiffContext ( Nullable and Optional , defaults to null)
repository: string ( Required )
revision: string ( Nullable and Optional , defaults to null)
Deprecated since 2022-11-23: Use anchor parameter instead. It will be removed in a future version.
filename: string ( Nullable and Optional , defaults to null)
Deprecated since 2022-11-23: Use anchor parameter instead. It will be removed in a future version.
line: integer (format: int32) ( Nullable and Optional , defaults to null)
Deprecated since 2022-11-23: Use anchor parameter instead. It will be removed in a future version.
oldLine: integer (format: int32) ( Nullable and Optional , defaults to null)
Deprecated since 2022-11-23: Use anchor parameter instead. It will be removed in a future version.
anchor: LocalCodeDiscussionAnchorIn ( Nullable and Optional , defaults to null)
endAnchor: LocalCodeDiscussionAnchorIn ( Nullable and Optional , defaults to null)
pending: boolean ( Optional , defaults to false)
reviewId: ReviewIdentifier ( Required )
suggestedEdit: CodeDiscussionSuggestedEditRequest ( Nullable and Optional , defaults to null)

Response
`CodeDiscussionRecord`

Accept suggested edit

post /api/http/projects/{project}/code-reviews/code-discussions/{discussionId}/accept-suggested-edit

Required permissions: Moderate suggestions

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

discussionId: string (Path) ( Required )

object with fields:

commitMessage: string ( Required )

Response
No arguments

Reject suggested edit

post /api/http/projects/{project}/code-reviews/code-discussions/{discussionId}/reject-suggested-edit

Required permissions: Moderate suggestions

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

discussionId: string (Path) ( Required )

Response
No arguments

Reopen suggested edit

post /api/http/projects/{project}/code-reviews/code-discussions/{discussionId}/reopen-suggested-edit

Required permissions: Moderate suggestions

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

discussionId: string (Path) ( Required )

Response
No arguments

Alter suggested edit

patch /api/http/projects/{project}/code-reviews/code-discussions/{discussionId}/suggested-edit

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

discussionId: string (Path) ( Required )

object with fields:

text: string ( Required )
attachments: array of AttachmentIn ( Required )
snippetContent: string ( Optional )

Response
No arguments

Start safe merge execution status

post /api/http/projects/{project}/code-reviews/safe-merge

Required permissions: View code reviews, Write Git repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

mergeRequestId: ReviewIdentifier ( Required )
mergeOptions: MergeSelectOptions ( Required )

Response
array of `SafeMergeMessage`

Get safe merge execution status

get /api/http/projects/{project}/code-reviews/safe-merge

Required permissions: View code reviews

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

mergeRequestId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Query) ( Required )

Response
`SafeMerge`

Stop safe merge execution

delete /api/http/projects/{project}/code-reviews/safe-merge

Required permissions: View code reviews, Write Git repositories

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

mergeRequestId: string in one of the formats

id: string
key: string
number: integer (format: int32)

(Query) ( Required )

Response
array of `SafeMergeMessage`

Add review participant

post /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}

Required permissions: Edit code reviews

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

externalId: string
id: string
me
username: string

(Path) ( Required )

object with fields:

role: CodeReviewParticipantRole ( Required )
isCodeOwner: boolean ( Nullable and Optional , defaults to null)

Response
No arguments

Remove review participant

delete /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}

Required permissions: Edit code reviews

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

externalId: string
id: string
me
username: string

(Path) ( Required )

role: CodeReviewParticipantRole (Query) ( Required )

Response
No arguments

Add revisions to review

post /api/http/projects/{project}/code-reviews/{reviewId}/revisions

Required permissions: Edit code reviews

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:

revisions: array of ReviewCommitIn ( Required )

Response
No arguments

Remove revisions from review

delete /api/http/projects/{project}/code-reviews/{reviewId}/revisions

Required permissions: Edit code reviews

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

Create unbound discussion

post /api/http/projects/{project}/code-reviews/{reviewId}/unbound-discussions

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:

channelItemId: string ( Required )

Response
`CodeReviewUnboundDiscussionRecord`

Get all unbound discussions

get /api/http/projects/{project}/code-reviews/{reviewId}/unbound-discussions

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 )
`$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 CodeReviewUnboundDiscussionRecord ( Required )

Toggle unbound discussion resolution

patch /api/http/projects/{project}/code-reviews/{reviewId}/unbound-discussions/{discussionId}/toggle

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 )

discussionId: string (Path) ( Required )

object with fields:

resolved: boolean ( Nullable and Optional , defaults to null)

Response
No arguments

Create document

post /api/http/projects/{project}/documents

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

name: string ( Required )
folder: FolderIdentifier ( Required )
bodyIn: DocumentBodyCreateIn ( Required )
publicationDetailsIn: PublicationDetailsIn ( Nullable and Optional , defaults to null)

Response
`Document`

Get document

get /api/http/projects/{project}/documents/{documentId}

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

documentId: string (Path) ( Required )

Response
`Document`

Update document

patch /api/http/projects/{project}/documents/{documentId}

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

documentId: string (Path) ( Required )

object with fields:

name: string ( Nullable and Optional , defaults to null)
updateIn: DocumentBodyUpdateIn ( Nullable and Optional , defaults to null)
publicationDetailsIn: PublicationDetailsIn ( Nullable and Optional )

Response
`Document`

Archive document

delete /api/http/projects/{project}/documents/{documentId}

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

documentId: string (Path) ( Required )

Response
No arguments

Create folder

post /api/http/projects/{project}/documents/folders

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

name: string ( Required )
parentFolder: FolderIdentifier ( Required )

Response
`DocumentFolder`

Get folder

get /api/http/projects/{project}/documents/folders/{folder}

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

folder: string in one of the formats

id: string
root
sharedWithMe

(Path) ( Required )

Response
`DocumentFolder`

Rename folder

patch /api/http/projects/{project}/documents/folders/{folder}

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

folder: string in one of the formats

id: string
root
sharedWithMe

(Path) ( Required )

object with fields:

name: string ( Required )

Response
No arguments

Archive folder

delete /api/http/projects/{project}/documents/folders/{folder}

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

folder: string in one of the formats

id: string
root
sharedWithMe

(Path) ( Required )

Response
No arguments

Folder own access permissions

get /api/http/projects/{project}/documents/folders/{folder}/access

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

folder: string in one of the formats

id: string
root
sharedWithMe

(Path) ( Required )

Response
`FolderAccess`

Update folder access permissions

patch /api/http/projects/{project}/documents/folders/{folder}/access

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

folder: string in one of the formats

id: string
root
sharedWithMe

(Path) ( Required )

object with fields:

accessChange: UpdateFolderAccessIn ( Required )
silent: boolean ( Optional , defaults to false)

Response
No arguments

List documents in folder

get /api/http/projects/{project}/documents/folders/{folder}/documents

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`folder`: string in one of the formats `id`: `string` `root` `sharedWithMe` (Path) ( Required )
`withArchived`: `boolean` (Query) ( Optional , defaults to `false`)
`sortBy`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`order`: `ColumnSortOrder` (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 Document ( Required )

Add folder introduction

patch /api/http/projects/{project}/documents/folders/{folder}/introduction/{documentId}

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

folder: string in one of the formats

id: string
root
sharedWithMe

(Path) ( Required )

documentId: string (Path) ( Required )

Response
No arguments

Remove folder introduction

delete /api/http/projects/{project}/documents/folders/{folder}/introduction

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

folder: string in one of the formats

id: string
root
sharedWithMe

(Path) ( Required )

Response
No arguments

Move folder

patch /api/http/projects/{project}/documents/folders/{folder}/move

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

folder: string in one of the formats

id: string
root
sharedWithMe

(Path) ( Required )

object with fields:

parentFolder: FolderIdentifier ( Required )

Response
`DocumentFolder`

Search documents and folders

get /api/http/projects/{project}/documents/folders/{folder}/search

Executes search for project documents and folders in specified folder

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`folder`: string in one of the formats `id`: `string` `root` `sharedWithMe` (Path) ( Required )
`query`: `string` (Query) ( Required )
`includeBody`: `boolean` (Query) ( Nullable and Optional , defaults to `null`)
`foldersOnly`: `boolean` (Query) ( Nullable and Optional , defaults to `false`)
`$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 DocumentFolderItem ( Required )

List subfolders

get /api/http/projects/{project}/documents/folders/{folder}/subfolders

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`folder`: string in one of the formats `id`: `string` `root` `sharedWithMe` (Path) ( Required )
`withArchived`: `boolean` (Query) ( Optional , defaults to `false`)
`sortBy`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`order`: `ColumnSortOrder` (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 DocumentFolder ( Required )

Document own access permissions

get /api/http/projects/{project}/documents/{documentId}/access

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

documentId: string (Path) ( Required )

Response
`DocumentAccess`

Update document access permissions

patch /api/http/projects/{project}/documents/{documentId}/access

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

documentId: string (Path) ( Required )

object with fields:

accessChange: UpdateDocumentAccessIn ( Required )
silent: boolean ( Optional , defaults to false)

Response
No arguments

Copy document

post /api/http/projects/{project}/documents/{documentId}/copy

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

documentId: string (Path) ( Required )

object with fields:

name: string ( Required )
folder: FolderIdentifier ( Required )

Response
`Document`

Move document

patch /api/http/projects/{project}/documents/{documentId}/move

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

documentId: string (Path) ( Required )

object with fields:

folder: FolderIdentifier ( Required )

Response
`Document`

Unarchive document

patch /api/http/projects/{project}/documents/{documentId}/unarchive

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

documentId: string (Path) ( Required )

Response
`Document`

Update feature pin

patch /api/http/projects/{project}/feature-pins

Update list of project items pinned for the project by default

Required permissions: Manage project sidebar pins

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

featurePins: array of ProjectFeaturePinsIn ( Required )

Response
No arguments

Create new repository

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

Creates a new package repository for a given project ID

Required permissions: Create package repositories

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 ( Optional , defaults to false)
settings: ES_PackageRepositorySettings ( Nullable and Optional , defaults to null)
mode: PackageRepositoryMode ( Optional , defaults to "HOSTING")
connection: PackageRepositoryConnection ( 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

Required permissions: Read package repositories

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

Required permissions: Read package repositories

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
{ type: string , name: string }

(Path) ( Required )

Response
`ProjectPackageRepository`

Update repository

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

Updates package repository settings for a given project ID

Required permissions: Admin package repositories

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
{ type: string , name: 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)
cleanupEnabled: 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

Required permissions: Admin package repositories

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
{ type: string , name: string }

(Path) ( Required )

Response
No arguments

Get repository own access

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

Updates package repository settings for a given project ID

Required permissions: Admin package repositories

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
{ type: string , name: string }

(Path) ( Required )

Response
`PackagesAccess`

Update repository own access

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

Updates package repository settings for a given project ID

Required permissions: Admin package repositories

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
{ type: string , name: string }

(Path) ( Required )

object with fields:

accessChange: UpdatePackageRepositoryAccessIn ( Required )
silent: boolean ( Required )

Response
No arguments

Cleanup repository

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

Cleanup specified package repository

Required permissions: Admin package repositories

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
{ type: string , name: string }

(Path) ( Required )

object with fields:

retentionPolicyParams: RetentionPolicyParams ( Nullable and Optional , defaults to null)

Response
`PackagesExecutionResult`

Dry run repository cleanup

post /api/http/projects/{project}/packages/repositories/{repository}/cleanup/dry

Dry run of cleanup for specified package repository

Required permissions: Admin package repositories

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
{ type: string , name: string }

(Path) ( Required )

object with fields:

retentionParams: RetentionPolicyParams ( Required )

Response
`DryCleanupResults`

Get all remote repositories

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

Gets a list of remote package repositories for given project

Required permissions: Read package repositories

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
{ type: string , name: string }

(Path) ( Required )

Response
array of `PackageRepositoryConnection`

Publish packages to remote repository

post /api/http/projects/{project}/packages/repositories/{repository}/connections/{connectionId}/publish

Publishes packages to remote repository

Required permissions: Write package repositories

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
{ type: string , name: string }

(Path) ( Required )

connectionId: string (Path) ( Required )

object with fields:

source: PublishingSource ( Required )

Response
`string`

Get list of publishing to remote repository

get /api/http/projects/{project}/packages/repositories/{repository}/connections/{connectionId}/publish

Get list of publishing to remote repository

Required permissions: Read package repositories

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` `{` `type`: `string` `, name`: `string` `}` (Path) ( Required )
`connectionId`: `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 PackagesPublishing ( Required )

Get list of files

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

Gets a list of repository files for a given project ID in parent folder

Required permissions: Read package repositories

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
{ type: string , name: string }

(Path) ( Required )

parentPath: string (Query) ( Nullable and Optional , defaults to null)

Response
array of `FileData`

Get file details

get /api/http/projects/{project}/packages/repositories/{repository}/files/name:{filePath}

Gets a details for repository file for a given project ID

Required permissions: Read package repositories

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
{ type: string , name: string }

(Path) ( Required )

filePath: string (Path) ( Required )

Response
`FileDetails`

Delete file

delete /api/http/projects/{project}/packages/repositories/{repository}/files/name:{filePath}

Removes a file in repository for a given project ID

Required permissions: Delete package repositories content

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
{ type: string , name: string }

(Path) ( Required )

filePath: string (Path) ( Required )

Response
No arguments

Delete folder

delete /api/http/projects/{project}/packages/repositories/{repository}/files/folder:{folderPath}

Removes a folder in repository for a given project ID

Required permissions: Delete package repositories content

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
{ type: string , name: string }

(Path) ( Required )

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

Required permissions: Read package repositories

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` `{` `type`: `string` `, name`: `string` `}` (Path) ( Required )
`query`: `string` (Query) ( Required )
`connectionId`: `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 )

Delete package

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

Removes all package versions in repository for a given project ID

Required permissions: Delete package repositories content

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
{ type: string , name: string }

(Path) ( Required )

packageName: string (Path) ( Required )

Response
No arguments

Get package metadata

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

Get package metadata in repository for a given project ID

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
{ type: string , name: string }

(Path) ( Required )

packageName: string (Path) ( Required )

Response
`PackageMetadata`

Report package metadata

put /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/metadata

Update a package metadata in repository for a given project ID

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
{ type: string , name: string }

(Path) ( Required )

packageName: string (Path) ( Required )

object with fields:

connectionId: string ( Nullable and Optional , defaults to null)

Response
No arguments

Report package version metadata

put /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/metadata/version:{packageVersion}

Report a package version metadata in repository for a given project ID

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` `{` `type`: `string` `, name`: `string` `}` (Path) ( Required )
`packageName`: `string` (Path) ( Required )
`packageVersion`: `string` (Path) ( Required )
object with fields: `pin`: `boolean` ( Required ) `comment`: `string` ( Nullable and Optional , defaults to `null`)

Response
No arguments

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

Required permissions: Read package repositories

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` `{` `type`: `string` `, name`: `string` `}` (Path) ( Required )
`packageName`: `string` (Path) ( Required )
`query`: `string` (Query) ( Required )
`connectionId`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`pinned`: `boolean` (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`)
`sortColumn`: `PackagesSortColumn` (Query) ( Required )
`sortOrder`: `ColumnSortOrder` (Query) ( Required )

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

Required permissions: Read package repositories

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` `{` `type`: `string` `, name`: `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

Required permissions: Delete package repositories content

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` `{` `type`: `string` `, name`: `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

Required permissions: Read package repositories

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
{ type: string , name: 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

Required permissions: Read package repositories

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

Required permissions: Read package repositories

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`)
`sortColumn`: `PackagesSortColumn` (Query) ( Required )
`sortOrder`: `ColumnSortOrder` (Query) ( Required )

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

Required permissions: Read package repositories

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

Required permissions: Delete package repositories content

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

Required permissions: Read package repositories

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`type`: `string` (Query) ( Required )
`query`: `string` (Query) ( Required )
`connectionId`: `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

Returns a list of available repository types.

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

Response
array of `PackageType`

Update participant roles

post /api/http/projects/{project}/people/members/update

Adds or removes project participant roles

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

profile: ProfileIdentifier ( Required )
addRoles: array of ProjectRoleIn ( Required )
removeRoles: array of ProjectRoleIn ( Required )

Response
No arguments

Get all participants

get /api/http/projects/{project}/people/members

Returns all project participants

Required permissions: View project details

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`)
`role`: string in one of the formats `admin` `role`: `string` `external` `member` (Query) ( Nullable and Optional , defaults to `null`)
`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 ParticipantOnProject ( Required )

Get participants by profiles

get /api/http/projects/{project}/people/members/by-ids

Returns project participants by provided profiles

Required permissions: View project details

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

profiles: array of ProfileIdentifier (Query) ( Required )

Response
array of `ParticipantOnProject`

Remove participant

delete /api/http/projects/{project}/people/members/{profile}

Removes participant

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

profile: string in one of the formats

externalId: string
id: string
me
username: string

(Path) ( Required )

Response
No arguments

Update participant roles

post /api/http/projects/{project}/people/teams/update

Adds or removes project team participant roles

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

team: TeamIdentifier ( Required )
addRoles: array of ProjectRoleIn ( Required )
removeRoles: array of ProjectRoleIn ( Required )

Response
No arguments

Get all participants

get /api/http/projects/{project}/people/teams

Returns all project participant teams

Required permissions: View project details

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`)
`role`: string in one of the formats `admin` `role`: `string` `external` `member` (Query) ( Nullable and Optional , defaults to `null`)
`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 ParticipantTeamOnProject ( Required )

Get participants by teams

get /api/http/projects/{project}/people/teams/by-ids

Returns project participant teams by provided teams

Required permissions: View project details

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

teams: array of TeamIdentifier (Query) ( Required )

Response
array of `ParticipantTeamOnProject`

Remove participant

delete /api/http/projects/{project}/people/teams/{team}

Removes participant

Required permissions: Manage project permission scheme

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

team: string in one of the formats

externalId: string
id: string
name: string

(Path) ( Required )

Response
No arguments

Update personal feature pin

patch /api/http/projects/{project}/personal-feature-pins

Update list of project items pinned for the project personally for you

Required permissions: View project details

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

featurePins: array of ToggleableProjectFeaturePins ( Required )

Response
No arguments

Create board

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

Create a new issue board in a project. The user will become the owner of the board.

Required permissions: Create boards

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

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

Response
`BoardRecord`

Get all boards

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

Search existing boards in a project

Required permissions: View boards

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 BoardRecord ( Required )

Get all sprints

get /api/http/projects/{project}/planning/boards/sprints

Search existing sprints in a project

Required permissions: View boards

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`)
`board`: string in one of the formats `id`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`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 SprintRecord ( Required )

Get all starred boards

get /api/http/projects/{project}/planning/boards/starred

Get all starred boards in a project

Required permissions: View boards

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

Response
array of `BoardRecord`

Archive board

delete /api/http/projects/{project}/planning/boards/{board}/archive

Archive an existing board. This operation can be performed by board owners or other members who are granted permission to manage boards in a project.

Required permissions: Manage boards

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

board: string in one of the formats

id: string

(Path) ( Required )

Response
No arguments

Create checklist

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

Create a new checklist in a project

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

Search existing checklists in 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`)
`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

Create a new checklist in a project using tab indented lines as checkable items. The items with the same indent level will be placed one under the other. An issue URL will be converted into the corresponding issue.

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

Tab indented lines are converted into checkable items following the same rules as in Import Checklist. The result is placed inside of the specified project checklist.

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}

Update an existing checklist in a project

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 )
topics: array of string ( Optional )

Response
No arguments

Delete checklist

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

Delete an existing checklist in a project

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

Get all starred checklists in a project

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

Get the content of a checklist in a project

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

Create a new issue in a project

Required permissions: Create 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 SprintIdentifier ( Optional , defaults to [])
attachments: array of AttachmentIn ( Nullable and Optional , defaults to [])
fromMessage: MessageLink ( Nullable and Optional , defaults to null)
customFields: array of CustomFieldInputValue ( Nullable and Optional , defaults to null)
topics: array of string ( Nullable and Optional , defaults to null)
parents: array of IssueIdentifier ( Nullable and Optional , defaults to null)

Response
`Issue`

Get all issues

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

Search existing issues in a project. Parameters are applied as ' AND ' filters.

Required permissions: 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) ( Optional , defaults to `[]`)
`createdByProfileId`: string in one of the formats `externalId`: `string` `id`: `string` `me` `username`: `string` (Query) ( Nullable and Optional , defaults to `null`) Deprecated since 2022-05-01: Use createdBy instead.
`createdBy`: array of `PrincipalIn` (Query) ( Optional , defaults to `[]`)
`statuses`: array of `string` (Query) ( Optional , defaults to `[]`)
`tagId`: `string` (Query) ( Nullable and Optional , defaults to `null`) Deprecated since 2021-09-02: Use tags instead.
`query`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sorting`: `IssuesSorting` (Query) ( Required )
`descending`: `boolean` (Query) ( Required )
`tags`: array of `string` (Query) ( Optional , defaults to `[]`)
`sprints`: array of `SprintIdentifier` (Query) ( Optional , defaults to `[]`)
`boards`: array of `BoardIdentifier` (Query) ( Optional , defaults to `[]`)
`customFields`: array of `string` (Query) ( Nullable and Optional , defaults to `null`)
`importTransaction`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`creationTimeFrom`: `string` (format: date-time) (Query) ( Nullable and Optional , defaults to `null`)
`creationTimeTo`: `string` (format: date-time) (Query) ( Nullable and Optional , defaults to `null`)
`dueDateFrom`: `string` (format: full-date) (Query) ( Nullable and Optional , defaults to `null`)
`dueDateTo`: `string` (format: full-date) (Query) ( Nullable and Optional , defaults to `null`)
`topics`: array of `string` (Query) ( Nullable and Optional , defaults to `null`)
`grouping`: `IssueListGrouping` (Query) ( Nullable and Optional , defaults to `null`)
`deployment`: `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 )

Import issues

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

Import issues in a project

Required permissions: Import issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

metadata: ImportMetadata ( Required )
issues: array of ImportIssue ( Required )
assigneeMissingPolicy: ImportMissingPolicy ( Optional )
statusMissingPolicy: ImportMissingPolicy ( Optional )
onExistsPolicy: ImportExistsPolicy ( Optional )
dryRun: boolean ( Required )
notifySubscribers: boolean ( Optional , defaults to false)
Deprecated since 2022-08-11: The option to notify subscribers during issue import is no longer supported.

Response
`IssueImportResult`

Restore issue

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

Restore an issue in a project

Required permissions: Restore issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

Response
No arguments

Toggle issue resolved status

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

Toggle status of an existing issue between resolved and unresolved

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

object with fields:

resolved: boolean ( Required )

Response
No arguments

Get sync batch

get /api/http/projects/{project}/planning/issues/sync-batch

Get issues in specified project for synchronization with third-party system. Issues with etag greater than specified value are returned. Read more in the documentation.

Required permissions: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

batchInfo: string in one of the formats

{ etag: string , batchSize: integer (format: int32) }

(Query) ( Required )

Response

object with fields:

etag: string ( Required )
data: array of Issue ( Required )
hasMore: boolean ( Required )

Get issue by number

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

Find an existing issue by a given number in a project

Required permissions: View issues

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`number`: `integer` (format: int32) (Path) ( Required )
`resolveAlias`: `boolean` (Query) ( Optional , defaults to `false`)
`withDeleted`: `boolean` (Query) ( Nullable and Optional , defaults to `null`)

Response
`Issue`

Get issue

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

Required permissions: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

withDeleted: boolean (Query) ( Nullable and Optional , defaults to null)

Response
`Issue`

Update issue

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

Update an existing issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: 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 )
customFields: array of CustomFieldInputValue ( Optional , defaults to [])
notifySubscribers: boolean ( Optional , defaults to true)

Response
No arguments

Delete issue

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

Delete an issue from a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

Response
No arguments

Get issue field order

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

Query order for built-in issue fields

Required permissions: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

onlyVisible: boolean (Query) ( Optional , defaults to true)

Response
`TrackerIssueFieldOrder`

Set issue field order

patch /api/http/projects/{project}/planning/issues/fields/order

Query order for built-in issue fields

Required permissions: Manage issue settings

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

fieldOrder: array of IssueFieldOrderIn ( Required )

Response
No arguments

Get issue field visibility

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

Query visibility for built-in issue fields

Required permissions: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

Response
`TrackerIssueFieldVisibility`

Update issue field visibility

patch /api/http/projects/{project}/planning/issues/fields/visibility

Set visibility for a built-in issue field

Required permissions: Manage issue settings

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

field: IssueSystemFieldEnum ( Required )
visible: boolean ( Required )

Response
No arguments

Get all issue statuses

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

Get all existing issue statuses in a project

Required permissions: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

Response
array of `IssueStatus`

Update issue statuses list

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

Configure issue statuses in a project. The list must contain at least one resolved and one unresolved status.

Required permissions: Manage issue settings

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

statuses: array of IssueStatusData ( Required )

Response
No arguments

Get auto update target issue status for merge request merge

get /api/http/projects/{project}/planning/issues/statuses/auto-update-on-merge-request-merge

Get target issue status for auto updating issues on linked merge request merge

Required permissions: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

Response
`IssueStatus`

Set auto update target issue status for merge request merge

patch /api/http/projects/{project}/planning/issues/statuses/auto-update-on-merge-request-merge

Set target issue status for auto updating issues on linked merge request merge

Required permissions: Manage issue settings

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

statusId: string ( Nullable and Optional , defaults to null)

Response
No arguments

Get issue status distribution

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

Get all existing issue statuses with their usage, number of existing issues, in a project

Required permissions: View issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

Response
array of `IssueStatusWithUsages`

Add attachment

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

Add attachment to an existing issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

object with fields:

attachment: AttachmentIn ( Required )

Response
No arguments

Remove attachment

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

Remove attachment from an existing issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

attachmentId: string (Path) ( Required )

Response
No arguments

Add attachments

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

Add attachments to an existing issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

object with fields:

attachments: array of AttachmentIn ( Required )

Response
No arguments

Remove attachments

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

Remove attachments from an existing issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: 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}

Add the checklist to an existing issue in a project

Required permissions: Update issues, Edit documents

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}

Remove the checklist from an existing issue in a project

Required permissions: Update issues, Edit documents

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

Add code review links

post /api/http/projects/{project}/planning/issues/{issueId}/code-reviews

Add code review links to an existing issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

object with fields:

codeReviewIds: array of ReviewIdentifier ( Required )

Response
No arguments

Remove code review links

delete /api/http/projects/{project}/planning/issues/{issueId}/code-reviews

Remove code review links from an existing issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

codeReviewIds: array of ReviewIdentifier (Query) ( Required )

Response
No arguments

Import issue comment history

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

Required permissions: Import issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

object with fields:

comments: array of MessageForImport ( Required )

Response
array of `string`

Add commit links

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

Add commit links to an existing issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

object with fields:

repository: string ( Required )
commitIds: array of string ( Required )

Response
No arguments

Remove commit links

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

Remove commit links from an existing issue in a project

Required permissions: Update issues

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`issueId`: string in one of the formats `{` `project`: `ProjectIdentifier` `, externalId`: `string` `}` Identifies issue in Space that was earlier imported from an external system by external id provided during the import. `id`: `string` `key`: `string` (Path) ( Required )
`repository`: `string` (Query) ( Required )
`commitIds`: array of `string` (Query) ( Required )

Response
No arguments

Add issue tag

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

Add an existing tag to an issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

tagId: string (Path) ( Required )

Response
No arguments

Remove issue tag

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

Remove an existing tag from an issue in a project

Required permissions: Update issues

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

issueId: string in one of the formats

{ project: ProjectIdentifier , externalId: string }
Identifies issue in Space that was earlier imported from an external system by external id provided during the import.
id: string
key: string

(Path) ( Required )

tagId: string (Path) ( Required )

Response
No arguments

Create hierarchical tag

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

Create a new hierarchical tag in a project

Required permissions: Manage 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

Search existing tags in a project

Required permissions: View project details

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 )

Test remote connection

post /api/http/projects/{project}/repositories/test-connection

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

repository: string ( Nullable and Optional , defaults to null)
remote: RemoteRepository ( Required )

Response
`TestConnectionResult`

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`

Get repository info

get /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
`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

Cherry pick commit

post /api/http/projects/{project}/repositories/{repository}/cherry-pick-commit

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

object with fields:

commit: string ( Required )
targetBranch: string ( Required )

Response
`GitCherryPickResult`

Commit changes to repository

post /api/http/projects/{project}/repositories/{repository}/commit

Request arguments

project: string (Path) ( Required )

repository: string (Path) ( Required )

object with fields:

baseCommit: string ( Required )
targetBranch: string ( Required )
commitMessage: string ( Required )
files: array of GitCommitFileRequest ( Required )

Response
`GitCommitResult`

Delete branch

post /api/http/projects/{project}/repositories/{repository}/delete-branch

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

object with fields:

branch: string ( Required )

Response
No arguments

Set repository description

post /api/http/projects/{project}/repositories/{repository}/description

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

object with fields:

description: string ( Required )

Response
No arguments

Invoke garbage collection on repository

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

Set head to given target commit

post /api/http/projects/{project}/repositories/{repository}/head

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

object with fields:

head: string ( Required )
target: string ( Required )
source: string ( Nullable and Optional , defaults to null)
If specified, the head should point to given commit before updating

Response
No arguments

Merge branch

post /api/http/projects/{project}/repositories/{repository}/merge-branch

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 ( Nullable and Optional , defaults to null)
commitMessage: string ( Nullable and Optional , defaults to null)
mergeMode: GitMergeMode ( Required )

Response
`GitMergeBranchResult`

Migrate repository

post /api/http/projects/{project}/repositories/{repository}/migrate

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

object with fields:

description: string ( Required )
remote: RemoteRepository ( Required )
mirror: RepositoryMirrorOptions ( Nullable and Optional , defaults to null)

Response
`PR_RepositoryInfo`

Rebase branch

post /api/http/projects/{project}/repositories/{repository}/rebase-branch

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 ( Nullable and Optional , defaults to null)
rebaseMode: GitRebaseMode ( Required )
squash: GitSquashMode ( Required )
squashedCommitMessage: string ( Nullable and Optional , defaults to null)

Response
`GitRebaseResult`

Get commit changes

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

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`repository`: `string` (Path) ( Required )
`commit`: `string` (Query) ( Required )
`limit`: `integer` (format: int32) (Query) ( Required )

Response
array of `GitFileChange`

List the heads which contains given commit

get /api/http/projects/{project}/repositories/{repository}/commit-branches

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`repository`: `string` (Path) ( Required )
`commit`: `string` (Query) ( Required )
`prefix`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`limit`: `integer` (format: int32) (Query) ( Nullable and Optional , defaults to `null`)

Response
array of `BranchInfo`

List commits matching query

get /api/http/projects/{project}/repositories/{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 )

List files in directory

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

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`repository`: `string` (Path) ( Required )
`commit`: `string` (Query) ( Required )
`path`: `string` (Query) ( Required )

Response
array of `GitFile`

Get repository heads

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

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`repository`: `string` (Path) ( Required )
`pattern`: array of `string` (Query) ( Optional , defaults to `[]`) If specified, allows filtering heads matching provided patterns. If not specified, all heads are returned.
`isRegex`: `boolean` (Query) ( Optional , defaults to `false`)
`$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 BranchInfo ( Required )

Get inline merge diff

get /api/http/projects/{project}/repositories/{repository}/inline-merge-diff

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`repository`: `string` (Path) ( Required )
`baseBlobId`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`sourceBlobId`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`targetBlobId`: `string` (Query) ( Nullable and Optional , defaults to `null`)
`entryType`: `GitEntryType` (Query) ( Required )
`ignoreWhitespaces`: `boolean` (Query) ( Optional , defaults to `false`)
`squashSimpleChanges`: `boolean` (Query) ( Optional , defaults to `true`)

Response
`InlineDiff`

List files to be merged on merge branches

get /api/http/projects/{project}/repositories/{repository}/merge-preview

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`repository`: `string` (Path) ( Required )
`sourceBranch`: `string` (Query) ( Required )
`targetBranch`: `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 GitMergedFile ( Required )

Preview merge branches result

get /api/http/projects/{project}/repositories/{repository}/merge-preview-status

Dry run merge source branch into target without modifying the repository. Please note that conflicting status is based on per-file analysis, so it may not be accurate on too diverged branches.

Request arguments
`project`: string in one of the formats `id`: `string` `key`: `string` (Path) ( Required )
`repository`: `string` (Path) ( Required )
`sourceBranch`: `string` (Query) ( Required )
`targetBranch`: `string` (Query) ( Required )

Response
`GitMergeBranchResult`

Get remote url of a git repository

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

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

Response
`RepositoryUrls`

Set repository default branch

post /api/http/projects/{project}/repositories/{repository}/default-branch

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

object with fields:

branch: string ( Required )

Response
No arguments

Get repository default branch

get /api/http/projects/{project}/repositories/{repository}/default-branch

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

Response
`string`

Set repository frozen state

post /api/http/projects/{project}/repositories/{repository}/readonly

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

object with fields:

freeze: boolean ( Required )

Response
No arguments

Get repository frozen state

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

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

Response
`boolean`

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 ) `taskBuildId`: `string` ( Nullable and Optional , defaults to `null`) `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 a 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`

Set repository settings

post /api/http/projects/{project}/repositories/{repository}/settings

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

object with fields:

settings: GitRepositorySettings ( Required )

Response
No arguments

Get repository settings

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

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

repository: string (Path) ( Required )

Response
`GitRepositorySettings`

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

Create topic

post /api/http/projects/{project}/topics

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

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

Response
`Topic`

Get topic

get /api/http/projects/{project}/topics

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

Response
array of `Topic`

Remove topics

post /api/http/projects/{project}/topics/remove-topics

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

ids: array of string ( Required )

Response
No arguments

Set responsible

post /api/http/projects/{project}/topics/set-responsible

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

object with fields:

topicId: string ( Required )
responsible: array of ProfileIdentifier ( Required )

Response
No arguments

Update topic

patch /api/http/projects/{project}/topics/{id}

Request arguments

project: string in one of the formats

id: string
key: string

(Path) ( Required )

id: string (Path) ( Required )

object with fields:

name: string ( Optional )
parentTopicId: string ( Nullable and Optional )

Response
`Topic`

Last modified: 06 September 2023