bamboo.variable.myVariable=valueForMyVariable.\nWhen global or plan variables would be passed to this method, will override default values for variables.","operationId":"startBuild_1","parameters":[{"description":"enforce executing all stages in a plan, even if defined as manual stages. Execution will follow and include latest stage, unless some stage will fail.","in":"query","name":"executeAllStages","schema":{"type":"boolean"}},{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"execute this plan for a custom revision instead of the latest one","in":"query","name":"customRevision","schema":{"type":"string"}},{"description":"name of the stage that should be executed even if defined as manual stage. Execution will follow to the next manual stage after this or end of plan if no subsequent manual stage","in":"query","name":"stage","schema":{"type":"string"}},{"description":"plan key (only top level plan key, can not be job key)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestQueuedBuild"}}},"description":"Information for queued build, including build number, changes and reason of build"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"When build was not added to the queue because of Bamboo limitation, e.g too many concurrent builds running for requested plan already or validation exception"},"403":{"content":{"application/json":{}},"description":"When user does not have sufficient rights to view or execute build for specified plan"},"404":{"content":{"application/json":{}},"description":"When specified plan does not exist or plan is not a top level plan"},"415":{"content":{"application/json":{}},"description":"When method payload is not form encoded"}}}},"/api/latest/queue/{projectKey}-{buildKey}-{buildNumber}":{"delete":{"description":"Stop build execution.","operationId":"stopBuild","parameters":[{"description":"Project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"Plan key - IMPORTANT: as build queue contains only jobs not top level plans, plan key here MUST be a job key as opposite to other methods in this resource.","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Build number","in":"path","name":"buildNumber","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"204":{"description":"On success (success is also when build was already completed - so nothing to stop)"},"403":{"content":{"application/json":{}},"description":"When user does not have sufficient rights to view or execute build for specified plan"},"404":{"content":{"application/json":{}},"description":"When specified job does not exist"}}},"put":{"description":"Continue partially done build.\n\nEffectively, this method adds build to the build queue, so is not guarantied that build would be executed immediately.\nDepending on currently executed builds and length of build queue, build may be executed when queue would be drained.\nAdditional variables could be passed to this method only query parameters (variableName=variableValue).\nVariables defined in Bamboo as global variables or plan variables MUST be prefixed with bamboo.variable ie. bamboo.variable.myVariable=valueForMyVariable.\nWhen global or plan variables would be passed to this method, will override values valid for previous build execution (override).","operationId":"continueBuild","parameters":[{"description":"enforce executing all stages in a plan, even if defined as manual stages. Execution will follow and include latest stage, unless some stage will fail.","in":"query","name":"executeAllStages","schema":{"type":"boolean"}},{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"name of the stage that should be executed even if manual stage. Execution will follow to the next manual stage after this or end of plan if no subsequent manual stage","in":"query","name":"stage","schema":{"type":"string"}},{"description":"plan key (only top level plan key, can not be job key)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"build number to resume/rerun","in":"path","name":"buildNumber","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestQueuedBuild"}}},"description":"Information for queued build, including build number, changes and reason of build"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"When build is currently executing or is in state not allowing execution"},"403":{"content":{"application/json":{}},"description":"When user does not have sufficient rights to view or execute build for specified plan"},"404":{"content":{"application/json":{}},"description":"When specified plan does not exist, result for provided build number does not exist or is not top level plan result"}}}},"/api/latest/quickFilter":{"get":{"description":"Obtain a list of quick filters defined for this Bamboo instance.","operationId":"getQuickFilters","parameters":[{"description":"When set, the list will only contain filters which have or have not been properly configured. Quick filters are considered configured when they have rules set up","in":"query","name":"configured","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestQuickFilter"}}}},"description":"List of quick filters. Each entity will contain only basic configuration, excluding e.g. quick filter's rules"}}},"post":{"description":"Create a new quick filter with basic configuration, e.g. name or position on list. This method does not allow to configure quick filter's rules.","operationId":"createQuickFilter","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestQuickFilter"}}},"description":"Quick filter","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestQuickFilter"}}},"description":"Returned when quick filter was created successfully. Response will contain Quick Filter definition with assigned id"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"When any validation errors occur. Response will contain all error messages"},"403":{"content":{"application/json":{}},"description":"User don't have restricted or system administrator permissions"}}}},"/api/latest/quickFilter/active":{"get":{"description":"Return active quick filters for currently logged in user.","operationId":"getActiveFilters","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestQuickFilter"}}}},"description":"List of active quick filters for logged in user. Each entity will contain only basic configuration, excluding e.g. quick filter's rules"}}}},"/api/latest/quickFilter/deactivate":{"put":{"description":"Deactivates all quick filter for currently logged in user.","operationId":"deactivateAllFilters","responses":{"200":{"content":{"application/json":{}},"description":"When all filters were successfully deactivated for current user"}}}},"/api/latest/quickFilter/visible":{"get":{"description":"Return visible quick filters for currently logged in user.","operationId":"getVisibleFilters","responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestQuickFilter"}}}},"description":"List of visible quick filters for logged in user. Each entity will contain only basic configuration, excluding e.g. quick filter's rules"}}},"put":{"description":"Saves the list of visible quick filters for currently logged in user.","operationId":"setVisibleFilters","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer","format":"int64"}}}},"description":"Quick filter ids","required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Returned without any content when the visible filters were successfully saved for current user"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"Sent whenever any quick filter was not found with the given id"}}}},"/api/latest/quickFilter/{id}":{"delete":{"description":"Delete a quick filter.","operationId":"deleteQuickFilter","parameters":[{"description":"Quick filter id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"Returned when quick filter was deleted successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"Sent when quick filter was not found with the given id"},"403":{"content":{"application/json":{}},"description":"User don't have restricted or system administrator permissions"}}},"get":{"description":"Get a single quick filter by id.","operationId":"getQuickFilter","parameters":[{"description":"Quick filter id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestQuickFilter"}}},"description":"Single quick filter data. Will contain only basic configuration, excluding e.g. quick filter's rules"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"Quick filter not found"}}},"put":{"description":"Update quick filter's basic configuration, e.g. name or position on list. This method does not allow to configure quick filter's rules.","operationId":"updateQuickFilter","parameters":[{"description":"Quick filter id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestQuickFilter"}}},"description":"Quick filter","required":true},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestQuickFilter"}}},"description":"Returned when quick filter was updated successfully. Response will contain Quick Filter definition with data after update"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"When any validation errors occur or no quick filter was found with given id. Response will contain all error messages"},"403":{"content":{"application/json":{}},"description":"User don't have restricted or system administrator permissions"}}}},"/api/latest/quickFilter/{id}/activate":{"put":{"description":"Activates a quick filter for currently logged in user.","operationId":"activateFilter","parameters":[{"description":"Quick filter id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{}},"description":"When filter with given id was successfully activated for current user"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"Sent when quick filter was not found with the given id"}}}},"/api/latest/quickFilter/{id}/deactivate":{"put":{"description":"Deactivates a quick filter for currently logged in user.","operationId":"deactivateFilter","parameters":[{"description":"Quick filter id","in":"path","name":"id","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{}},"description":"When filter with given id was successfully deactivated for current user"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"Sent when quick filter was not found with the given id"}}}},"/api/latest/quicksearch":{"get":{"description":"Performs a starts with search against projects, plans, plan branches, deployment projects","operationId":"search","parameters":[{"description":"to search for","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"entity to search for","in":"query","name":"searchEntity","schema":{"type":"string","enum":["PROJECT","PLAN","DEPLOYMENT","PLAN_BRANCH"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/JsonSearchResultsList"}}},"description":"Search results"}}}},"/api/latest/reindex":{"get":{"description":"Kicks off a reindex. Requires system admin permissions to perform this reindex.","operationId":"getReindexInfo","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReindexBean"}}},"description":"Reindex is finished"},"303":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReindexBean"}}},"description":"Reindex is currently performed in background or pending"}}},"post":{"description":"Kicks off a reindex. Requires system admin permissions to perform this operation.","operationId":"reindex","responses":{"202":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReindexBean"}}},"description":"Response that provides a redirect to the GET"},"403":{"content":{"application/json":{}},"description":"User doesn't have system admin permission"},"500":{"content":{"application/json":{}},"description":"Exception"}}}},"/api/latest/repository":{"get":{"description":"Search for existing linked repositories by name.","operationId":"findRepository","parameters":[{"description":"Target repository id","in":"query","name":"searchTerm","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRepositoryList"}}},"description":"The page object with repositories"}}}},"/api/latest/repository/scan":{"post":{"description":"Webhook resource for triggering Repository-stored Bamboo Specs. Either repository ID or name must be provided via query parameters to identify the linked repository in which Bamboo Specs are defined.\n\nAmbiguous requests, which reference more than one repository via the query params, will result in one parameter taking precedence over the others. There's no guarantee which one.\n\nThis resource does not require authorisation. It will always return HTTP 204 response on every valid request, even if the targeted repository doesn't exist or does not contain Bamboo Specs.","operationId":"triggerSpecsScanning_1","parameters":[{"description":"Unique name of the linked repository which stores Bamboo Specs","in":"query","name":"name","schema":{"type":"string"}},{"description":"alternative name of the query parameter to provide repository ID","in":"query","name":"repositoryId","schema":{"type":"integer","format":"int64"}},{"description":"ID of the linked repository which stores Bamboo Specs","in":"query","name":"id","schema":{"type":"integer","format":"int64"}},{"description":"Alternative name of the query parameter to provide repository name","in":"query","name":"repositoryName","schema":{"type":"string"}}],"responses":{"204":{"description":"On any valid request"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"When neither repository ID nor repository name were provided"},"404":{"content":{"application/json":{}},"description":"When Bamboo Specs feature is disabled in Bamboo"}}}},"/api/latest/repository/testConnection":{"put":{"description":"Tests connection to a repository if the repository type supports connection testing. Request payload should contain repository configuration.","operationId":"testConnection_1","requestBody":{"content":{"application/json":{"schema":{"type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRepositoryConnectionResult"}}},"description":"Successful call (without validation errors) will result in HTTP 200. The response will contain potential connection errors. If the connection to repository was successful, the error list will be empty"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"Validation errors before attempting to connect to repository. The response will contain error messages and field errors. This response will also be sent if the repository type doesn't support connection testing"},"403":{"content":{"application/json":{}},"description":"The calling user had insufficient permissions, e.g. for a plan or a repository"}}}},"/api/latest/repository/{repositoryId}/enableAllProjectsAccess":{"put":{"description":"Enables access (i.e. allowing modifications) for all Bamboo projects by the Bamboo Specs code stored in this repository. Changes in Bamboo Specs detected will trigger execution of Specs and thus an update of corresponding entities (such as build plans or deployments).","operationId":"enableAllProjectsAccess","parameters":[{"description":"Repository id","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestEnableContainer"}}},"description":"Enable request","required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Successfully enabled/disabled access of Bamboo Specs stored in the repository to all projects"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"This repository does not handle 'enableAllProjectsAccess' feature or input data is incorrect"},"403":{"content":{"application/json":{}},"description":"The calling user has insufficient permissions to change this setting"}}}},"/api/latest/repository/{repositoryId}/enableAllRepositoriesAccess":{"put":{"description":"Enables access (i.e. allowing usage in plans or deployment projects) for all Bamboo linked repositories by the Bamboo Specs code stored in this repository.","operationId":"enableAllRepositoriesAccess_1","parameters":[{"description":"Repository id","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestEnableContainer"}}},"description":"Enable request","required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Successfully enabled/disabled access of Bamboo Specs stored in the repository to all linked repositories"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"This repository does not handle 'enableAllRepositoriesAccess' feature or input data is incorrect"},"403":{"content":{"application/json":{}},"description":"The calling user has insufficient permissions to change this setting"}}}},"/api/latest/repository/{repositoryId}/enableCi":{"put":{"description":"Enables or disables detection of Bamboo Specs stored in the repository. If enabled, code changes detected in Bamboo Specs in new commits will trigger execution of Bamboo Specs and thus an update of corresponding entities (such as build plans, deployments or permissions).","operationId":"enableCi","parameters":[{"description":"Repository id","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestEnableContainer"}}},"description":"Enable request","required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Successfully enabled/disabled detection of Bamboo Specs stored in the repository"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"This repository does not support this feature or input data is incorrect"},"403":{"content":{"application/json":{}},"description":"The calling user has insufficient permissions to change this setting"}}}},"/api/latest/repository/{repositoryId}/enableProjectCreation":{"put":{"description":"Enables build and deployment project creation by the Bamboo Specs code stored in this repository.","operationId":"enableProjectCreation","parameters":[{"description":"Repository id","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestEnableContainer"}}},"description":"Enable request","required":true},"responses":{"200":{"content":{"application/json":{}},"description":"Successfully enabled/disabled ability of Bamboo Specs stored in the repository to create projects and deployment projects"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"This repository does not handle 'enableProjectCreation' feature or input data is incorrect"},"403":{"content":{"application/json":{}},"description":"The calling user has insufficient permissions to change this setting"}}}},"/api/latest/repository/{repositoryId}/rssBranches":{"get":{"description":"Search for divergent branches names (i.e. vcs branches that have RSS execution results).","operationId":"searchSpecsBranches","parameters":[{"description":"Part of branch name. Used to filter output","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"id of the linked repository which stores Bamboo Specs","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestBranchList"}}},"description":"The page object with branches"},"403":{"content":{"application/json":{}},"description":"When user has insufficient permissions to repository"},"404":{"content":{"application/json":{}},"description":"When Bamboo Specs feature is disabled in Bamboo, or when a repository with given ID could not be found"}}}},"/api/latest/repository/{repositoryId}/rssrepository":{"get":{"description":"Fetch list of RSS repositories which can use given repository by RSS code.","operationId":"getRssRepositoriesAllowedToAccessRepository","parameters":[{"description":"Target repository id","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/RestRepository"}}}},"description":"array of repositories granted to use given repository by Repository stored Bamboo Specs."},"403":{"content":{"application/json":{}},"description":"When user has insufficient permissions to target repository"},"404":{"content":{"application/json":{}},"description":"When specified repository not found or repository stored Bamboo specs feature is disabled"}}},"post":{"description":"Grant repository with RSS code to use target repository in build plans and deployments. If permission is not granted RSS import will fail when code tries to use target repository.","operationId":"grantRssRepositoryAccess","parameters":[{"description":"Repository id","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestIdContainer"}}},"description":"Id container","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRepositoryMinimal"}}},"description":"Repository which was granted permission to"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"When repository id is empty or null"},"403":{"content":{"application/json":{}},"description":"When user has insufficient permissions to target repository"},"404":{"content":{"application/json":{}},"description":"When specified repository not found by id or repository stored Bamboo specs feature is disabled"}}}},"/api/latest/repository/{repositoryId}/rssrepository/search":{"get":{"description":"Search for existing linked repositories which can be granted to use given repository by RSS.","operationId":"searchAvailableRepositories_2","parameters":[{"description":"Part of repository name. Used to filter output","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"Target repository id","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRepositoryList"}}},"description":"Page container with linked repositories which are RSS compatible"},"403":{"content":{"application/json":{}},"description":"When user has insufficient permissions to target repository"},"404":{"content":{"application/json":{}},"description":"When specified repository not found or repository stored Bamboo specs feature is disabled"}}}},"/api/latest/repository/{repositoryId}/scan/status":{"get":{"description":"Resource providing status of RSS processing for a given repository and optional branch.","operationId":"getSpecsDetectionStatus","parameters":[{"description":"Maximum number of spec status entries returned in the response","in":"query","name":"max-result","schema":{"type":"integer","format":"int32","default":20}},{"description":"id of the linked repository which stores Bamboo Specs","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Optional branch of the repository. Works only if repository supports divergent branches","in":"query","name":"branch","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestVcsLocationSpecsStatus"}}},"description":"The object representing RSS status"},"403":{"content":{"application/json":{}},"description":"When user has insufficient permissions to repository"},"404":{"content":{"application/json":{}},"description":"When Bamboo Specs feature is disabled in Bamboo, or when a repository with given ID could not be found"}}}},"/api/latest/repository/{repositoryId}/scanNow":{"post":{"description":"Resource for triggering Repository-stored Bamboo Specs in a 'forced' way. Successful requests to this resource will trigger Bamboo Specs execution even if standard processing would have been skipped (e.g. no new commits to process).","operationId":"triggerSpecsScanning","parameters":[{"description":"id of the repository to trigger","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Optional branch of the repository. Works only if repository supports divergent branches","in":"query","name":"branch","schema":{"type":"string"}}],"responses":{"204":{"description":"On a valid request, when Specs scanning has been successfully enqueued"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"Whenever Specs scanning could not be enqueued, e.g. when the Repository Stored Specs processing has not been enabled for the given repository"},"404":{"content":{"application/json":{}},"description":"When Bamboo Specs feature is disabled in Bamboo, or when the repository can't be found"}}}},"/api/latest/repository/{repositoryId}/usage":{"get":{"description":"Search for usages of given repository.","operationId":"findUsage","parameters":[{"description":"Maximum count of detailed plans at response","in":"query","name":"max-plans","schema":{"type":"integer","format":"int32","default":20}},{"description":"Repository id","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Maximum count of detailed environments at response","in":"query","name":"max-environments","schema":{"type":"integer","format":"int32","default":20}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestRepositoryUsageModel"}}},"description":"Plans and environments which use this repository"},"403":{"content":{"application/json":{}},"description":"User has no permissions to view repository or project"},"404":{"content":{"application/json":{}},"description":"Repository or project not found"}}}},"/api/latest/repository/{targetRepositoryId}/rssrepository/{repositoryId}":{"delete":{"description":"Revoke access of RSS code stored in repository defined by repositoryId from repository defined by targetRepositoryId. Use this method when need to prevent usage of target repository by RSS code stored in repository referenced by repositoryId.","operationId":"revokePermissionToUseRepositoryByRssRepo","parameters":[{"description":"Linked repository root id","in":"path","name":"repositoryId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Target repository id","in":"path","name":"targetRepositoryId","required":true,"schema":{"type":"integer","format":"int64"}}],"responses":{"204":{"description":"When successfully removed link between target repository and repository"},"403":{"content":{"application/json":{}},"description":"When user has insufficient permissions to repository"},"404":{"content":{"application/json":{}},"description":"When specified repository does not exist or repository stored Bamboo specs feature is disabled"}}}},"/api/latest/result":{"get":{"description":"Provide list of the latest build results for top level plans visible for users.","operationId":"getLatestBuildResults","parameters":[{"description":"return build results in all lifecycle states, including unknown and active states","in":"query","name":"includeAllStates","schema":{"type":"boolean"}},{"description":"filter only results that may be continued (stopped on Manual Stage)","in":"query","name":"continuable","schema":{"type":"boolean"}},{"description":"expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix","in":"query","name":"expand","schema":{"type":"string"}},{"description":"Filter by comma separated list of Jira issue key related to result","in":"query","name":"issueKey","schema":{"type":"string"}},{"description":"maximum size for returned list","in":"query","name":"max-results","schema":{"type":"integer","format":"int32"}},{"description":"start index for results list (zero based)","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"Filter by comma separated list of labels","in":"query","name":"label","schema":{"type":"string"}},{"description":"filter results by state, valid values are Unknown, Successful, Failed","in":"query","name":"buildstate","schema":{"type":"string"}},{"description":"Filters build results list to show only results for favourite plans. Works only for authenticated user","in":"query","name":"favourite","schema":{"type":"string"}},{"description":"return build results in given lifecycle state, valid values are Pending, Queued, InProgress, Finished, NotBuilt (multiple values can be separated by a comma)","in":"query","name":"lifeCycleState","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestResults"}}},"description":"Latest build results for all plans"}}}},"/api/latest/result/byChangeset/{csid}":{"get":{"description":"Provide list of build results related to changeset id passed as parameter. List of results contains results from all plans related to this changeset.","operationId":"getBuildResultsForChangeset","parameters":[{"description":"changeset id related to build result","in":"path","name":"csid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestResults"}}},"description":"Build results for specified changeset"}}}},"/api/latest/result/byCheckoutChangeset/{csid}":{"get":{"description":"Provide list of build results related to changeset id passed as parameter. List of results contains results from all plans which have repositories checked out with this changeset.","operationId":"getBuildResultsForCheckoutChangeset","parameters":[{"description":"checkout changeset id related to build result","in":"path","name":"csid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestResults"}}},"description":"Build results for specified changeset"}}}},"/api/latest/result/status/{projectKey}-{buildKey}-{buildNumber}":{"get":{"description":"Provide runtime information for currently executing build result. The key difference to other methods is that method is optimized to provide information available in memory only, so no database calls are made. The information provided is not as wide as for finished results, but the call is optimized for speed.","operationId":"getResultStatus","parameters":[{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"plan key (must be a plan key, not a job key)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Build number (numeric value only, 'latest' keyword is not supported for this method)","in":"path","name":"buildNumber","required":true,"schema":{"type":"string","pattern":"([0-9]+)"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestResultStatus"}}},"description":"Currently executing build status"},"403":{"content":{"application/json":{}},"description":"When user has no permission to view specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project, plan or build result does not exists. Also when build result is not currently executed ie. build has been completed already"}}}},"/api/latest/result/{projectKey}":{"get":{"description":"Provide list of latest build results for top level plans for specified project. List of results is limited to plans visible for user.","operationId":"getLatestBuildResultsForProject","parameters":[{"description":"return build results in all lifecycle states, including unknown and active states","in":"query","name":"includeAllStates","schema":{"type":"boolean"}},{"description":"filter only results that may be continued (stopped on Manual Stage)","in":"query","name":"continuable","schema":{"type":"boolean"}},{"description":"expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix","in":"query","name":"expand","schema":{"type":"string"}},{"description":"project key to filter plan result list","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"Filter by comma separated list of Jira issue key related to result","in":"query","name":"issueKey","schema":{"type":"string"}},{"description":"Maximum size for returned list","in":"query","name":"max-results","schema":{"type":"integer","format":"int32"}},{"description":"Start index for results list (zero based)","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"Filter by comma separated list of labels","in":"query","name":"label","schema":{"type":"string"}},{"description":"filter results by state, valid values are Unknown, Successful, Failed","in":"query","name":"buildstate","schema":{"type":"string"}},{"description":"Filters build results list to show only results for favourite plans. Works only for authenticated user","in":"query","name":"favourite","schema":{"type":"string"}},{"description":"return build results in given lifecycle state, valid values are Pending, Queued, InProgress, Finished, NotBuilt (multiple values can be separated by a comma)","in":"query","name":"lifeCycleState","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestResults"}}},"description":"Latest build results for plans for specified project"},"404":{"content":{"application/json":{}},"description":"When specified project does not exists or user does not have permission to see plans for specified project"}}}},"/api/latest/result/{projectKey}-{buildKey}":{"get":{"description":"Provide list of build results for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).","operationId":"getBuildHistory","parameters":[{"description":"return build results in all lifecycle states, including unknown and active states","in":"query","name":"includeAllStates","schema":{"type":"boolean"}},{"description":"filter only results that may be continued (stopped on Manual Stage)","in":"query","name":"continuable","schema":{"type":"boolean"}},{"description":"expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix","in":"query","name":"expand","schema":{"type":"string"}},{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-]+)"}},{"description":"Filter by comma separated list of Jira issue key related to result","in":"query","name":"issueKey","schema":{"type":"string"}},{"description":"Maximum size for returned list","in":"query","name":"max-results","schema":{"type":"integer","format":"int32"}},{"description":"Start index for results list (zero based)","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"plan key (might be simply planKey or composite planKey-jobKey)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Filter by comma separated list of labels","in":"query","name":"label","schema":{"type":"string"}},{"description":"filter results by state, valid values are Unknown, Successful, Failed","in":"query","name":"buildstate","schema":{"type":"string"}},{"description":"Filters build results list to show only results for favourite plans. Works only for authenticated user","in":"query","name":"favourite","schema":{"type":"string"}},{"description":"return build results in given lifecycle state, valid values are Pending, Queued, InProgress, Finished, NotBuilt (multiple values can be separated by a comma)","in":"query","name":"lifeCycleState","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestResults"}}},"description":"Latest build results for specified plan. Results are ordered from latest or oldest"},"403":{"content":{"application/json":{}},"description":"When user has no permission to view specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project or plan does not exists"}}}},"/api/latest/result/{projectKey}-{buildKey}-{buildNumber}":{"get":{"description":"Provide build result specified by projectKey-buildKey-buildNumber.","operationId":"getBuild","parameters":[{"description":"expands build result details on request. Possible values are: changes, metadata, artifacts, comments, labels, jiraIssues, stages, logEntries. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. logEntries and testResults are available only for job results","in":"query","name":"expand","schema":{"type":"string"}},{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"in case of PENDING or QUEUED state expands build result queue position","in":"query","name":"buildPositions","schema":{"type":"string"}},{"description":"plan key (might be simply planKey or composite planKey-jobKey)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Build number may be specified as *latest* for the result with the highest build number","in":"path","name":"buildNumber","required":true,"schema":{"type":"string","pattern":"([0-9]+)|(latest)"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}},"description":"Result of single build. Presented content contain information for finished build. If build is in progress, contains additional runtime information. Top level plan contains additionally progress information, job progress information, current log entries and hasExecutableAgent boolean flag."},"403":{"content":{"application/json":{}},"description":"When user has no permission to view specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project or plan or build result does not exist"}}}},"/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/comment":{"get":{"description":"Provide list of comments for build result specified by projectKey-buildKey-buildNumber.","operationId":"getBuildComments","parameters":[{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"plan key (might be simply planKey or composite planKey-jobKey)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Build number may be specified as *latest* for the result with the highest build number","in":"path","name":"buildNumber","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestComments"}}},"description":"List of comments for build result"},"403":{"content":{"application/json":{}},"description":"When user has no permission to view specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project or plan or build result does not exist"}}},"post":{"description":"Adds new comment to build result.","operationId":"addBuildComment","parameters":[{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"plan key (might be simply planKey or composite planKey-jobKey)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Build number","in":"path","name":"buildNumber","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCommentRequest"}},"application/xml":{"schema":{"$ref":"#/components/schemas/CreateCommentRequest"}}},"description":"Build result comment","required":true},"responses":{"204":{"description":"Comment added"},"403":{"content":{"application/json":{}},"description":"When user has no permission to view specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project or plan or build result does not exist"}}}},"/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/comment/{commentId}":{"delete":{"description":"Removes a comment from a build result.","operationId":"removeBuildComment","parameters":[{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"plan key (might be simply planKey or composite planKey-jobKey)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"id of the comment","in":"path","name":"commentId","required":true,"schema":{"type":"string"}},{"description":"Build number","in":"path","name":"buildNumber","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"Comment deleted"},"403":{"content":{"application/json":{}},"description":"When user has no permission to delete the specified comment"},"404":{"content":{"application/json":{}},"description":"When specified project, plan, build result or comment does not exist"}}}},"/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/label":{"get":{"description":"Provide list of labels for build result specified by projectKey-buildKey-buildNumber.","operationId":"getBuildLabels","parameters":[{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"plan key (must be a plan key, not a job key)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Build number may be specified as \"latest\" for the result with the highest build number","in":"path","name":"buildNumber","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestBuildLabels"}}},"description":"List of comments for build result"},"403":{"content":{"application/json":{}},"description":"When user has no permission to view specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project, plan, build result does not exist"}}},"post":{"description":"Adds new label to build result specified by projectKey-buildKey-buildNumber.","operationId":"addBuildLabel","parameters":[{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"plan key (must be a plan key, not a job key)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Build number may be specified as *latest* for the result with the highest build number","in":"path","name":"buildNumber","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestBuildLabel"}},"application/xml":{"schema":{"$ref":"#/components/schemas/RestBuildLabel"}}},"description":"Build result label","required":true},"responses":{"204":{"description":"On success"},"403":{"content":{"application/json":{}},"description":"When user has no permission to view specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project, plan, build result does not exist"}}}},"/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/label/{labelName}":{"delete":{"description":"Removes label from build result specified by projectKey-buildKey-buildNumber.","operationId":"removeBuildLabel","parameters":[{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"plan key (must be a plan key, not a job key)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Label name to remove from build result","in":"path","name":"labelName","required":true,"schema":{"type":"string"}},{"description":"Build number may be specified as *latest* for the result with the highest build number","in":"path","name":"buildNumber","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"On success"},"403":{"content":{"application/json":{}},"description":"When user has no permission to edit specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project, plan, build result or label does not exist"}}}},"/api/latest/result/{projectKey}-{buildKey}/branch/{branchName}":{"get":{"description":"Provide list of build results for specified plan's branch. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey).","operationId":"getBranchHistory","parameters":[{"description":"return build results in all lifecycle states, including unknown and active states","in":"query","name":"includeAllStates","schema":{"type":"boolean"}},{"description":"filter only results that may be continued (stopped on Manual Stage)","in":"query","name":"continuable","schema":{"type":"boolean"}},{"description":"Filter by comma separated list of Jira issue key related to result","in":"query","name":"issueKey","schema":{"type":"string"}},{"description":"Maximum size for returned list","in":"query","name":"max-results","schema":{"type":"integer","format":"int32"}},{"description":"Start index for results list (zero based)","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"plan key (might be simply planKey or composite planKey-jobKey)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Branch name","in":"path","name":"branchName","required":true,"schema":{"type":"string"}},{"description":"Filter by comma separated list of labels","in":"query","name":"label","schema":{"type":"string"}},{"description":"filter results by state, valid values are Unknown, Successful, Failed","in":"query","name":"buildstate","schema":{"type":"string"}},{"description":"Filters build results list to show only results for favourite plans. Works only for authenticated user","in":"query","name":"favourite","schema":{"type":"string"}},{"description":"expands build result details on request. Possible values are: artifacts, comments, labels, jiraIssues, stages. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. All expand parameters should contain results.result prefix.","in":"query","name":"expand","schema":{"type":"string"}},{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"return build results in given lifecycle state, valid values are Pending, Queued, InProgress, Finished, NotBuilt (multiple values can be separated by a comma)","in":"query","name":"lifeCycleState","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestResults"}}},"description":"Latest build results for specified plan. Results are ordered from latest or oldest"},"403":{"content":{"application/json":{}},"description":"When user has no permission to view specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project or plan or branch does not exists"}}}},"/api/latest/result/{projectKey}-{buildKey}/{buildNumber}":{"get":{"description":"Provide build result specified by projectKey-buildKey-buildNumber.","operationId":"getBuildAlias","parameters":[{"description":"expands build result details on request. Possible values are: changes, metadata, artifacts, comments, labels, jiraIssues, stages, logEntries. stages expand is available only for top level plans. It allows to drill down to job results using stages.stage.results.result. logEntries and testResults are available only for job results","in":"query","name":"expand","schema":{"type":"string"}},{"description":"project key","in":"path","name":"projectKey","required":true,"schema":{"type":"string","pattern":"([^-/]+)"}},{"description":"plan key (might be simply planKey or composite planKey-jobKey)","in":"path","name":"buildKey","required":true,"schema":{"type":"string"}},{"description":"Build number may be specified as *latest* for the result with the highest build number","in":"path","name":"buildNumber","required":true,"schema":{"type":"string","pattern":"([0-9]+)|(latest)"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Result"}}},"description":"Result of single build. Presented content contain information for finished build. If build is in progress, contains additional runtime information. Top level plan contains additionally progress information, job progress information, current log entries and hasExecutableAgent boolean flag."},"403":{"content":{"application/json":{}},"description":"When user has no permission to view specified plan"},"404":{"content":{"application/json":{}},"description":"When specified project or plan or build result does not exist"}}}},"/api/latest/search/authors":{"get":{"description":"A starts-with search of authors based on their author name.","operationId":"searchAuthors","parameters":[{"description":"Maximum count of returned elements","in":"query","name":"max-result","schema":{"type":"integer","format":"int32"}},{"description":"if true will only include authors which are not currently linked to a user","in":"query","name":"unlinkedOnly","schema":{"type":"boolean"}},{"description":"The term to search for in authors","in":"query","name":"searchTerm","required":true,"schema":{"type":"string"}},{"description":"Start index","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsList"}}},"description":"Search results for authors matching the provided search term"}}}},"/api/latest/search/branches":{"get":{"description":"Performs a \"starts with\" search against full plan branch name and full plan branch key. Branches are restricted to \"masterPlanKey\" plan.","operationId":"searchBranches","parameters":[{"description":"Maximum count of returned elements","in":"query","name":"max-result","schema":{"type":"integer","format":"int32"}},{"description":"The term to search for in branches","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"Should master branch be included into result","in":"query","name":"includeMasterBranch","schema":{"type":"boolean"}},{"description":"Start index","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"Whether the search should only use branch names of plan branches. Default includes the VCS branch name into the fuzzy search","in":"query","name":"branchNameOnly","schema":{"type":"boolean"}},{"description":"Whether the search should be more relaxed when matching results. Default is false","in":"query","name":"fuzzy","schema":{"type":"boolean"}},{"description":"planKey for plan where branches will be searched for","in":"query","name":"masterPlanKey","required":true,"schema":{"type":"string"}},{"description":"id of deployment project - will return only branches that are released in this deployment","in":"query","name":"releasedInDeployment","schema":{"type":"integer","format":"int64"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsList"}}},"description":"Search results for plans matching the provided search term"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"Validation error"}}}},"/api/latest/search/deployments":{"get":{"description":"Performs a contains search against deployment project name.","operationId":"searchDeployments","parameters":[{"description":"Maximum count of returned elements","in":"query","name":"max-result","schema":{"type":"integer","format":"int32"}},{"description":"The term to search for in projects","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"Start index","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"Only return those deployment projects that querying user has permission to. Default is READ","in":"query","name":"permission","schema":{"type":"string","enum":["READ","WRITE","ADMINISTRATION"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsList"}}},"description":"Search results for plans matching the provided search term"}}}},"/api/latest/search/jobs/{planKey}":{"get":{"description":"Performs a \"starts with\" search against full job name and full job key.","operationId":"searchJobs","parameters":[{"description":"Maximum count of returned elements","in":"query","name":"max-result","schema":{"type":"integer","format":"int32"}},{"description":"The term to search for in jobs","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"Start index","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"planKey for plan where jobs will be searched for","in":"path","name":"planKey","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsList"}}},"description":"Search results for plans matching the provided search term"}}}},"/api/latest/search/plans":{"get":{"description":"Performs a \"starts with\" search against full plan name and full plan key. Use \"type\" argument to filter by plan type by default will return TopLevelPlans","operationId":"searchPlans","parameters":[{"description":"Maximum count of returned elements","in":"query","name":"max-result","schema":{"type":"integer","format":"int32"}},{"description":"The term to search for in plans","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"Start index","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"Only return those plans that querying user has permission to. Default is READ","in":"query","name":"permission","schema":{"type":"string","enum":["READ","WRITE","BUILD","CLONE","VIEW_CONFIGURATION","ADMINISTRATION"]}},{"description":"Type of the plan to return","in":"query","name":"type","schema":{"type":"string","enum":["CHAIN","JOB","CHAIN_BRANCH"]}},{"description":"Whether the search should be more relaxed when matching results. Default is false","in":"query","name":"fuzzy","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsList"}}},"description":"Search results for plans matching the provided search term"}}}},"/api/latest/search/projects":{"get":{"description":"Performs a contains search against project name.","operationId":"searchProjects","parameters":[{"description":"Maximum count of returned elements","in":"query","name":"max-result","schema":{"type":"integer","format":"int32"}},{"description":"The term to search for in projects","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"Start index","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"only return those projects that querying user has permission to. Default is READ","in":"query","name":"permission","schema":{"type":"string","enum":["READ","WRITE","ADMINISTRATION"]}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsList"}}},"description":"Search results for plans matching the provided search term"}}}},"/api/latest/search/stages/{planKey}":{"get":{"description":"Performs a \"starts with\" search against full stage name.","operationId":"searchStages","parameters":[{"description":"Maximum count of returned elements","in":"query","name":"max-result","schema":{"type":"integer","format":"int32"}},{"description":"The term to search for in stages","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"Start index","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"planKey for plan where stages will be searched for","in":"path","name":"planKey","required":true,"schema":{"type":"string"}},{"description":"Stage id","in":"query","name":"stageId","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsList"}}},"description":"Search results for plans matching the provided search term"}}}},"/api/latest/search/users":{"get":{"description":"A starts-with search of users based on their username, full-name and if allowed email address.","operationId":"searchUsers","parameters":[{"description":"Maximum count of returned elements","in":"query","name":"max-result","schema":{"type":"integer","format":"int32"}},{"description":"The term to search for in users","in":"query","name":"searchTerm","required":true,"schema":{"type":"string"}},{"description":"Start index","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsList"}}},"description":"Search results for users matching the provided search term"}}}},"/api/latest/search/versions":{"get":{"description":"Performs a contains search against a version name.","operationId":"searchVersions","parameters":[{"description":"Maximum count of returned elements","in":"query","name":"max-result","schema":{"type":"integer","format":"int32"}},{"description":"Narrow the search to releases created out of the branch","in":"query","name":"branchKey","schema":{"type":"string"}},{"description":"The term to search for in projects","in":"query","name":"searchTerm","schema":{"type":"string"}},{"description":"Start index","in":"query","name":"start-index","schema":{"type":"integer","format":"int32"}},{"description":"The deployment project to search under","in":"query","name":"deploymentProjectId","required":true,"schema":{"type":"integer","format":"int64"}},{"description":"Sort releases by creation date","in":"query","name":"chronologicalOrder","schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SearchResultsList"}}},"description":"Search results for plans matching the provided search term"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"Validation error"},"404":{"content":{"application/json":{}},"description":"Deployment project not found"}}}},"/api/latest/server":{"get":{"description":"Get both the asked node and cluster states.","operationId":"getStatus_1","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServerStatusInfo"}}},"description":"Server status"}}}},"/api/latest/server/nodes":{"get":{"description":"Get both the asked node and cluster states together with all nodes' statuses.","operationId":"getNodesStatus","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServerNodesInfo"}}},"description":"Nodes status"},"403":{"content":{"application/json":{}},"description":"User doesn't have RESTRICTED_ADMINISTRATION permissions"}}}},"/api/latest/server/pause":{"post":{"description":"Pauses the cluster.","operationId":"pause","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServerStatusInfo"}}},"description":"Both the asked node and cluster states"},"403":{"content":{"application/json":{}},"description":"User doesn't have ADMINISTRATION permissions"}}}},"/api/latest/server/prepareForRestart":{"put":{"description":"Prepare the asked node for restarting: suspend change detection, stop indexing, stop ec2 instance ordering etc.","operationId":"prepareForRestart","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServerStatusInfo"}}},"description":"Both the asked node and cluster states"},"403":{"content":{"application/json":{}},"description":"User doesn't have ADMINISTRATION permissions"}}}},"/api/latest/server/resume":{"post":{"description":"Resumes the cluster.","operationId":"resume","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestServerStatusInfo"}}},"description":"Both the asked node and cluster states"},"403":{"content":{"application/json":{}},"description":"User doesn't have ADMINISTRATION permissions"}}}},"/api/latest/status":{"get":{"description":"Returns the current status of the Bamboo node. This endpoint enables a basic status check on the status of a Bamboo node.\n\nThe status endpoint will be responsive as long as the Bamboo REST plugin will be running. In other words, this endpoint does depend on the instance health and might not answer as a result of a failure or when Bamboo is still starting.","operationId":"getStatus_2","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestAnonymousServerStatusInfo"}}},"description":"Returns the current status of the server"}}}},"/api/latest/websudo-session":{"delete":{"description":"Remove web sudo from session.","operationId":"removeWebSudoFromSession","responses":{"204":{"description":"Web sudo has been removed from the current session"}}},"get":{"description":"Get the web sudo expiry from session.","operationId":"getExpiry","responses":{"200":{"content":{"application/json":{}},"description":"The expiry time of the current web sudo session"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"No session found in the request or the session did not have web sudo"}}},"put":{"description":"Refresh the web sudo expiry for the current session.","operationId":"refreshWebSudoSession","responses":{"200":{"content":{"application/json":{}},"description":"The new expiry time of the current web sudo session"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestErrorCollection"}}},"description":"No session found in the request or the session did not have web sudo"}}}}}}