Projects Create project post /api/http/projects
Create a new project
Rights, that may be checked: Create projects
Request arguments
object with fields :
key
: ProjectKey
name
: string
description
: string
( Nullable and Optional , defaults to null
)
private
: boolean
( Optional , defaults to false
)
tags
: array of string
( Optional , defaults to []
)
Get all projects get /api/http/projects
Get/search all projects. Parameters are applied as ' AND ' filters.
Request arguments
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
term
: string
(Query) ( Nullable and Optional , defaults to null
)
tag
: string
(Query) ( Nullable and Optional , defaults to null
)
starred
: boolean
(Query) ( Nullable and Optional , defaults to null
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PR_Project
Get all projects by collaborator get /api/http/projects/collaborator:{profile}
Get all projects in which given user is a collaborator
Request arguments
profile
: string in one of the formats
externalId
: string
id
: string
me
username
: string
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PR_Project
Get all projects by member get /api/http/projects/member:{member}
Get all projects for a member
Request arguments
member
: string in one of the formats
externalId
: string
id
: string
me
username
: string
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PR_Project
Get all projects with right get /api/http/projects/right-code:{rightCode}
Request arguments
rightCode
: string
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PR_Project
Get all projects with right code get /api/http/projects/right-unique-code:{right}
Request arguments
right
: string
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PR_Project
Get all projects by team get /api/http/projects/team:{team}
Get all projects for a team
Request arguments
team
: string
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PR_Project
Get project get /api/http/projects/{project}
Get project by ID or project key
Request arguments
project
: string in one of the formats
(Path)
Update project patch /api/http/projects/{project}
Update an existing project. Optional parameters will be ignored when not specified and updated otherwise.
Request arguments
project
: string in one of the formats
(Path)
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 )
Delete project delete /api/http/projects/{project}
Delete a project
Rights, that may be checked: Manage project permission scheme
Request arguments
project
: string in one of the formats
(Path)
Get dsl evaluation configuration get /api/http/projects/automation/dsl-evaluations/config
Request arguments
No arguments
Stop execution post /api/http/projects/automation/graph-executions/{id}/stop
Stop execution by ExecutionId
Rights, that may be checked: Stop automation jobs
Request arguments
id
: string
(Path)
Get graph execution get /api/http/projects/automation/graph-executions/{id}
Rights, that may be checked: View automation jobs
Request arguments
id
: string
(Path)
Get current get /api/http/projects/automation/job-executions/current
Rights, that may be checked: View automation jobs
Request arguments
No arguments
Get job get /api/http/projects/automation/jobs/{jobId}
Rights, that may be checked: View automation jobs
Request arguments
jobId
: string
(Path)
project
: string in one of the formats
(Query)
Get param get /api/http/projects/automation/step-executions/used-parameters/param/{parameterId}
Request arguments
parameterId
: string
(Path)
Get secret get /api/http/projects/automation/step-executions/used-parameters/secret/{secretId}
Request arguments
secretId
: string
(Path)
Get parameter get /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}
Request arguments
stepExecId
: string
(Path)
key
: string
(Path)
Update parameter patch /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}
Request arguments
stepExecId
: string
(Path)
key
: string
(Path)
object with fields :
value
: string
Delete parameter delete /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}
Request arguments
stepExecId
: string
(Path)
key
: string
(Path)
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
(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
Update param patch /api/http/projects/params/{id}
Update an existing project parameter
Rights, that may be checked: Modify project parameters
Request arguments
id
: string
(Path)
object with fields :
Delete param delete /api/http/projects/params/{id}
Delete an existing project parameter
Rights, that may be checked: Delete project parameters
Request arguments
id
: string
(Path)
Create default bundle (parameters) post /api/http/projects/params/default-bundle
Create a new project parameter in the default parameter bundle
Rights, that may be checked: Modify project parameters
Request arguments
object with fields :
Get all default bundle (parameters) get /api/http/projects/params/default-bundle
List project parameters in a parameter bundle
Rights, that may be checked: View project parameters
Request arguments
project
: string in one of the formats
(Query)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PlainParameterRecord
Create in default bundle (parameters) post /api/http/projects/params/in-default-bundle
Rights, that may be checked: Modify project parameters
Request arguments
object with fields :
projectId
: string
key
: string
value
: string
Get all in default bundle (parameters) get /api/http/projects/params/in-default-bundle
List project parameters in a parameter bundle
Rights, that may be checked: View project parameters
Request arguments
projectId
: string
(Query)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PlainParameterRecord
Get board get /api/http/projects/planning/boards/{board}
Get a board by identifier
Rights, that may be checked: View boards
Request arguments
board
: string in one of the formats
(Path)
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.
Rights, that may be checked: Manage boards
Request arguments
board
: string in one of the formats
(Path)
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
)
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.
Rights, that may be checked: Manage boards
Request arguments
board
: string in one of the formats
(Path)
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.
Rights, that may be checked: Manage boards
Request arguments
object with fields :
board
: BoardIdentifier
name
: string
description
: string
( Nullable and Optional , defaults to null
)
from
: string
(format: full-date)
to
: string
(format: full-date)
launch
: SprintLaunch
( Optional )
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.
Rights, that may be checked: Manage boards
Request arguments
sprint
: string in one of the formats
(Path)
object with fields :
moveUnresolvedIssuesFromCurrentSprint
: boolean
notifySubscribers
: boolean
( Optional , defaults to true
)
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.
Rights, that may be checked: Manage boards
Request arguments
sprint
: string in one of the formats
(Path)
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
)
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.
Rights, that may be checked: Manage boards
Request arguments
sprint
: string in one of the formats
(Path)
Add issue to sprint post /api/http/projects/planning/boards/sprints/{sprint}/issues/{issue}
Add an existing issue in a project to a sprint
Rights, that may be checked: Manage issue assignment
Request arguments
issue
: string in one of the formats
(Path)
sprint
: string in one of the formats
(Path)
Remove issue from sprint delete /api/http/projects/planning/boards/sprints/{sprint}/issues/{issue}
Remove an existing issue in a project from a sprint.
Rights, that may be checked: Manage issue assignment
Request arguments
issue
: string in one of the formats
(Path)
sprint
: string in one of the formats
(Path)
Get all issues in sprint get /api/http/projects/planning/boards/sprints/{sprint}/issues
Fetch issues from an existing non-archived sprint
Rights, that may be checked: View boards
Request arguments
sprint
: string in one of the formats
(Path)
$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 :
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
Rights, that may be checked: Manage issue assignment
Request arguments
issue
: string in one of the formats
(Path)
board
: string in one of the formats
(Path)
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
Rights, that may be checked: Manage issue assignment
Request arguments
issue
: string in one of the formats
(Path)
board
: string in one of the formats
(Path)
Get all issues on board get /api/http/projects/planning/boards/{board}/issues
Fetch issues from the board across all its non-archived sprints
Rights, that may be checked: View boards
Request arguments
board
: string in one of the formats
(Path)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
Response
object with fields :
Request access to project post /api/http/projects/private-projects/{project}/request-access
Request access to a project
Request arguments
project
: string in one of the formats
(Path)
Get all private projects get /api/http/projects/private-projects
List private projects in the current organization
Request arguments
No arguments
Get all find get /api/http/projects/repositories/find
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)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of RepositoryDetails
Add responsibility post /api/http/projects/responsibilities
Add a responsibility for a given subject ID
Request arguments
object with fields :
Update responsibility patch /api/http/projects/responsibilities/{responsibilityId}
Edit an existing responsibility
Request arguments
responsibilityId
: string
(Path)
object with fields :
Delete responsibility delete /api/http/projects/responsibilities/{responsibilityId}
Delete an existing responsibility
Request arguments
responsibilityId
: string
(Path)
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)
project
: string in one of the formats
(Query) ( Nullable and Optional , defaults to null
)
Update secret patch /api/http/projects/secrets/{id}
Update an existing project secret
Rights, that may be checked: Update project secrets
Request arguments
id
: string
(Path)
object with fields :
valueBase64
: string
publicKeyId
: string
( Nullable and Optional , defaults to null
)
description
: string
( Nullable and Optional , defaults to null
)
Delete secret delete /api/http/projects/secrets/{id}
Delete an existing project secret
Rights, that may be checked: Delete project secrets
Request arguments
id
: string
(Path)
Create default bundle (secrets) post /api/http/projects/secrets/default-bundle
Create a new secret in the default parameter bundle. Value is base64 encoded bytes of the secret value, possibly after client side encryption. If the secret value bytes are encrypted then the id of the Space public key must be provided
Rights, that may be checked: Create project secrets
Request arguments
object with fields :
project
: ProjectIdentifier
key
: string
valueBase64
: string
publicKeyId
: string
( Nullable and Optional , defaults to null
)
description
: string
( Nullable and Optional , defaults to null
)
Get all default bundle (secrets) get /api/http/projects/secrets/default-bundle
List project secrets in a parameter bundle
Rights, that may be checked: View keys of project secrets
Request arguments
project
: string in one of the formats
(Query)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of SecretParameterRecord
Create in default bundle (secrets) post /api/http/projects/secrets/in-default-bundle
Rights, that may be checked: Create project secrets
Request arguments
object with fields :
Get all in default bundle (secrets) get /api/http/projects/secrets/in-default-bundle
Rights, that may be checked: View keys of project secrets
Request arguments
projectId
: string
(Query)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of SecretParameterRecord
Track tag access post /api/http/projects/tags/track-access
Track a tag has been accessed
Request arguments
object with fields :
tag
: string
get /api/http/projects/tags
List all tags, mapped to the number of projects they are used in
Request arguments
No arguments
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
Rights, that may be checked: Modify Vault connections
Request arguments
object with fields :
project
: ProjectIdentifier
url
: string
name
: string
namespace
: string
( Nullable and Optional , defaults to null
)
vaultNamespace
: string
( Nullable and Optional , defaults to null
)
appRoleEndpointPath
: string
appRoleId
: string
appRoleSecretIdBase64
: string
Get vault get /api/http/projects/vault
Get an existing Vault connections for project
Rights, that may be checked: View Vault connections
Request arguments
project
: string in one of the formats
(Query)
Update vault patch /api/http/projects/vault/{id}
Update an existing Vault connection
Rights, that may be checked: Modify Vault connections
Request arguments
id
: string
(Path)
object with fields :
url
: string
name
: string
namespace
: string
( Nullable and Optional , defaults to null
)
vaultNamespace
: string
( Nullable and Optional , defaults to null
)
appRoleEndpointPath
: string
appRoleId
: string
appRoleSecretIdBase64
: string
( Nullable and Optional , defaults to null
)
Delete vault delete /api/http/projects/vault/{id}
Delete an existing Vault connection
Rights, that may be checked: Delete Vault connections
Request arguments
id
: string
(Path)
Get all admins get /api/http/projects/{project}/access/admins
Returns the list of all project administrators
Request arguments
project
: string in one of the formats
(Path)
Add administrator post /api/http/projects/{project}/access/admins/profiles
Add a member as administrator to a project
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Remove administrator delete /api/http/projects/{project}/access/admins/profiles/{profile}
Remove a member as administrator from a project
Request arguments
project
: string in one of the formats
(Path)
profile
: string in one of the formats
externalId
: string
id
: string
me
username
: string
(Path)
Add administrators team post /api/http/projects/{project}/access/admins/teams
Add a team as administrators to a project
Request arguments
project
: string in one of the formats
(Path)
object with fields :
teamId
: string
Remove administrators team delete /api/http/projects/{project}/access/admins/teams/{teamId}
Remove a team as administrators from a project
Request arguments
project
: string in one of the formats
(Path)
teamId
: string
(Path)
Get all collaborators' profiles get /api/http/projects/{project}/access/collaborators
Request arguments
project
: string in one of the formats
(Path)
Add a collaborator post /api/http/projects/{project}/access/collaborators/profiles
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Get all individual collaborators get /api/http/projects/{project}/access/collaborators/profiles
Request arguments
project
: string in one of the formats
(Path)
Remove a collaborator delete /api/http/projects/{project}/access/collaborators/profiles
Request arguments
project
: string in one of the formats
(Path)
profile
: string in one of the formats
externalId
: string
id
: string
me
username
: string
(Query)
Add a collaborators' team post /api/http/projects/{project}/access/collaborators/teams
Request arguments
project
: string in one of the formats
(Path)
object with fields :
teamId
: string
Get all collaborators' teams get /api/http/projects/{project}/access/collaborators/teams
Request arguments
project
: string in one of the formats
(Path)
Remove a collaborators' team delete /api/http/projects/{project}/access/collaborators/teams
Request arguments
project
: string in one of the formats
(Path)
teamId
: string
(Query)
Get all member profiles get /api/http/projects/{project}/access/member-profiles
Get project members for a given project key
Rights, that may be checked: View project details
Request arguments
project
: string in one of the formats
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of TD_MemberProfile
Add member post /api/http/projects/{project}/access/members/profiles
Add a member to a project
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Remove member delete /api/http/projects/{project}/access/members/profiles/{profile}
Remove a member from a project
Request arguments
project
: string in one of the formats
(Path)
profile
: string in one of the formats
externalId
: string
id
: string
me
username
: string
(Path)
Add team post /api/http/projects/{project}/access/members/teams
Add a team to a project
Request arguments
project
: string in one of the formats
(Path)
object with fields :
teamId
: string
Remove team delete /api/http/projects/{project}/access/members/teams/{teamId}
Remove a team from a project
Request arguments
project
: string in one of the formats
(Path)
teamId
: string
(Path)
Organization profiles that can view the project get /api/http/projects/{project}/access/viewers
Get organization members who can view a project
Request arguments
project
: string in one of the formats
(Path)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
term
: string
(Query)
meOnTop
: boolean
(Query) ( Optional , defaults to false
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of TD_MemberProfile
Create post /api/http/projects/{project}/automation/deployment-targets
Rights, that may be checked: Modify deployment targets
Request arguments
project
: string in one of the formats
(Path)
object with fields :
List deployment targets get /api/http/projects/{project}/automation/deployment-targets
Rights, that may be checked: View deployments
Request arguments
project
: string in one of the formats
(Path)
search
: 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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of DeployTargetDTO
List favorites get /api/http/projects/{project}/automation/deployment-targets/favorites
Rights, that may be checked: View deployments
Request arguments
project
: string in one of the formats
(Path)
sortBy
: string
(Query) ( Nullable and Optional , defaults to null
)
sortOrder
: ColumnSortOrder
(Query) ( Nullable and Optional , defaults to null
)
Get deployment target get /api/http/projects/{project}/automation/deployment-targets/{identifier}
Rights, that may be checked: View deployments
Request arguments
project
: string in one of the formats
(Path)
identifier
: string in one of the formats
(Path)
Update deployment target put /api/http/projects/{project}/automation/deployment-targets/{identifier}
Request arguments
project
: string in one of the formats
(Path)
identifier
: string in one of the formats
(Path)
object with fields :
name
: string
description
: string
repositories
: array of DeployTargetRepositoryDTO
manualControl
: boolean
( Optional , defaults to true
)
hangTimeoutMinutes
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
failTimeoutMinutes
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
Delete deployment target delete /api/http/projects/{project}/automation/deployment-targets/{identifier}
Rights, that may be checked: Modify deployment targets
Request arguments
project
: string in one of the formats
(Path)
identifier
: string in one of the formats
(Path)
Fail post /api/http/projects/{project}/automation/deployments/fail
Rights, that may be checked: Modify deployments
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Finish post /api/http/projects/{project}/automation/deployments/finish
Rights, that may be checked: Modify deployments
Request arguments
project
: string in one of the formats
(Path)
object with fields :
targetIdentifier
: TargetIdentifier
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
)
Schedule post /api/http/projects/{project}/automation/deployments/schedule
Rights, that may be checked: Modify deployments
Request arguments
project
: string in one of the formats
(Path)
object with fields :
targetIdentifier
: TargetIdentifier
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
)
Start post /api/http/projects/{project}/automation/deployments/start
Rights, that may be checked: Modify deployments
Request arguments
project
: string in one of the formats
(Path)
object with fields :
targetIdentifier
: TargetIdentifier
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
)
List deployments get /api/http/projects/{project}/automation/deployments
Rights, that may be checked: View deployments
Request arguments
project
: string in one of the formats
(Path)
targetIdentifier
: string in one of the formats
(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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of DeploymentRecord
Update deployment put /api/http/projects/{project}/automation/deployments
Rights, that may be checked: Modify deployments
Request arguments
project
: string in one of the formats
(Path)
object with fields :
targetIdentifier
: TargetIdentifier
deploymentIdentifier
: DeploymentIdentifier
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
)
Get deployment get /api/http/projects/{project}/automation/deployments/{targetIdentifier}/{deploymentIdentifier}
Rights, that may be checked: View deployments
Request arguments
project
: string in one of the formats
(Path)
targetIdentifier
: string in one of the formats
(Path)
deploymentIdentifier
: string in one of the formats
(Path)
Delete deployment delete /api/http/projects/{project}/automation/deployments/{targetIdentifier}/{deploymentIdentifier}
Rights, that may be checked: Modify deployments
Request arguments
project
: string in one of the formats
(Path)
targetIdentifier
: string in one of the formats
(Path)
deploymentIdentifier
: string in one of the formats
(Path)
Get all graph executions get /api/http/projects/{project}/automation/graph-executions
Search executions. Parameters are applied as ' AND ' filters.
Rights, that may be checked: View automation jobs
Request arguments
project
: string in one of the formats
(Path)
jobId
: string
(Query)
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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of JobExecutionDTO
Start job post /api/http/projects/{project}/automation/jobs/{jobId}/start
Start job. Returns ExecutionId, see projects/automation/graph-executions/{id}.
Rights, that may be checked: Start automation jobs
Request arguments
project
: string in one of the formats
(Path)
jobId
: string
(Path)
object with fields :
Get all jobs get /api/http/projects/{project}/automation/jobs
List jobs. Parameters are applied as ' AND ' filters.
Rights, that may be checked: View automation jobs
Request arguments
project
: string in one of the formats
(Path)
repoFilter
: string
(Query)
branchFilter
: string
(Query)
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 :
Create code discussion post /api/http/projects/{project}/code-reviews/code-discussions
Rights, that may be checked: Create suggested edit
Request arguments
project
: string in one of the formats
(Path)
object with fields :
text
: string
diffContext
: DiffContext
( Nullable and Optional , defaults to null
)
repository
: string
revision
: string
filename
: string
( Nullable and Optional , defaults to null
)
line
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
oldLine
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
pending
: boolean
( Optional , defaults to false
)
reviewId
: ReviewIdentifier
( Nullable and Optional , defaults to null
)
Create review based on commit set post /api/http/projects/{project}/code-reviews/commit-set-review
Rights, that may be checked: Create code reviews
Request arguments
project
: string in one of the formats
(Path)
object with fields :
repository
: string
revisions
: array of string
title
: string
( Nullable and Optional , defaults to null
)
authorProfileIds
: array of string
( Nullable and Optional , defaults to null
)
Create merge request post /api/http/projects/{project}/code-reviews/merge-requests
Rights, that may be checked: Create code reviews
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Get all code reviews get /api/http/projects/{project}/code-reviews
Rights, that may be checked: View code reviews
Request arguments
project
: string in one of the formats
(Path)
$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
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of CodeReviewWithCount
Get code review get /api/http/projects/{project}/code-reviews/{reviewId}
Rights, that may be checked: View code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
Get review details get /api/http/projects/{project}/code-reviews/{reviewId}/details
Rights, that may be checked: View code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
Get the modified files in code review get /api/http/projects/{project}/code-reviews/{reviewId}/files
Rights, that may be checked: View code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of ChangeInReview
Get the merge request files get /api/http/projects/{project}/code-reviews/{reviewId}/merge-files
Rights, that may be checked: View code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of GitMergedFile
Get suggested reviewers get /api/http/projects/{project}/code-reviews/{reviewId}/suggested-reviewers
Rights, that may be checked: View code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
Get unread revisions get /api/http/projects/{project}/code-reviews/{reviewId}/unread-revisions
Rights, that may be checked: View code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
Edit review state patch /api/http/projects/{project}/code-reviews/{reviewId}/state
Rights, that may be checked: Edit code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
object with fields :
Edit review title patch /api/http/projects/{project}/code-reviews/{reviewId}/title
Rights, that may be checked: Edit code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
object with fields :
title
: string
Merge a merge request put /api/http/projects/{project}/code-reviews/{reviewId}/merge
Rights, that may be checked: View code reviews
, Write Git repositories
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
object with fields :
Rebase a merge request put /api/http/projects/{project}/code-reviews/{reviewId}/rebase
Rights, that may be checked: View code reviews
, Write Git repositories
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
object with fields :
deleteSourceBranch
: boolean
rebaseMode
: GitRebaseMode
squash
: boolean
squashedCommitMessage
: string
( Nullable and Optional , defaults to null
)
Add review participant post /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}
Rights, that may be checked: Edit code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
user
: string in one of the formats
externalId
: string
id
: string
me
username
: string
(Path)
object with fields :
Remove review participant delete /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}
Rights, that may be checked: Edit code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
user
: string in one of the formats
externalId
: string
id
: string
me
username
: string
(Path)
role
: CodeReviewParticipantRole
(Query)
Add revisions to review post /api/http/projects/{project}/code-reviews/{reviewId}/revisions
Rights, that may be checked: Edit code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
object with fields :
Remove revisions from review delete /api/http/projects/{project}/code-reviews/{reviewId}/revisions
Rights, that may be checked: Edit code reviews
Request arguments
project
: string in one of the formats
(Path)
reviewId
: string in one of the formats
(Path)
revisions
: array of string
(Query)
Create document post /api/http/projects/{project}/documents
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Get document get /api/http/projects/{project}/documents/{documentId}
Request arguments
project
: string in one of the formats
(Path)
documentId
: string
(Path)
Update document patch /api/http/projects/{project}/documents/{documentId}
Request arguments
project
: string in one of the formats
(Path)
documentId
: string
(Path)
object with fields :
Archive document delete /api/http/projects/{project}/documents/{documentId}
Request arguments
project
: string in one of the formats
(Path)
documentId
: string
(Path)
Create folder post /api/http/projects/{project}/documents/folders
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Get folder get /api/http/projects/{project}/documents/folders/{folder}
Request arguments
project
: string in one of the formats
(Path)
folder
: string in one of the formats
(Path)
Rename folder patch /api/http/projects/{project}/documents/folders/{folder}
Request arguments
project
: string in one of the formats
(Path)
folder
: string in one of the formats
(Path)
object with fields :
name
: string
Archive folder delete /api/http/projects/{project}/documents/folders/{folder}
Request arguments
project
: string in one of the formats
(Path)
folder
: string in one of the formats
(Path)
List documents in folder get /api/http/projects/{project}/documents/folders/{folder}/documents
Request arguments
project
: string in one of the formats
(Path)
folder
: string in one of the formats
(Path)
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 :
Add folder introduction patch /api/http/projects/{project}/documents/folders/{folder}/introduction/{documentId}
Request arguments
project
: string in one of the formats
(Path)
folder
: string in one of the formats
(Path)
documentId
: string
(Path)
Remove folder introduction delete /api/http/projects/{project}/documents/folders/{folder}/introduction
Request arguments
project
: string in one of the formats
(Path)
folder
: string in one of the formats
(Path)
Move folder patch /api/http/projects/{project}/documents/folders/{folder}/move
Request arguments
project
: string in one of the formats
(Path)
folder
: string in one of the formats
(Path)
object with fields :
List subfolders get /api/http/projects/{project}/documents/folders/{folder}/subfolders
Request arguments
project
: string in one of the formats
(Path)
folder
: string in one of the formats
(Path)
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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of DocumentFolder
Copy document post /api/http/projects/{project}/documents/{documentId}/copy
Request arguments
project
: string in one of the formats
(Path)
documentId
: string
(Path)
object with fields :
Delete document forever delete /api/http/projects/{project}/documents/{documentId}/delete-forever
Request arguments
project
: string in one of the formats
(Path)
documentId
: string
(Path)
Move document patch /api/http/projects/{project}/documents/{documentId}/move
Request arguments
project
: string in one of the formats
(Path)
documentId
: string
(Path)
object with fields :
Unarchive document patch /api/http/projects/{project}/documents/{documentId}/unarchive
Request arguments
project
: string in one of the formats
(Path)
documentId
: string
(Path)
Create new package repository post /api/http/projects/{project}/packages/repositories
Creates a new package repository for a given project ID
Rights, that may be checked: Create package repositories
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Get repositories get /api/http/projects/{project}/packages/repositories
Gets a list of package repositories for a given project ID
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
type
: string
(Query) ( Nullable and Optional , defaults to null
)
query
: string
(Query) ( Nullable and Optional , defaults to null
)
Get repository get /api/http/projects/{project}/packages/repositories/{repository}
Gets a package repository for a given project ID by type and name
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
Update repository patch /api/http/projects/{project}/packages/repositories/{repository}
Updates package repository settings for a given project ID
Rights, that may be checked: Admin package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
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
)
Delete package repository delete /api/http/projects/{project}/packages/repositories/{repository}
Removes package repository for a given project ID
Rights, that may be checked: Admin package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
Cleanup repository post /api/http/projects/{project}/packages/repositories/{repository}/cleanup
Cleanup specified package repository
Rights, that may be checked: Admin package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
object with fields :
Dry run repository cleanup post /api/http/projects/{project}/packages/repositories/{repository}/cleanup/dry
Dry run of cleanup for specified package repository
Rights, that may be checked: Admin package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
object with fields :
Get all remote repositories get /api/http/projects/{project}/packages/repositories/{repository}/connections
Gets a list of remote package repositories for given project
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
Publish packages to remote repository post /api/http/projects/{project}/packages/repositories/{repository}/connections/{connectionId}/publish
Publishes packages to remote repository
Rights, that may be checked: Write package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
connectionId
: string
(Path)
object with fields :
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
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
connectionId
: string
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PackagesPublishing
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
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
parentPath
: string
(Query) ( Nullable and Optional , defaults to null
)
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
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
filePath
: string
(Path)
Delete file delete /api/http/projects/{project}/packages/repositories/{repository}/files/name:{filePath}
Removes a file in repository for a given project ID
Rights, that may be checked: Write package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
filePath
: string
(Path)
Get all packages get /api/http/projects/{project}/packages/repositories/{repository}/packages
Gets a list of repository packages for a given project ID
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
query
: string
(Query)
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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PackageData
Delete package delete /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}
Removes all package versions in repository for a given project ID
Rights, that may be checked: Write package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
packageName
: string
(Path)
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
(Path)
repository
: string in one of the formats
(Path)
packageName
: string
(Path)
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
(Path)
repository
: string in one of the formats
(Path)
packageName
: string
(Path)
object with fields :
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
(Path)
repository
: string in one of the formats
(Path)
packageName
: string
(Path)
packageVersion
: string
(Path)
object with fields :
Get all package versions get /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions
Gets a list of repository package versions for a given project ID
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
packageName
: string
(Path)
query
: string
(Query)
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)
sortOrder
: ColumnSortOrder
(Query)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PackageVersionData
Get package version details get /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions/version:{packageVersion}
Gets a details for repository package version for a given project ID
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
packageName
: string
(Path)
packageVersion
: string
(Path)
Delete package version delete /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions/version:{packageVersion}
Removes a package version in repository for a given project ID
Rights, that may be checked: Write package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
packageName
: string
(Path)
packageVersion
: string
(Path)
Get repository url get /api/http/projects/{project}/packages/repositories/{repository}/url
Gets a package repository URL for a given project ID
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
repository
: string in one of the formats
(Path)
Get all packages (deprecated) get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages
Deprecated since 2020-09-01: Use GET /projects/{project}/packages/repositories/{repository}/packages. It will be removed in a future version.
Gets a list of repository packages for a given project ID
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
type
: string
(Path)
repositoryName
: string
(Path)
query
: string
(Query)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PackageData
Get all package versions (deprecated) get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions
Deprecated since 2020-09-01: Use GET /projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions. It will be removed in a future version.
Gets a list of repository package versions for a given project ID
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
type
: string
(Path)
repositoryName
: string
(Path)
packageName
: string
(Path)
query
: string
(Query)
$skip
: string
(Query) ( Nullable and Optional , defaults to null
)
$top
: integer
(format: int32) (Query) ( Nullable and Optional , defaults to 100
)
sortColumn
: PackagesSortColumn
(Query)
sortOrder
: ColumnSortOrder
(Query)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PackageVersionData
Get package version details (deprecated) get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions/version:{packageVersion}
Deprecated since 2020-09-01: Use GET /projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions/version:{packageVersion}. It will be removed in a future version.
Gets a details for repository package version for a given project ID
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
type
: string
(Path)
repositoryName
: string
(Path)
packageName
: string
(Path)
packageVersion
: string
(Path)
Delete package version (deprecated) delete /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions/version:{packageVersion}
Deprecated since 2020-09-01: Use DELETE /projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/versions/version:{packageVersion}. It will be removed in a future version.
Removes a package version in repository for a given project ID
Rights, that may be checked: Write package repositories
Request arguments
project
: string in one of the formats
(Path)
type
: string
(Path)
repositoryName
: string
(Path)
packageName
: string
(Path)
packageVersion
: string
(Path)
Find packages in repository get /api/http/projects/{project}/packages/search
Executes a package search for a given project ID
Rights, that may be checked: Read package repositories
Request arguments
project
: string in one of the formats
(Path)
type
: string
(Query)
query
: string
(Query)
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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PackageVersionData
Get all types get /api/http/projects/{project}/packages/types
Creates a new package repository for a given project ID
Request arguments
project
: string in one of the formats
(Path)
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.
Rights, that may be checked: Create boards
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Get all boards get /api/http/projects/{project}/planning/boards
Search existing boards in a project
Rights, that may be checked: View boards
Request arguments
project
: string in one of the formats
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of BoardRecord
Get all sprints get /api/http/projects/{project}/planning/boards/sprints
Search existing sprints in a project
Rights, that may be checked: View boards
Request arguments
project
: string in one of the formats
(Path)
$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
(Query) ( Nullable and Optional , defaults to null
)
query
: string
(Query) ( Nullable and Optional , defaults to null
)
Response
object with fields :
next
: string
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of SprintRecord
Get all starred boards get /api/http/projects/{project}/planning/boards/starred
Get all starred boards in a project
Rights, that may be checked: View boards
Request arguments
project
: string in one of the formats
(Path)
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.
Rights, that may be checked: Manage boards
Request arguments
project
: string in one of the formats
(Path)
board
: string in one of the formats
(Path)
Create checklist post /api/http/projects/{project}/planning/checklists
Deprecated since 2022-04-08: Use POST on projects/{project}/documents. It will be removed in a future version.
Create a new checklist in a project
Request arguments
project
: string in one of the formats
(Path)
object with fields :
name
: string
Get all checklists get /api/http/projects/{project}/planning/checklists
Deprecated since 2022-04-08: Use GET on projects/{project}/documents/folders/{folder}/documents. It will be removed in a future version.
Search existing checklists in a project
Request arguments
project
: string in one of the formats
(Path)
$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 :
Import checklist post /api/http/projects/{project}/planning/checklists/import
Deprecated since 2022-04-08: Use POST on projects/{project}/documents. It will be removed in a future version.
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
(Path)
object with fields :
name
: string
tabIndentedLines
: string
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
(Path)
checklistId
: string
(Path)
object with fields :
Update checklist patch /api/http/projects/{project}/planning/checklists/{checklistId}
Deprecated since 2022-04-08: Use PATCH on projects/{project}/documents/{documentId}. It will be removed in a future version.
Update an existing checklist in a project
Request arguments
project
: string in one of the formats
(Path)
checklistId
: string
(Path)
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 )
Delete checklist delete /api/http/projects/{project}/planning/checklists/{checklistId}
Deprecated since 2022-04-08: Use DELETE on projects/{project}/documents/{documentId}. It will be removed in a future version.
Delete an existing checklist in a project
Request arguments
project
: string in one of the formats
(Path)
checklistId
: string
(Path)
Get all starred checklists get /api/http/projects/{project}/planning/checklists/starred
Deprecated since 2022-04-08: [SPACE-13768]: Not implemented yet. It will be removed in a future version.
Get all starred checklists in a project
Request arguments
project
: string in one of the formats
(Path)
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
(Path)
checklistId
: string
(Path)
Create issue post /api/http/projects/{project}/planning/issues
Create a new issue in a project
Rights, that may be checked: Create issues
Request arguments
project
: string in one of the formats
(Path)
object with fields :
title
: string
description
: string
( Nullable and Optional , defaults to null
)
assignee
: ProfileIdentifier
( Nullable and Optional , defaults to null
)
status
: string
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
)
Get all issues get /api/http/projects/{project}/planning/issues
Search existing issues in a project. Parameters are applied as ' AND ' filters.
Rights, that may be checked: View issues
Request arguments
project
: string in one of the formats
(Path)
$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
)
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
)
query
: string
(Query) ( Nullable and Optional , defaults to null
)
sorting
: IssuesSorting
(Query)
descending
: boolean
(Query)
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 :
Import issues post /api/http/projects/{project}/planning/issues/import
Import issues in a project
Rights, that may be checked: Import issues
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Restore issue post /api/http/projects/{project}/planning/issues/{issueId}/restore
Restore an issue in a project
Rights, that may be checked: Restore issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
Toggle issue resolved status post /api/http/projects/{project}/planning/issues/{issueId}/toggle-resolved
Toggle status of an existing issue between resolved and unresolved
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
object with fields :
resolved
: boolean
Get issue by number get /api/http/projects/{project}/planning/issues/number:{number}
Find an existing issue by a given number in a project
Rights, that may be checked: View issues
Request arguments
project
: string in one of the formats
(Path)
number
: integer
(format: int32) (Path)
resolveAlias
: boolean
(Query) ( Optional , defaults to false
)
withDeleted
: boolean
(Query) ( Nullable and Optional , defaults to null
)
Get issue get /api/http/projects/{project}/planning/issues/{issueId}
Rights, that may be checked: View issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
withDeleted
: boolean
(Query) ( Nullable and Optional , defaults to null
)
Update issue patch /api/http/projects/{project}/planning/issues/{issueId}
Update an existing issue in a project
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
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
)
Delete issue delete /api/http/projects/{project}/planning/issues/{issueId}
Delete an issue from a project
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
Get all issue statuses get /api/http/projects/{project}/planning/issues/statuses
Get all existing issue statuses in a project
Rights, that may be checked: View issues
Request arguments
project
: string in one of the formats
(Path)
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.
Rights, that may be checked: Manage issue settings
Request arguments
project
: string in one of the formats
(Path)
object with fields :
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
Rights, that may be checked: View issues
Request arguments
project
: string in one of the formats
(Path)
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
Rights, that may be checked: Manage issue settings
Request arguments
project
: string in one of the formats
(Path)
object with fields :
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
Rights, that may be checked: View issues
Request arguments
project
: string in one of the formats
(Path)
Add attachments post /api/http/projects/{project}/planning/issues/{issueId}/attachments
Add attachments to an existing issue in a project
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
object with fields :
Remove attachments delete /api/http/projects/{project}/planning/issues/{issueId}/attachments
Remove attachments from an existing issue in a project
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
identities
: array of string
(Query)
Add issue checklist post /api/http/projects/{project}/planning/issues/{issueId}/checklists/{checklistId}
Add the checklist to an existing issue in a project
Rights, that may be checked: Update issues
, Edit documents
Request arguments
project
: string in one of the formats
(Path)
issueId
: string
(Path)
checklistId
: string
(Path)
Remove issue checklist delete /api/http/projects/{project}/planning/issues/{issueId}/checklists/{checklistId}
Remove the checklist from an existing issue in a project
Rights, that may be checked: Update issues
, Edit documents
Request arguments
project
: string in one of the formats
(Path)
issueId
: string
(Path)
checklistId
: string
(Path)
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
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
object with fields :
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
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
codeReviewIds
: array of ReviewIdentifier
(Query)
post /api/http/projects/{project}/planning/issues/{issueId}/comments/import
Rights, that may be checked: Import issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
object with fields :
Add commit links post /api/http/projects/{project}/planning/issues/{issueId}/commits
Add commit links to an existing issue in a project
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
object with fields :
Remove commit links delete /api/http/projects/{project}/planning/issues/{issueId}/commits
Remove commit links from an existing issue in a project
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
repository
: string
(Query)
commitIds
: array of string
(Query)
Add issue tag post /api/http/projects/{project}/planning/issues/{issueId}/tags/{tagId}
Add an existing tag to an issue in a project
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
tagId
: string
(Path)
Remove issue tag delete /api/http/projects/{project}/planning/issues/{issueId}/tags/{tagId}
Remove an existing tag from an issue in a project
Rights, that may be checked: Update issues
Request arguments
project
: string in one of the formats
(Path)
issueId
: string in one of the formats
(Path)
tagId
: string
(Path)
Create hierarchical tag post /api/http/projects/{project}/planning/tags
Create a new hierarchical tag in a project
Rights, that may be checked: Manage tags
Request arguments
project
: string in one of the formats
(Path)
object with fields :
get /api/http/projects/{project}/planning/tags
Search existing tags in a project
Rights, that may be checked: View project details
Request arguments
project
: string in one of the formats
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of PlanningTag
Create new repository post /api/http/projects/{project}/repositories/{repository}
Request arguments
project
: string in one of the formats
(Path)
repository
: string
(Path)
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
)
Delete repository delete /api/http/projects/{project}/repositories/{repository}
Request arguments
project
: string in one of the formats
(Path)
repository
: string
(Path)
Commit changes to repository post /api/http/projects/{project}/repositories/{repository}/commit
Request arguments
project
: string
(Path)
repository
: string
(Path)
object with fields :
Invoke garbage collection on repository [not available in multi-org mode] post /api/http/projects/{project}/repositories/{repository}/gc
Request arguments
project
: string in one of the formats
(Path)
repository
: string
(Path)
List commits matching query get /api/http/projects/{project}/repositories/{repository}/commits
Request arguments
project
: string in one of the formats
(Path)
repository
: string
(Path)
$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
totalCount
: integer
(format: int32) ( Nullable and Optional , defaults to null
)
data
: array of GitCommitInfo
Get repository git remote url get /api/http/projects/{project}/repositories/{repository}/url
Request arguments
project
: string in one of the formats
(Path)
repository
: string
(Path)
Report external check status post /api/http/projects/{project}/repositories/{repository}/revisions/{revision}/external-checks
Request arguments
project
: string in one of the formats
(Path)
repository
: string
(Path)
revision
: string
(Path)
object with fields :
branch
: string
( Nullable and Optional , defaults to null
)
changes
: array of string
( Nullable and Optional , defaults to null
)
executionStatus
: CommitExecutionStatus
url
: string
externalServiceName
: string
taskName
: string
taskId
: string
timestamp
: integer
(format: int64) ( Nullable and Optional , defaults to null
)
description
: string
( Nullable and Optional , defaults to null
)
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
(Path)
repository
: string
(Path)
revision
: string
(Path)
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
(Path)
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
(Path)
object with fields :
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
(Path)
subjectId
: string
(Path)
object with fields :
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
(Path)
responsibilityId
: string
(Path)
profileId
: string
(Path)
object with fields :
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
(Path)
responsibilityId
: string
(Path)
profileId
: string
(Path)
role
: string
(Query) ( Nullable and Optional , defaults to null
)
Create topic post /api/http/projects/{project}/topics
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Get topic get /api/http/projects/{project}/topics
Request arguments
project
: string in one of the formats
(Path)
Remove topics post /api/http/projects/{project}/topics/remove-topics
Request arguments
project
: string in one of the formats
(Path)
object with fields :
ids
: array of string
Set responsible post /api/http/projects/{project}/topics/set-responsible
Request arguments
project
: string in one of the formats
(Path)
object with fields :
Update topic patch /api/http/projects/{project}/topics/{id}
Request arguments
project
: string in one of the formats
(Path)
id
: string
(Path)
object with fields :
Last modified: 08 September 2022