Projects
post /api/http/projects
Create a new project
Required permissions: Create projects
|
get /api/http/projects
Get/search all projects. Parameters are applied as ' AND ' filters.
Required permissions: View project details
|
get /api/http/projects/collaborator:{profile}
warning
Deprecated since 2023-07-01: Project collaborators are no longer supported. It will be removed in a future version.
Get all projects in which given user is a collaborator
Required permissions: View project details
|
get /api/http/projects/member:{member}
Get all projects for a member
Required permissions: View project details
|
get /api/http/projects/right-code:{rightCode}
Required permissions: View project details
|
get /api/http/projects/right-unique-code:{right}
Required permissions: View project details
|
get /api/http/projects/team:{team}
Get all projects for a team
Required permissions: View project details
|
get /api/http/projects/{project}
Get project by ID or project key
Required permissions: View project details
|
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
|
delete /api/http/projects/{project}
Delete a project
Required permissions: Manage project permission scheme
|
post /api/http/projects/automation/deployment-targets/search
Required permissions: View deployments
|
get /api/http/projects/automation/deployment-targets
Required permissions: View deployments
|
get /api/http/projects/automation/deployment-targets/{fullNumberId}
Required permissions: View deployments
|
get /api/http/projects/automation/deployment-targets/audit-log
Required permissions: View deployments
|
get /api/http/projects/automation/dsl-evaluations/config
|
post /api/http/projects/automation/graph-executions/{id}/stop
Stop execution by ExecutionId
Required permissions: Stop automation jobs
|
get /api/http/projects/automation/graph-executions/{id}
Required permissions: View automation jobs
|
get /api/http/projects/automation/job-executions/current
warning
Deprecated since 2023-08-08: Use projects/automation/graph-executions/{id} instead, and provide the graph execution ID.
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
|
get /api/http/projects/automation/jobs/{jobId}
Required permissions: View automation jobs
|
get /api/http/projects/automation/step-executions/used-parameters/param/{parameterId}
|
get /api/http/projects/automation/step-executions/used-parameters/secret/{secretId}
|
get /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}
|
patch /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}
|
delete /api/http/projects/automation/step-executions/{stepExecId}/parameters/{key}
|
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.
|
patch /api/http/projects/params/{id}
Update an existing project parameter
Required permissions: Modify project parameters
|
delete /api/http/projects/params/{id}
Delete an existing project parameter
Required permissions: Delete project parameters
|
post /api/http/projects/params/default-bundle
Create a new project parameter in the default parameter bundle
Required permissions: Modify project parameters
|
get /api/http/projects/params/default-bundle
List project parameters in a parameter bundle
Required permissions: View project parameters
|
post /api/http/projects/params/in-default-bundle
warning
Deprecated since 2021.05.18: Use the method that accepts a project identifier instead.
Required permissions: Modify project parameters
|
get /api/http/projects/params/in-default-bundle
warning
Deprecated since 2021.05.18: Use the method that accepts a project identifier instead.
List project parameters in a parameter bundle
Required permissions: View project parameters
|
get /api/http/projects/planning/boards/{board}
Get a board by identifier
Required permissions: View boards
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
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
|
get /api/http/projects/planning/boards/sprints/{sprint}/issues
Fetch issues from an existing non-archived sprint
Required permissions: View boards
|
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
|
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
|
get /api/http/projects/planning/boards/{board}/issues
Fetch issues from the board across all its non-archived sprints
Required permissions: View boards
|
post /api/http/projects/private-projects/{project}/request-access
Request access to a project
Required permissions: List restricted projects
|
get /api/http/projects/private-projects
List private projects in the current organization
Required permissions: List restricted projects
, View project details
|
get /api/http/projects/repositories/find
Find repositories by name substring.
Required permissions: Read Git repositories
|
post /api/http/projects/responsibilities
Add a responsibility for a given subject ID
|
patch /api/http/projects/responsibilities/{responsibilityId}
Edit an existing responsibility
|
delete /api/http/projects/responsibilities/{responsibilityId}
Delete an existing responsibility
|
delete /api/http/projects/responsibilities/subjects/{subjectId}
Delete an existing responsibility subject for a given project ID
|
patch /api/http/projects/secrets/{id}
Update an existing project secret
Required permissions: Update project secrets
|
delete /api/http/projects/secrets/{id}
Delete an existing project secret
Required permissions: Delete project secrets
|
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
|
get /api/http/projects/secrets/default-bundle
List project secrets in a parameter bundle
Required permissions: View keys of project secrets
|
post /api/http/projects/secrets/in-default-bundle
warning
Deprecated since 2021.05.18: Use the method that accepts a project identifier instead.
Required permissions: Create project secrets
|
get /api/http/projects/secrets/in-default-bundle
warning
Deprecated since 2021.05.18: Use the method that accepts a project identifier instead.
Required permissions: View keys of project secrets
|
post /api/http/projects/tags/track-access
Track a tag has been accessed
|
get /api/http/projects/tags
List all tags, mapped to the number of projects they are used in
Required permissions: View project details
|
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
|
get /api/http/projects/vault
Get an existing Vault connections for project
Required permissions: View Vault connections
|
patch /api/http/projects/vault/{id}
Update an existing Vault connection
Required permissions: Modify Vault connections
|
delete /api/http/projects/vault/{id}
Delete an existing Vault connection
Required permissions: Delete Vault connections
|
get /api/http/projects/{project}/access/admins
Returns the list of all project administrators
Required permissions: View project details
|
post /api/http/projects/{project}/access/admins/profiles
Add a member as administrator to a project
Required permissions: Manage project permission scheme
|
delete /api/http/projects/{project}/access/admins/profiles/{profile}
Remove a member as administrator from a project
Required permissions: Manage project permission scheme
|
post /api/http/projects/{project}/access/admins/teams
Add a team as administrators to a project
Required permissions: Manage project permission scheme
|
delete /api/http/projects/{project}/access/admins/teams/{teamId}
Remove a team as administrators from a project
Required permissions: Manage project permission scheme
|
get /api/http/projects/{project}/access/collaborators
warning
Deprecated since 2023-07-01: Project collaborators are no longer supported. It will be removed in a future version.
Required permissions: View project details
|
post /api/http/projects/{project}/access/collaborators/profiles
warning
Deprecated since 2023-07-01: Project collaborators are no longer supported. It will be removed in a future version.
Required permissions: Manage project permission scheme
|
get /api/http/projects/{project}/access/collaborators/profiles
warning
Deprecated since 2023-07-01: Project collaborators are no longer supported. It will be removed in a future version.
Required permissions: View project details
|
delete /api/http/projects/{project}/access/collaborators/profiles
warning
Deprecated since 2023-07-01: Project collaborators are no longer supported. It will be removed in a future version.
Required permissions: Manage project permission scheme
|
post /api/http/projects/{project}/access/collaborators/teams
warning
Deprecated since 2023-07-01: Project collaborators are no longer supported. It will be removed in a future version.
Required permissions: Manage project permission scheme
|
get /api/http/projects/{project}/access/collaborators/teams
warning
Deprecated since 2023-07-01: Project collaborators are no longer supported. It will be removed in a future version.
Required permissions: View project details
|
delete /api/http/projects/{project}/access/collaborators/teams
warning
Deprecated since 2023-07-01: Project collaborators are no longer supported. It will be removed in a future version.
Required permissions: Manage project permission scheme
|
get /api/http/projects/{project}/access/member-profiles
Get project members for a given project key
Required permissions: View project details
|
post /api/http/projects/{project}/access/members/profiles
Add a member to a project
Required permissions: Manage project permission scheme
|
delete /api/http/projects/{project}/access/members/profiles/{profile}
Remove a member from a project
Required permissions: Manage project permission scheme
|
delete /api/http/projects/{project}/access/members/teams/{teamId}
Remove a team from a project
Required permissions: Manage project permission scheme
|
get /api/http/projects/{project}/access/viewers
Get organization members who can view a project
Required permissions: View project details
|
post /api/http/projects/{project}/automation/deployment-targets
Required permissions: Modify deployment targets
|
get /api/http/projects/{project}/automation/deployment-targets
warning
Deprecated since 2023-02-28: Use GET projects/automation/deployment-targets`.
Required permissions: View deployments
|
get /api/http/projects/{project}/automation/deployment-targets/favorites
Required permissions: View deployments
|
get /api/http/projects/{project}/automation/deployment-targets/{target}
Required permissions: View deployments
|
patch /api/http/projects/{project}/automation/deployment-targets/{target}
|
delete /api/http/projects/{project}/automation/deployment-targets/{target}
Required permissions: Modify deployment targets
|
post /api/http/projects/{project}/automation/deployments/fail
Required permissions: Modify deployments
|
post /api/http/projects/{project}/automation/deployments/finish
Required permissions: Modify deployments
|
post /api/http/projects/{project}/automation/deployments/schedule
Required permissions: Modify deployments
|
post /api/http/projects/{project}/automation/deployments/start
Required permissions: Modify deployments
|
get /api/http/projects/{project}/automation/deployments
Required permissions: View deployments
|
patch /api/http/projects/{project}/automation/deployments
Required permissions: Modify deployments
|
get /api/http/projects/{project}/automation/deployments/{targetIdentifier}/{deploymentIdentifier}
Required permissions: View deployments
|
delete /api/http/projects/{project}/automation/deployments/{targetIdentifier}/{deploymentIdentifier}
Required permissions: Modify deployments
|
get /api/http/projects/{project}/automation/graph-executions
Search executions. Parameters are applied as ' AND ' filters.
Required permissions: View automation jobs
|
post /api/http/projects/{project}/automation/jobs/{jobId}/start
Start job. Returns ExecutionId, see projects/automation/graph-executions/{id}.
Required permissions: Start automation jobs
|
get /api/http/projects/{project}/automation/jobs
List jobs. Parameters are applied as ' AND ' filters.
Required permissions: View automation jobs
|
post /api/http/projects/{project}/code-reviews/commit-set-review
Required permissions: Create code reviews
|
post /api/http/projects/{project}/code-reviews/merge-requests
Required permissions: Create code reviews
|
get /api/http/projects/{project}/code-reviews
Required permissions: View code reviews
|
get /api/http/projects/{project}/code-reviews/{reviewId}
Required permissions: View code reviews
|
get /api/http/projects/{project}/code-reviews/{reviewId}/details
Required permissions: View code reviews
|
get /api/http/projects/{project}/code-reviews/{reviewId}/files
List files changed in commits under code review
Required permissions: View code reviews
|
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
|
get /api/http/projects/{project}/code-reviews/{reviewId}/suggested-reviewers
Required permissions: View code reviews
|
patch /api/http/projects/{project}/code-reviews/{reviewId}/description
Required permissions: Edit code reviews
|
patch /api/http/projects/{project}/code-reviews/{reviewId}/make-read-only
Required permissions: Edit code reviews
|
patch /api/http/projects/{project}/code-reviews/{reviewId}/state
Required permissions: Edit code reviews
|
patch /api/http/projects/{project}/code-reviews/{reviewId}/title
Required permissions: Edit code reviews
|
put /api/http/projects/{project}/code-reviews/{reviewId}/merge
Required permissions: View code reviews
, Write Git repositories
|
put /api/http/projects/{project}/code-reviews/{reviewId}/rebase
Required permissions: View code reviews
, Write Git repositories
|
post /api/http/projects/{project}/code-reviews/code-discussions
Required permissions: View code reviews
, Create suggested edit
|
post /api/http/projects/{project}/code-reviews/code-discussions/{discussionId}/accept-suggested-edit
Required permissions: Moderate suggestions
|
post /api/http/projects/{project}/code-reviews/code-discussions/{discussionId}/reject-suggested-edit
Required permissions: Moderate suggestions
|
post /api/http/projects/{project}/code-reviews/code-discussions/{discussionId}/reopen-suggested-edit
Required permissions: Moderate suggestions
|
patch /api/http/projects/{project}/code-reviews/code-discussions/{discussionId}/suggested-edit
|
post /api/http/projects/{project}/code-reviews/safe-merge
Required permissions: View code reviews
, Write Git repositories
|
get /api/http/projects/{project}/code-reviews/safe-merge
Required permissions: View code reviews
|
delete /api/http/projects/{project}/code-reviews/safe-merge
Required permissions: View code reviews
, Write Git repositories
|
post /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}
Required permissions: Edit code reviews
|
delete /api/http/projects/{project}/code-reviews/{reviewId}/participants/{user}
Required permissions: Edit code reviews
|
post /api/http/projects/{project}/code-reviews/{reviewId}/revisions
Required permissions: Edit code reviews
|
delete /api/http/projects/{project}/code-reviews/{reviewId}/revisions
Required permissions: Edit code reviews
|
post /api/http/projects/{project}/code-reviews/{reviewId}/unbound-discussions
|
get /api/http/projects/{project}/code-reviews/{reviewId}/unbound-discussions
|
patch /api/http/projects/{project}/code-reviews/{reviewId}/unbound-discussions/{discussionId}/toggle
|
post /api/http/projects/{project}/documents
|
get /api/http/projects/{project}/documents/{documentId}
|
patch /api/http/projects/{project}/documents/{documentId}
|
delete /api/http/projects/{project}/documents/{documentId}
|
post /api/http/projects/{project}/documents/folders
|
get /api/http/projects/{project}/documents/folders/{folder}
|
patch /api/http/projects/{project}/documents/folders/{folder}
|
delete /api/http/projects/{project}/documents/folders/{folder}
|
get /api/http/projects/{project}/documents/folders/{folder}/access
|
patch /api/http/projects/{project}/documents/folders/{folder}/access
|
get /api/http/projects/{project}/documents/folders/{folder}/documents
|
patch /api/http/projects/{project}/documents/folders/{folder}/introduction/{documentId}
|
delete /api/http/projects/{project}/documents/folders/{folder}/introduction
|
patch /api/http/projects/{project}/documents/folders/{folder}/move
|
get /api/http/projects/{project}/documents/folders/{folder}/search
Executes search for project documents and folders in specified folder
|
get /api/http/projects/{project}/documents/folders/{folder}/subfolders
|
get /api/http/projects/{project}/documents/{documentId}/access
|
patch /api/http/projects/{project}/documents/{documentId}/access
|
post /api/http/projects/{project}/documents/{documentId}/copy
|
patch /api/http/projects/{project}/documents/{documentId}/move
|
patch /api/http/projects/{project}/documents/{documentId}/unarchive
|
patch /api/http/projects/{project}/feature-pins
Update list of project items pinned for the project by default
Required permissions: Manage project sidebar pins
|
post /api/http/projects/{project}/packages/repositories
Creates a new package repository for a given project ID
Required permissions: Create package repositories
|
get /api/http/projects/{project}/packages/repositories
Gets a list of package repositories for a given project ID
Required permissions: Read package repositories
|
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
|
patch /api/http/projects/{project}/packages/repositories/{repository}
Updates package repository settings for a given project ID
Required permissions: Admin package repositories
|
delete /api/http/projects/{project}/packages/repositories/{repository}
Removes package repository for a given project ID
Required permissions: Admin package repositories
|
get /api/http/projects/{project}/packages/repositories/{repository}/access
Updates package repository settings for a given project ID
Required permissions: Admin package repositories
|
patch /api/http/projects/{project}/packages/repositories/{repository}/access
Updates package repository settings for a given project ID
Required permissions: Admin package repositories
|
post /api/http/projects/{project}/packages/repositories/{repository}/cleanup
Cleanup specified package repository
Required permissions: Admin package repositories
|
post /api/http/projects/{project}/packages/repositories/{repository}/cleanup/dry
Dry run of cleanup for specified package repository
Required permissions: Admin package 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
|
post /api/http/projects/{project}/packages/repositories/{repository}/connections/{connectionId}/publish
Publishes packages to remote repository
Required permissions: Write package repositories
|
get /api/http/projects/{project}/packages/repositories/{repository}/connections/{connectionId}/publish
Get list of publishing to remote repository
Required permissions: Read package repositories
|
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
|
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
|
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
|
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
|
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
|
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
|
get /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/metadata
Get package metadata in repository for a given project ID
|
put /api/http/projects/{project}/packages/repositories/{repository}/packages/name:{packageName}/metadata
Update a package metadata in repository for a given project ID
|
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
|
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
|
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
|
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
|
get /api/http/projects/{project}/packages/repositories/{repository}/url
Gets a package repository URL for a given project ID
Required permissions: Read package repositories
|
get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages
warning
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
Required permissions: Read package repositories
|
get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions
warning
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
Required permissions: Read package repositories
|
get /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions/version:{packageVersion}
warning
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
Required permissions: Read package repositories
|
delete /api/http/projects/{project}/packages/repositories/type:{type}/repository:{repositoryName}/packages/name:{packageName}/versions/version:{packageVersion}
warning
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
Required permissions: Delete package repositories content
|
get /api/http/projects/{project}/packages/search
Executes a package search for a given project ID
Required permissions: Read package repositories
|
get /api/http/projects/{project}/packages/types
Returns a list of available repository types.
|
post /api/http/projects/{project}/people/members/update
Adds or removes project participant roles
Required permissions: Manage project permission scheme
|
get /api/http/projects/{project}/people/members
Returns all project participants
Required permissions: View project details
|
get /api/http/projects/{project}/people/members/by-ids
Returns project participants by provided profiles
Required permissions: View project details
|
delete /api/http/projects/{project}/people/members/{profile}
Removes participant
Required permissions: Manage project permission scheme
|
post /api/http/projects/{project}/people/teams/update
Adds or removes project team participant roles
Required permissions: Manage project permission scheme
|
get /api/http/projects/{project}/people/teams
Returns all project participant teams
Required permissions: View project details
|
get /api/http/projects/{project}/people/teams/by-ids
Returns project participant teams by provided teams
Required permissions: View project details
|
delete /api/http/projects/{project}/people/teams/{team}
Removes participant
Required permissions: Manage project permission scheme
|
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
|
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
|
get /api/http/projects/{project}/planning/boards
Search existing boards in a project
Required permissions: View boards
|
get /api/http/projects/{project}/planning/boards/sprints
Search existing sprints in a project
Required permissions: View boards
|
get /api/http/projects/{project}/planning/boards/starred
Get all starred boards in a project
Required permissions: View boards
|
delete /api/http/projects/{project}/planning/boards/{board}/archive
warning
Deprecated since 2021-12-22: Use DELETE /projects/planning/boards/{board} instead.
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
|
post /api/http/projects/{project}/planning/checklists
warning
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
|
get /api/http/projects/{project}/planning/checklists
warning
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
|
post /api/http/projects/{project}/planning/checklists/import
warning
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.
|
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.
|
patch /api/http/projects/{project}/planning/checklists/{checklistId}
warning
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
|
delete /api/http/projects/{project}/planning/checklists/{checklistId}
warning
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
|
get /api/http/projects/{project}/planning/checklists/starred
warning
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
|
get /api/http/projects/{project}/planning/checklists/{checklistId}/full-checklist-tree
Get the content of a checklist in a project
|
post /api/http/projects/{project}/planning/issues
Create a new issue in a project
Required permissions: Create issues
|
get /api/http/projects/{project}/planning/issues
Search existing issues in a project. Parameters are applied as ' AND ' filters.
Required permissions: View issues
|
post /api/http/projects/{project}/planning/issues/import
Import issues in a project
Required permissions: Import issues
|
post /api/http/projects/{project}/planning/issues/{issueId}/restore
Restore an issue in a project
Required permissions: Restore issues
|
post /api/http/projects/{project}/planning/issues/{issueId}/toggle-resolved
Toggle status of an existing issue between resolved and unresolved
Required permissions: Update issues
|
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
|
get /api/http/projects/{project}/planning/issues/number:{number}
Find an existing issue by a given number in a project
Required permissions: View issues
|
get /api/http/projects/{project}/planning/issues/{issueId}
Required permissions: View issues
|
patch /api/http/projects/{project}/planning/issues/{issueId}
Update an existing issue in a project
Required permissions: Update issues
|
delete /api/http/projects/{project}/planning/issues/{issueId}
Delete an issue from a project
Required permissions: Update issues
|
get /api/http/projects/{project}/planning/issues/fields/order
Query order for built-in issue fields
Required permissions: View issues
|
patch /api/http/projects/{project}/planning/issues/fields/order
Query order for built-in issue fields
Required permissions: Manage issue settings
|
get /api/http/projects/{project}/planning/issues/fields/visibility
Query visibility for built-in issue fields
Required permissions: View issues
|
patch /api/http/projects/{project}/planning/issues/fields/visibility
Set visibility for a built-in issue field
Required permissions: Manage issue settings
|
get /api/http/projects/{project}/planning/issues/statuses
Get all existing issue statuses in a project
Required permissions: View issues
|
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
|
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
|
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
|
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
|
post /api/http/projects/{project}/planning/issues/{issueId}/attachment
Add attachment to an existing issue in a project
Required permissions: Update issues
|
delete /api/http/projects/{project}/planning/issues/{issueId}/attachment/{attachmentId}
Remove attachment from an existing issue in a project
Required permissions: Update issues
|
post /api/http/projects/{project}/planning/issues/{issueId}/attachments
Add attachments to an existing issue in a project
Required permissions: Update issues
|
delete /api/http/projects/{project}/planning/issues/{issueId}/attachments
Remove attachments from an existing issue in a project
Required permissions: Update issues
|
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
|
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
|
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
|
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
|
post /api/http/projects/{project}/planning/issues/{issueId}/comments/import
warning
Deprecated since 2022-10-12: Use Chats / Messages / Import messages. It will be removed in a future version.
Required permissions: Import issues
|
post /api/http/projects/{project}/planning/issues/{issueId}/commits
Add commit links to an existing issue in a project
Required permissions: Update issues
|
delete /api/http/projects/{project}/planning/issues/{issueId}/commits
Remove commit links from an existing issue in a project
Required permissions: Update issues
|
post /api/http/projects/{project}/planning/issues/{issueId}/tags/{tagId}
Add an existing tag to an issue in a project
Required permissions: Update issues
|
delete /api/http/projects/{project}/planning/issues/{issueId}/tags/{tagId}
Remove an existing tag from an issue in a project
Required permissions: Update issues
|
post /api/http/projects/{project}/planning/tags
Create a new hierarchical tag in a project
Required permissions: Manage tags
|
get /api/http/projects/{project}/planning/tags
Search existing tags in a project
Required permissions: View project details
|
post /api/http/projects/{project}/repositories/test-connection
|
post /api/http/projects/{project}/repositories/{repository}
|
get /api/http/projects/{project}/repositories/{repository}
|
delete /api/http/projects/{project}/repositories/{repository}
|
post /api/http/projects/{project}/repositories/{repository}/cherry-pick-commit
|
post /api/http/projects/{project}/repositories/{repository}/commit
|
post /api/http/projects/{project}/repositories/{repository}/delete-branch
|
post /api/http/projects/{project}/repositories/{repository}/description
|
post /api/http/projects/{project}/repositories/{repository}/gc
|
post /api/http/projects/{project}/repositories/{repository}/head
|
post /api/http/projects/{project}/repositories/{repository}/merge-branch
|
post /api/http/projects/{project}/repositories/{repository}/migrate
|
post /api/http/projects/{project}/repositories/{repository}/rebase-branch
|
get /api/http/projects/{project}/repositories/{repository}/changes
|
get /api/http/projects/{project}/repositories/{repository}/commit-branches
|
get /api/http/projects/{project}/repositories/{repository}/commits
|
get /api/http/projects/{project}/repositories/{repository}/files
|
get /api/http/projects/{project}/repositories/{repository}/heads
|
get /api/http/projects/{project}/repositories/{repository}/inline-merge-diff
warning
Experimental . This API is experimental
|
get /api/http/projects/{project}/repositories/{repository}/merge-preview
|
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.
|
get /api/http/projects/{project}/repositories/{repository}/url
|
post /api/http/projects/{project}/repositories/{repository}/default-branch
|
get /api/http/projects/{project}/repositories/{repository}/default-branch
|
post /api/http/projects/{project}/repositories/{repository}/readonly
|
get /api/http/projects/{project}/repositories/{repository}/readonly
|
post /api/http/projects/{project}/repositories/{repository}/revisions/{revision}/external-checks
|
get /api/http/projects/{project}/repositories/{repository}/revisions/{revision}/external-checks
|
post /api/http/projects/{project}/repositories/{repository}/settings
|
get /api/http/projects/{project}/repositories/{repository}/settings
|
get /api/http/projects/{project}/responsibilities/scheme
Get the responsibilities schema for a given project ID
|
post /api/http/projects/{project}/responsibilities/subjects
Add a responsibility subject for a given project ID
|
patch /api/http/projects/{project}/responsibilities/subjects/{subjectId}
Update an existing responsibility subject for a given project ID
|
post /api/http/projects/{project}/responsibilities/{responsibilityId}/assignees/{profileId}
Assign a responsible person for a given project ID and responsibility ID
|
delete /api/http/projects/{project}/responsibilities/{responsibilityId}/assignees/{profileId}
Remove a responsible person for a given project ID and responsibility ID
|
post /api/http/projects/{project}/topics
|
get /api/http/projects/{project}/topics
|
post /api/http/projects/{project}/topics/remove-topics
|
post /api/http/projects/{project}/topics/set-responsible
|
patch /api/http/projects/{project}/topics/{id}
|
Thanks for your feedback!