{ "info": { "_postman_id": "76d37237-ae77-4952-97ca-4090c13b984b", "name": "Bamboo", "description": "This is the reference document for the Atlassian Bamboo REST API. The REST API is for developers who want to: \n\n - integrate Bamboo with other applications;\n\n - create scripts that interact with Bamboo; or\n\n - develop plugins that enhance the Bamboo UI, using REST to interact with the backend. \n\n You can read more about developing Bamboo plugins in the [Bamboo Developer Documentation](https://developer.atlassian.com/bamboo/server/docs/latest/).", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Responsibility", "item": [ { "name": "/responsibility/latest/brokenBuild/byUser/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}responsibility/latest/brokenBuild/byUser/:name", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true }, { "key": "start", "value": "{{start}}", "disabled": true }, { "key": "showAllResponsible", "value": "{{showAllResponsible}}", "disabled": true, "description": "If response should include other responsible users" } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "User name", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get broken builds for user." }, "response": [] }, { "name": "/responsibility/latest/brokenBuild/myBrokenBuilds", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}responsibility/latest/brokenBuild/myBrokenBuilds", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true }, { "key": "start", "value": "{{start}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get broken builds for logged in user." }, "response": [] }, { "name": "/responsibility/latest/brokenBuild/{planResultKeyOrPlanKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}responsibility/latest/brokenBuild/:planResultKeyOrPlanKey", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "User name", "disabled": false }, { "key": "planResultKeyOrPlanKey", "value": "{{planResultKeyOrPlanKey}}", "description": "Chain result or plan key, e.g. PROJ-PLAN or PROJ-PLAN-2", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get responsible users for broken build result or plan." }, "response": [] }, { "name": "/responsibility/latest/brokenBuild/{planResultKeyOrPlanKey}/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}responsibility/latest/brokenBuild/:planResultKeyOrPlanKey/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "User name", "disabled": false }, { "key": "planResultKeyOrPlanKey", "value": "{{planResultKeyOrPlanKey}}", "description": "Chain result or plan key, e.g. PROJ-PLAN or PROJ-PLAN-2", "disabled": false } ] }, "method": "POST", "header": [], "description": "Add a responsible user for broken build." }, "response": [] }, { "name": "/responsibility/latest/brokenBuild/{planResultKeyOrPlanKey}/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}responsibility/latest/brokenBuild/:planResultKeyOrPlanKey/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "User name", "disabled": false }, { "key": "planResultKeyOrPlanKey", "value": "{{planResultKeyOrPlanKey}}", "description": "Chain result or plan key, e.g. PROJ-PLAN or PROJ-PLAN-2", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove user's responsibility from broken build." }, "response": [] } ] }, { "name": "Triggers", "item": [ { "name": "/triggers/latest/remote/changeDetection", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}triggers/latest/remote/changeDetection", "query": [ { "key": "skipBranches", "value": "{{skipBranches}}", "disabled": true, "description": "by default, the change detection will run for all branches. If this parameter is set to true, the change detection will run only for the chain" }, { "key": "planKey", "value": "{{planKey}}", "disabled": false, "description": "The chain or branch to trigger" } ], "variable": [] }, "method": "POST", "header": [], "description": "Schedule change detection" }, "response": [] } ] }, { "name": "Admin", "item": [ { "name": "/admin/latest/artifactHandlers/agentLocal", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/artifactHandlers/agentLocal", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve configuration of Agent-Local Artifact Handler." }, "response": [] }, { "name": "/admin/latest/artifactHandlers/agentLocal", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/artifactHandlers/agentLocal", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update Agent-Local Artifact Handler configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/artifactHandlers/bambooRemote", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/artifactHandlers/bambooRemote", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve configuration of Bamboo Server Artifact Handler." }, "response": [] }, { "name": "/admin/latest/artifactHandlers/bambooRemote", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/artifactHandlers/bambooRemote", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update Bamboo Server Artifact Handler configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/artifactHandlers/s3", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/artifactHandlers/s3", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve configuration of S3 Artifact Handler." }, "response": [] }, { "name": "/admin/latest/artifactHandlers/s3", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/artifactHandlers/s3", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update S3 Artifact Handler configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/artifactHandlers/sftp", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/artifactHandlers/sftp", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve configuration of SFTP Artifact Handler." }, "response": [] }, { "name": "/admin/latest/artifactHandlers/sftp", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/artifactHandlers/sftp", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update SFTP Artifact Handler configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/config/agents", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/agents", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Return collection of all agents of all types." }, "response": [] }, { "name": "/admin/latest/config/agents/{agentId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/agents/:agentId", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "Id of the agent", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a build agent definition by id." }, "response": [] }, { "name": "/admin/latest/config/agents/{agentId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/agents/:agentId", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "Id of the agent", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update agent details", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/config/auditLog", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/auditLog", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve audit log settings." }, "response": [] }, { "name": "/admin/latest/config/auditLog", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/auditLog", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Enable/disable audit log.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/config/build/concurrency", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/build/concurrency", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve build concurrency settings." }, "response": [] }, { "name": "/admin/latest/config/build/concurrency", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/build/concurrency", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update build concurrency settings. Partially update supported.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/config/build/monitoring", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/build/monitoring", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve build monitoring settings" }, "response": [] }, { "name": "/admin/latest/config/build/monitoring", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/build/monitoring", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update build monitoring settings. Partially update supported.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/config/general", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/general", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve Bamboo server general configurations." }, "response": [] }, { "name": "/admin/latest/config/general", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/general", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update bamboo server general configurations. Partially update supported.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/config/imServer", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/imServer", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get instant message server configuration." }, "response": [] }, { "name": "/admin/latest/config/imServer", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/imServer", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update or create existing IM server configuration in bamboo. If IM server is already configured in bamboo, update existing configuration. Otherwise, create IM server configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/config/imServer", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/imServer", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Delete current IM Server configuration." }, "response": [] }, { "name": "/admin/latest/config/mailServer", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/mailServer", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve the current mail server configuration." }, "response": [] }, { "name": "/admin/latest/config/mailServer", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/mailServer", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update the mail server configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/config/mailServer", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/mailServer", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Delete current mail configuration." }, "response": [] }, { "name": "/admin/latest/config/quarantine", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/quarantine", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve Bamboo quarantine settings." }, "response": [] }, { "name": "/admin/latest/config/quarantine", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/quarantine", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update Bamboo quarantine settings.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/config/remoteAgentSupport", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/remoteAgentSupport", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve the remote agent configuration" }, "response": [] }, { "name": "/admin/latest/config/remoteAgentSupport", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/config/remoteAgentSupport", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update the remote agent configuration", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/darkFeatures", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/darkFeatures", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a list of dark features that are enabled for all users." }, "response": [] }, { "name": "/admin/latest/darkFeatures/{key}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/darkFeatures/:key", "query": [], "variable": [ { "key": "key", "value": "{{key}}", "description": "key of the dark feature", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves whether a given dark feature key is enabled for this instance." }, "response": [] }, { "name": "/admin/latest/darkFeatures/{key}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/darkFeatures/:key", "query": [], "variable": [ { "key": "key", "value": "{{key}}", "description": "key of the dark feature", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Enable or disable a dark feature for all users of this instance.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/darkFeatures/{key}/user/{userName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/darkFeatures/:key/user/:userName", "query": [], "variable": [ { "key": "userName", "value": "{{userName}}", "description": "the user for which the status of the dark feature needs to be checked for", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "key of the dark feature", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves whether a given dark feature key is enabled for a given user. A dark feature is enabled for a user if its either enabled for this instance or for the specific user." }, "response": [] }, { "name": "/admin/latest/darkFeatures/{key}/user/{userName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/darkFeatures/:key/user/:userName", "query": [], "variable": [ { "key": "userName", "value": "{{userName}}", "description": "the username of the user for which the dark feature has to be enabled/disabled", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "key of the dark feature", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Enable or disable a dark feature for a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/elastic/config", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/elastic/config", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves the current elastic configuration." }, "response": [] }, { "name": "/admin/latest/elastic/config", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/elastic/config", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update elastic configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/ephemeral/config", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/ephemeral/config", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves ephemeral agents configuration." }, "response": [] }, { "name": "/admin/latest/ephemeral/config", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/ephemeral/config", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Modify ephemeral agents configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/ephemeral/config/test-connection", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/ephemeral/config/test-connection", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Test connection to ephemeral agents provider.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/expiry/configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/expiry/configuration", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves global build and deployment expiry configuration for this Bamboo instance." }, "response": [] }, { "name": "/admin/latest/expiry/configuration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/expiry/configuration", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update global build and deployment expiry configuration for this Bamboo instance. Partial configuration is not allowed (it will fail validation).", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/expiry/run", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/expiry/run", "query": [], "variable": [] }, "method": "PUT", "header": [], "description": "Executes build and deployment expiry process. Will only start each process if it's not currently running." }, "response": [] }, { "name": "/admin/latest/expiry/status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/expiry/status", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves build and deployment expiry status." }, "response": [] }, { "name": "/admin/latest/globalVariables", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/globalVariables", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Return collection of all global variables. Value of variables that contain password in name will be encrypted with salted hash." }, "response": [] }, { "name": "/admin/latest/globalVariables", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/globalVariables", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a single global variable.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/globalVariables/verify", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/globalVariables/verify", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Server side verification that the encrypted value of a global variable has changed.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/globalVariables/{variableId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/globalVariables/:variableId", "query": [], "variable": [ { "key": "variableId", "value": "{{variableId}}", "description": "Id of the variable", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a global variable definition. Value will be encrypted if variable name contains key word password." }, "response": [] }, { "name": "/admin/latest/globalVariables/{variableId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/globalVariables/:variableId", "query": [], "variable": [ { "key": "variableId", "value": "{{variableId}}", "description": "Id of the variable", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update value of a global variable.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/globalVariables/{variableId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/globalVariables/:variableId", "query": [], "variable": [ { "key": "variableId", "value": "{{variableId}}", "description": "Id of the variable to be deleted", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete a global variable." }, "response": [] }, { "name": "/admin/latest/scheduler/jobs", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/scheduler/jobs", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets the collection of jobs currently scheduled to run." }, "response": [] }, { "name": "/admin/latest/scheduler/jobs/trigger", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/scheduler/jobs/trigger", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Trigger background job execution.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/security/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/security/groups", "query": [ { "key": "name", "value": "{{name}}", "disabled": false, "description": "Name of group" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of groups in Bamboo. The list can be filtered by some attributes, e.g. name. Name is mandatory. Since name is unique, the result only contains 0 or 1 entry." }, "response": [] }, { "name": "/admin/latest/security/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/security/groups", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/security/settings", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/security/settings", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve security settings." }, "response": [] }, { "name": "/admin/latest/security/settings", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/security/settings", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update security settings. Partial update supported.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/security/trustedKey", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/security/trustedKey", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get all trusted keys." }, "response": [] }, { "name": "/admin/latest/security/trustedKey", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/security/trustedKey", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create new trusted key.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/security/trustedKey/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/security/trustedKey/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "ID of the trusted key to delete", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete trusted key." }, "response": [] }, { "name": "/admin/latest/session/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/session/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "disabled": false }, { "key": "user", "value": "{{user}}", "description": "Username", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Invalidate active sessions of the given user" }, "response": [] }, { "name": "/admin/latest/storageSettings", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/storageSettings", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Read storage configuration limits." }, "response": [] }, { "name": "/admin/latest/storageSettings", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/storageSettings", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Set storage configuration limits.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/user", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/user", "query": [ { "key": "externalRename", "value": "{{externalRename}}", "disabled": true, "description": "Set to true if the rename has been done externally and Bamboo is notified of it" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Renames specified user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/admin/latest/user/{newUserName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}admin/latest/user/:newUserName", "query": [ { "key": "externalRename", "value": "{{externalRename}}", "disabled": true, "description": "Set to true if the rename has been done externally and Bamboo is notified of it" } ], "variable": [ { "key": "newUserName", "value": "{{newUserName}}", "description": "User's new username", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Renames specified user.", "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Api", "item": [ { "name": "/api/latest/", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provides list of available REST resources in Bamboo" }, "response": [] }, { "name": "/api/latest/access-token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/access-token", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a page of user's access tokens." }, "response": [] }, { "name": "/api/latest/access-token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/access-token", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create a new access token for the current user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/access-token/{tokenId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/access-token/:tokenId", "query": [], "variable": [ { "key": "tokenId", "value": "{{tokenId}}", "description": "id of the token", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Revoke current user's access token." }, "response": [] }, { "name": "/api/latest/admin/expiry/custom/plan", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/expiry/custom/plan", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get list of all plans where user has admin permission and which override global expiry settings. If global expiry is not enabled it returns empty response." }, "response": [] }, { "name": "/api/latest/admin/expiry/custom/plan/{planKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/expiry/custom/plan/:planKey", "query": [], "variable": [ { "key": "planKey", "value": "{{planKey}}", "description": "key of plan with custom expiry settings", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete custom plan expiry settings." }, "response": [] }, { "name": "/api/latest/admin/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/groups", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "If specified only group names containing the supplied string (case insensitive) will be returned" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a paginated list of groups. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/groups", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new group. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the group to delete", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes the specified group, removing it from the system. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/groups/{name}/add-users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/groups/:name/add-users", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the group", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Add multiple users to a group. The list of usernames should be passed as request body. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/groups/{name}/more-members", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/groups/:name/more-members", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "If specified only users with usernames, display names or email addresses containing the supplied string (case insensitive) will be returned" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "The group which should be used to locate members", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a list of users that are members of a specified group. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/groups/{name}/more-non-members", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/groups/:name/more-non-members", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "If specified only users with usernames, display names or email addresses containing the supplied string will be returned" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "The group which should be used to locate non-members", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a list of users that are not members of a specified group. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/groups/{name}/remove-users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/groups/:name/remove-users", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the group", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Remove multiple users from a group. The list of usernames should be passed as request body. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "If specified only users, whose username, full name or email contain the supplied string (case insensitive) will be returned" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a page of users. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new user. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/users/credentials", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/credentials", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Change password of specified user. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/users/rename", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/rename", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Renames specified user. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user to delete", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes the specified user, removing them from the system. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/users/{name}/access-token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/access-token", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a page of user's access tokens. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/users/{name}/access-token/{tokenId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/access-token/:tokenId", "query": [], "variable": [ { "key": "tokenId", "value": "{{tokenId}}", "description": "id of token", "disabled": false }, { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Revoke user's access token. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/users/{name}/alias", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/alias", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a page of aliases. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/users/{name}/alias", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/alias", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Link existing unlined alias or create the new one. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/users/{name}/alias", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/alias", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Unlink the specified alias from user, removing them from the system. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/users/{name}/assigned-groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/assigned-groups", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "If specified, only groups with names containing the supplied string will be returned" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a list of groups to which the user belongs. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/users/{name}/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/groups", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Add a user to multiple groups. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/users/{name}/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/groups", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Remove a user from multiple groups. The authenticated user must have restricted administrative permission or higher to use this resource.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/admin/users/{name}/unassigned-aliases", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/unassigned-aliases", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "If specified, only aliases with names containing the supplied string will be returned" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a list of unlinked aliases to which the user does not belong. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/admin/users/{name}/unassigned-groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/admin/users/:name/unassigned-groups", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "If specified, only groups with names containing the supplied string will be returned" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "The name identifying the user", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves a list of groups to which the user does not belong. The authenticated user must have restricted administrative permission or higher to use this resource." }, "response": [] }, { "name": "/api/latest/agent", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent", "query": [ { "key": "online", "value": "{{online}}", "disabled": true, "description": "Filter agents based on their online statuses" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provides a list of agents." }, "response": [] }, { "name": "/api/latest/agent/assignment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/assignment", "query": [ { "key": "executorType", "value": "{{executorType}}", "disabled": true, "description": "Executor type" }, { "key": "executorId", "value": "{{executorId}}", "disabled": true, "description": "id of the agent or elastic image" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get agent's assignment." }, "response": [] }, { "name": "/api/latest/agent/assignment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/assignment", "query": [ { "key": "executorType", "value": "{{executorType}}", "disabled": true, "description": "Executor type" }, { "key": "executorId", "value": "{{executorId}}", "disabled": true, "description": "id of the agent or elastic image" }, { "key": "entityId", "value": "{{entityId}}", "disabled": true, "description": "identifier of project, plan, job, deployment project or environment" }, { "key": "assignmentType", "value": "{{assignmentType}}", "disabled": true, "description": "should be PROJECT, PLAN, JOB, ENVIRONMENT, DEPLOYMENT_PROJECT" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Dedicate agent, elastic image or ephemeral template." }, "response": [] }, { "name": "/api/latest/agent/assignment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/assignment", "query": [ { "key": "executorType", "value": "{{executorType}}", "disabled": true, "description": "Executor type" }, { "key": "executorId", "value": "{{executorId}}", "disabled": true, "description": "id of the agent or elastic image" }, { "key": "entityId", "value": "{{entityId}}", "disabled": true, "description": "identifier of project, plan, job, deployment project or environment" }, { "key": "assignmentType", "value": "{{assignmentType}}", "disabled": true, "description": "should be PROJECT, PLAN, JOB, ENVIRONMENT, DEPLOYMENT_PROJECT" } ], "variable": [] }, "method": "DELETE", "header": [], "description": "Remove agent's assignment." }, "response": [] }, { "name": "/api/latest/agent/assignment/search", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/assignment/search", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of records" }, { "key": "executorType", "value": "{{executorType}}", "disabled": true, "description": "Executor type" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "term to search for" }, { "key": "executorId", "value": "{{executorId}}", "disabled": true, "description": "id of the agent or elastic image" }, { "key": "entityType", "value": "{{entityType}}", "disabled": true }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of records" }, { "key": "assignmentType", "value": "{{assignmentType}}", "disabled": true, "description": "should be PROJECT, PLAN, JOB, ENVIRONMENT, DEPLOYMENT_PROJECT" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Search for assignments in specified entity's agents" }, "response": [] }, { "name": "/api/latest/agent/authentication", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/authentication", "query": [ { "key": "pending", "value": "{{pending}}", "disabled": true, "description": "Filter only pending or only approved agents" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provides a list of all agent authentication statuses." }, "response": [] }, { "name": "/api/latest/agent/authentication/{agentUuid}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/authentication/:agentUuid", "query": [], "variable": [ { "key": "agentUuid", "value": "{{agentUuid}}", "disabled": false } ] }, "method": "PUT", "header": [], "description": "Authenticates a pending agent with the given UUID. If the agent has already been authenticated, the call will not\n * change it's state." }, "response": [] }, { "name": "/api/latest/agent/remote", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/remote", "query": [ { "key": "online", "value": "{{online}}", "disabled": true, "description": "Filter remote agents based on their online statuses" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provides a list of all remote agent authentication statuses." }, "response": [] }, { "name": "/api/latest/agent/{agentId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of capabilities/jobs/environments" }, { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "Expand parameter" }, { "key": "includeShared", "value": "{{includeShared}}", "disabled": true, "description": "if response should include shared agent capabilities" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of capabilities/jobs/environments" } ], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "agent id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provides details of an agent." }, "response": [] }, { "name": "/api/latest/agent/{agentId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "agent id", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove build agent." }, "response": [] }, { "name": "/api/latest/agent/{agentId}/capability", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId/capability", "query": [ { "key": "includeShared", "value": "{{includeShared}}", "disabled": true, "description": "if response should include shared agent capabilities" } ], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "agent id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "List agent's capabilities." }, "response": [] }, { "name": "/api/latest/agent/{agentId}/capability", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId/capability", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "agent id", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create new agent capability.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/agent/{agentId}/capability", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId/capability", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "agent id", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove all capabilities of build agent." }, "response": [] }, { "name": "/api/latest/agent/{agentId}/capability/{capabilityKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId/capability/:capabilityKey", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "agent id", "disabled": false }, { "key": "capabilityKey", "value": "{{capabilityKey}}", "description": "Capability key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Update existing agent capability. It's allowed to skip capability key at request payload.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/agent/{agentId}/capability/{capabilityKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId/capability/:capabilityKey", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "agent id", "disabled": false }, { "key": "capabilityKey", "value": "{{capabilityKey}}", "description": "Capability key", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove build agent capability." }, "response": [] }, { "name": "/api/latest/agent/{agentId}/disable", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId/disable", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "agent id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Disable an agent." }, "response": [] }, { "name": "/api/latest/agent/{agentId}/enable", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId/enable", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "agent id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Enable an agent." }, "response": [] }, { "name": "/api/latest/agent/{agentId}/status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/agent/:agentId/status", "query": [], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "filter only remote or only approved agents", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provides information about status of agent, if it's online or offline." }, "response": [] }, { "name": "/api/latest/avatar/user/avatar.png", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/avatar/user/avatar.png", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "multipart/form-data" } ], "description": "Updated the avatar for the currently authenticated user.", "body": { "mode": "formdata", "formdata": [ { "key": "contentType", "disabled": true, "type": "text", "value": "{{contentType}}" }, { "key": "formField", "disabled": true, "type": "text", "value": "{{formField}}" }, { "key": "inputStream", "disabled": true, "type": "text", "value": "{{inputStream}}" }, { "key": "name", "disabled": true, "type": "text", "value": "{{name}}" }, { "key": "size", "disabled": true, "type": "text", "value": "{{size}}" }, { "key": "value", "disabled": true, "type": "text", "value": "{{value}}" } ] } }, "response": [] }, { "name": "/api/latest/avatar/user/avatar.png", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/avatar/user/avatar.png", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Deletes the current avatar for the currently authenticated user." }, "response": [] }, { "name": "/api/latest/avatar/user/{userName}/avatar.png", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/avatar/user/:userName/avatar.png", "query": [ { "key": "s", "value": "{{s}}", "disabled": true, "description": "Size of the requested avatar in px" } ], "variable": [ { "key": "userName", "value": "{{userName}}", "description": "Name of the user to search the avatar for", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns either the avatar file for a specified user or the gravatar URL. The priority order: custom user avatar as a file, gravatar URL, default avatar as a file. The endpoint supports Last-Modified/If-Modified-Since headers and sets cache policy with expiration equal by default to 90 seconds." }, "response": [] }, { "name": "/api/latest/buildNumber/{projectKey}-{buildKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/buildNumber/:projectKey-:buildKey", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Build key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve the next build number for a given plan or plan branch." }, "response": [] }, { "name": "/api/latest/buildNumber/{projectKey}-{buildKey}/bump", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/buildNumber/:projectKey-:buildKey/bump", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Build key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Bump the next build number for a given plan or plan branch to the specified value.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/capability/groupedListing", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/capability/groupedListing", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of capabilities" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "Search term" }, { "key": "lastGroup", "value": "{{lastGroup}}", "disabled": true, "description": "Last group" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of capabilities" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provides a list of capabilities for a select list in the UI. Filterable and paginable." }, "response": [] }, { "name": "/api/latest/chart", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/chart", "query": [ { "key": "buildKeys", "value": "{{buildKeys}}", "disabled": true, "description": "Plan keys" }, { "key": "reportKey", "value": "{{reportKey}}", "disabled": true, "description": "Report key" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Chart url." }, "response": [] }, { "name": "/api/latest/chart/planSummary", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/chart/planSummary", "query": [ { "key": "buildKeys", "value": "{{buildKeys}}", "disabled": true, "description": "Single plan key" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get plan summary." }, "response": [] }, { "name": "/api/latest/chart/reports", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/chart/reports", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of reports" }, { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "Possible values: reports" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of reports" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch available reports list." }, "response": [] }, { "name": "/api/latest/clone/{projectKey}-{buildKey}:{toProjectKey}-{toBuildKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/clone/:projectKey-:buildKey::toProjectKey-:toBuildKey", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Source project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Source build key", "disabled": false }, { "key": "toBuildKey", "value": "{{toBuildKey}}", "description": "Destination build key", "disabled": false }, { "key": "toProjectKey", "value": "{{toProjectKey}}", "description": "Destination project key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Clone an existing Plan into a new one, possibly into different project." }, "response": [] }, { "name": "/api/latest/config/job/{jobKey}/agent-assignment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/config/job/:jobKey/agent-assignment", "query": [], "variable": [ { "key": "jobKey", "value": "{{jobKey}}", "description": "job key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of agents/images assigned to given job." }, "response": [] }, { "name": "/api/latest/config/job/{jobKey}/agent-assignment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/config/job/:jobKey/agent-assignment", "query": [], "variable": [ { "key": "jobKey", "value": "{{jobKey}}", "description": "job key", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Add agent assignment for job. agentAssignmentKey is a map with one key-value: name - agentAssignmentKey. \nagentAssignmentKey is parsed by ExecutorKey.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/config/job/{jobKey}/agent-assignment/possible-agent-assignment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/config/job/:jobKey/agent-assignment/possible-agent-assignment", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of agents" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "Part of the agent/image/template name to filter response. Use empty value to receive all agents/images/templates." }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of agents" } ], "variable": [ { "key": "jobKey", "value": "{{jobKey}}", "description": "job key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of agents/images/templates which can be dedicated for given job." }, "response": [] }, { "name": "/api/latest/config/job/{jobKey}/agent-assignment/{executorKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/config/job/:jobKey/agent-assignment/:executorKey", "query": [], "variable": [ { "key": "executorKey", "value": "{{executorKey}}", "description": "key is parsed by ExecutorKey", "disabled": false }, { "key": "jobKey", "value": "{{jobKey}}", "description": "job key", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove agent/image from list of dedicated executors for given job." }, "response": [] }, { "name": "/api/latest/currentUser", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/currentUser", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch current user details" }, "response": [] }, { "name": "/api/latest/dependency/search/{projectKey}-{buildKey}/child", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/dependency/search/:projectKey-:buildKey/child", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of plans" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": false, "description": "Search term" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of plans" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Build key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Search for available plan child dependencies" }, "response": [] }, { "name": "/api/latest/dependency/search/{projectKey}-{buildKey}/parent", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/dependency/search/:projectKey-:buildKey/parent", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of plans" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": false, "description": "Search term" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of plans" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Build key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Search for available plan parent dependencies" }, "response": [] }, { "name": "/api/latest/deploy/dashboard", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/dashboard", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get all deployment projects. This method fetch all deployment projects visible to user. It's not optimized for instances with large count of deployment projects and environments, use paged versions instead." }, "response": [] }, { "name": "/api/latest/deploy/dashboard/paginate", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/dashboard/paginate", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Deployment project id" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get paginated deployment projects with environments list." }, "response": [] }, { "name": "/api/latest/deploy/dashboard/paginate/{projectId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/dashboard/paginate/:projectId", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Environment name filter" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "projectId", "value": "{{projectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get deployment project environments." }, "response": [] }, { "name": "/api/latest/deploy/dashboard/status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/dashboard/status", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get environment latest release info.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/dashboard/{projectId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/dashboard/:projectId", "query": [], "variable": [ { "key": "projectId", "value": "{{projectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get deployment project environments with deployment status. It's not optimized for instances with large count of deployment projects and environments, use paged versions instead." }, "response": [] }, { "name": "/api/latest/deploy/environment/agent/{agentId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/agent/:agentId", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "string the environments and deployment projects will be filtered by" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "agentId", "value": "{{agentId}}", "description": "id of an agent the environment requirements are checked against", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide a paginated list of minimal information about environments executable by a given agent." }, "response": [] }, { "name": "/api/latest/deploy/environment/elasticImageConfiguration/{configurationId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/elasticImageConfiguration/:configurationId", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "String the environments and deployment projects will be filtered by" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "description": "Id of elastic image configuration the environment requirements are checked against", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide a paginated list of minimal information about environments executable by a given elastic image configuration." }, "response": [] }, { "name": "/api/latest/deploy/environment/ephemeral/{templateId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/ephemeral/:templateId", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "String the environments and deployment projects will be filtered by" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "templateId", "value": "{{templateId}}", "description": "Id of ephemeral agent template the environment requirements are checked against", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide a paginated list of minimal information about environments executable by a given ephemeral agent template." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a summary of a single environment." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/agent-assignment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/agent-assignment", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of agents/images assigned to given environment." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/agent-assignment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/agent-assignment", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Add agent assignment for environment. agentAssignmentKey is a map with one key-value: name - agentAssignmentKey. \nagentAssignmentKey is parsed by ExecutorKey.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/agent-assignment/{executorKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/agent-assignment/:executorKey", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false }, { "key": "executorKey", "value": "{{executorKey}}", "description": "key is parsed by ExecutorKey", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove agent/image from list of dedicated executors for given environment." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/docker", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/docker", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get Docker configuration for given environment." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/docker", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/docker", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Save Docker configuration for given environment.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/move/{position}/{relativeEnvironmentId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/move/:position/:relativeEnvironmentId", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false }, { "key": "relativeEnvironmentId", "value": "{{relativeEnvironmentId}}", "description": "environment id which referenced environment should be placed before or after", "disabled": false }, { "key": "position", "value": "{{position}}", "description": "position; possible values: AFTER or BEFORE", "disabled": false } ] }, "method": "POST", "header": [], "description": "Change environment position within deployment project." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/possible-agent-assignment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/possible-agent-assignment", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of elements" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "Part of the agent or image name to filter response. Use empty value to receive all agents/images/templates." }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of elements" } ], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of agents/images/templates which can be dedicated for given environment." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/prerequisites", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/prerequisites", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates the environment prerequisites.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/requirement", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/requirement", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets all the requirements of an environment." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/requirement", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/requirement", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Adds a requirement for a given environment.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/requirement/detailedSummary", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/requirement/detailedSummary", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets a detailed summary of the agents that are capable of running an environment, based of its requirements." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/requirement/summary", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/requirement/summary", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets a summary of the agents that are capable of running an environment, based of its requirements." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/requirement/{requirementId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/requirement/:requirementId", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false }, { "key": "requirementId", "value": "{{requirementId}}", "description": "unique identifier of the requirement to get details of", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets the details of a requirement for a given environment." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/requirement/{requirementId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/requirement/:requirementId", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false }, { "key": "requirementId", "value": "{{requirementId}}", "description": "unique identifier of the requirement to update", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates a requirement for a given environment.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/requirement/{requirementId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/requirement/:requirementId", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false }, { "key": "requirementId", "value": "{{requirementId}}", "description": "unique identifier of the requirement to delete", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Removes a requirement for an environment." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/results", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/results", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "Expands deployment versions. Possible values are: results" } ], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of versions deployed to the environment. Sorted by started date: newest first." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/variable", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/variable", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create the environment variable.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/variable/{variableName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/variable/:variableName", "query": [], "variable": [ { "key": "variableName", "value": "{{variableName}}", "description": "variable name", "disabled": false }, { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the environment variable by its name." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/variable/{variableName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/variable/:variableName", "query": [], "variable": [ { "key": "variableName", "value": "{{variableName}}", "description": "variable name", "disabled": false }, { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update the environment variable.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/variable/{variableName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/variable/:variableName", "query": [], "variable": [ { "key": "variableName", "value": "{{variableName}}", "description": "variable name", "disabled": false }, { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete the environment variable." }, "response": [] }, { "name": "/api/latest/deploy/environment/{environmentId}/variables", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/environment/:environmentId/variables", "query": [], "variable": [ { "key": "environmentId", "value": "{{environmentId}}", "description": "environment id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of environment variables." }, "response": [] }, { "name": "/api/latest/deploy/issue-status/{issueKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/issue-status/:issueKey", "query": [], "variable": [ { "key": "issueKey", "value": "{{issueKey}}", "description": "Jira issue key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get all deployment projects associated with Jira issue key" }, "response": [] }, { "name": "/api/latest/deploy/issue-status/{issueKey}/{deploymentProjectId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/issue-status/:issueKey/:deploymentProjectId", "query": [], "variable": [ { "key": "issueKey", "value": "{{issueKey}}", "description": "Jira issue key", "disabled": false }, { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get deployment project environments and versions associated with Jira issue" }, "response": [] }, { "name": "/api/latest/deploy/preview/possibleResults", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/preview/possibleResults", "query": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "disabled": true, "description": "Deployment project id" }, { "key": "planKey", "value": "{{planKey}}", "disabled": false, "description": "Plan key" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get possible deployment results." }, "response": [] }, { "name": "/api/latest/deploy/preview/result", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/preview/result", "query": [ { "key": "previousVersionId", "value": "{{previousVersionId}}", "disabled": true, "description": "Previous version id" }, { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "disabled": true, "description": "Deployment project id" }, { "key": "planKey", "value": "{{planKey}}", "disabled": true, "description": "Plan key" }, { "key": "resultKey", "value": "{{resultKey}}", "disabled": true, "description": "Result key" }, { "key": "buildNumber", "value": "{{buildNumber}}", "disabled": true, "description": "Build number" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a preview of the deployment version." }, "response": [] }, { "name": "/api/latest/deploy/preview/version", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/preview/version", "query": [ { "key": "previousVersionId", "value": "{{previousVersionId}}", "disabled": true, "description": "Previous version id" }, { "key": "versionId", "value": "{{versionId}}", "disabled": true, "description": "Deployment version id" }, { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "disabled": true, "description": "Deployment project id" }, { "key": "versionName", "value": "{{versionName}}", "disabled": true, "description": "Deployment version name" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a preview of the deployment version." }, "response": [] }, { "name": "/api/latest/deploy/preview/versionName", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/preview/versionName", "query": [ { "key": "resultKey", "value": "{{resultKey}}", "disabled": true, "description": "Result key" }, { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "disabled": false, "description": "Deployment project id" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get version name." }, "response": [] }, { "name": "/api/latest/deploy/project", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create deployment project.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/project/all", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/all", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find all deployment projects with environments. Returns only deployment projects and environments visible for user." }, "response": [] }, { "name": "/api/latest/deploy/project/forPlan", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/forPlan", "query": [ { "key": "planKey", "value": "{{planKey}}", "disabled": false, "description": "Plan key" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get list of deployment projects for a build plan." }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId", "query": [], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get deployment project by id." }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId", "query": [], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update deployment project.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId", "query": [], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete deployment project." }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}/repository", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId/repository", "query": [], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "List of repositories which granted to create/edit environment in given deployment project by Repository stored Bamboo Specs." }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}/repository", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId/repository", "query": [], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Grant permission to create/edit plan in given deployment project by Bamboo Specs from given repository.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}/repository/search", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId/repository/search", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of repositories" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "Part of repository name. Used to filter output." }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of repositories" } ], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Search for linked repositories which can be granted to create/modify environment by Repository stored Bamboo Specs in given deployment project." }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}/repository/{repositoryId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId/repository/:repositoryId", "query": [], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Linked repository root id", "disabled": false }, { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove approval to create plans in given deployment project by given repository." }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}/specs", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId/specs", "query": [ { "key": "package", "value": "{{package}}", "disabled": true, "description": "The package to use as the namespace of the exported Spec" }, { "key": "format", "value": "{{format}}", "disabled": true, "description": "Optionally, a format of code. It's 'java' by default. Other option is 'yaml." } ], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Export a deployment project to Bamboo Specs." }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}/version", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId/version", "query": [], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create deployment version for given deployment project.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/deploy/project/{deploymentProjectId}/versions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/project/:deploymentProjectId/versions", "query": [ { "key": "branchKey", "value": "{{branchKey}}", "disabled": true, "description": "plan branch key. Can be empty if default branch is required" } ], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get list of deployment versions." }, "response": [] }, { "name": "/api/latest/deploy/projectVersioning/{deploymentProjectId}/namingPreview", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/projectVersioning/:deploymentProjectId/namingPreview", "query": [ { "key": "nextVersionName", "value": "{{nextVersionName}}", "disabled": false, "description": "Version name" }, { "key": "incrementableVariables", "value": "{{incrementableVariables}}", "disabled": true, "description": "variables used for version name. Divided by coma" }, { "key": "incrementNumbers", "value": "{{incrementNumbers}}", "disabled": true, "description": "If version number should be incremented" } ], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get deployment version name preview." }, "response": [] }, { "name": "/api/latest/deploy/projectVersioning/{deploymentProjectId}/nextVersion", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/projectVersioning/:deploymentProjectId/nextVersion", "query": [ { "key": "resultKey", "value": "{{resultKey}}", "disabled": true, "description": "Build result key" } ], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get next deployment version name." }, "response": [] }, { "name": "/api/latest/deploy/projectVersioning/{deploymentProjectId}/parseVariables", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/projectVersioning/:deploymentProjectId/parseVariables", "query": [ { "key": "nextVersionName", "value": "{{nextVersionName}}", "disabled": false, "description": "Version name" } ], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Extract variables value from version name." }, "response": [] }, { "name": "/api/latest/deploy/projectVersioning/{deploymentProjectId}/variables", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/projectVersioning/:deploymentProjectId/variables", "query": [], "variable": [ { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "description": "Deployment project id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get variables associated with deployment project." }, "response": [] }, { "name": "/api/latest/deploy/result/{deploymentResultId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/result/:deploymentResultId", "query": [ { "key": "includeLogs", "value": "{{includeLogs}}", "disabled": true, "description": "If logs should be included" } ], "variable": [ { "key": "deploymentResultId", "value": "{{deploymentResultId}}", "description": "Deployment result id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get result of version deployment to environment." }, "response": [] }, { "name": "/api/latest/deploy/version/{deploymentVersionId}/build-result", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/version/:deploymentVersionId/build-result", "query": [], "variable": [ { "key": "deploymentVersionId", "value": "{{deploymentVersionId}}", "description": "Deployment version id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get associated build result of deployment version." }, "response": [] }, { "name": "/api/latest/deploy/version/{deploymentVersionId}/status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/version/:deploymentVersionId/status", "query": [], "variable": [ { "key": "deploymentVersionId", "value": "{{deploymentVersionId}}", "description": "Deployment version id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the all users' latest statuses of deployment version." }, "response": [] }, { "name": "/api/latest/deploy/version/{deploymentVersionId}/status/{newStatus}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/deploy/version/:deploymentVersionId/status/:newStatus", "query": [], "variable": [ { "key": "deploymentVersionId", "value": "{{deploymentVersionId}}", "description": "Deployment version id", "disabled": false }, { "key": "newStatus", "value": "{{newStatus}}", "description": "deployment version status. Possible values: UNKNOWN, APPROVED, BROKEN, INCOMPLETE", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update deployment version status." }, "response": [] }, { "name": "/api/latest/elasticConfiguration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/elasticConfiguration", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch all elastic image configurations." }, "response": [] }, { "name": "/api/latest/elasticConfiguration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/elasticConfiguration", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create elastic image configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/elasticConfiguration/image-id/{imageId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/elasticConfiguration/image-id/:imageId", "query": [ { "key": "newImageId", "value": "{{newImageId}}", "disabled": false, "description": "New AMI id" } ], "variable": [ { "key": "imageId", "value": "{{imageId}}", "description": "AMI id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Bulk update of all images AMI id." }, "response": [] }, { "name": "/api/latest/elasticConfiguration/{configurationId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/elasticConfiguration/:configurationId", "query": [], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Elastic image configuration details." }, "response": [] }, { "name": "/api/latest/elasticConfiguration/{configurationId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/elasticConfiguration/:configurationId", "query": [], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "description": "Image configuration id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update elastic image configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/elasticConfiguration/{configurationId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/elasticConfiguration/:configurationId", "query": [], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "description": "Image configuration id", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete elastic image configuration." }, "response": [] }, { "name": "/api/latest/elasticInstances/instance/{instanceId}/logs", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/elasticInstances/instance/:instanceId/logs", "query": [], "variable": [ { "key": "instanceId", "value": "{{instanceId}}", "description": "id of the EC2 instance", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Obtain logs from an EC2 instance. Note that this method will return the console output of the instance, not Bamboo agent logs." }, "response": [] }, { "name": "/api/latest/encrypt", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/encrypt", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Encrypts a given text based on the instance specific cipher. Encrypted data can be used i.a. in Repository-stored Specs. Feature can be enabled or disabled in Bamboo security configuration. Number of allowed requests per user is limited and can be modified in Bamboo security configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/ephemeral/pod/{pod}/logs", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/pod/:pod/logs", "query": [ { "key": "containerName", "value": "{{containerName}}", "disabled": true, "description": "Container name, by default empty" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Log entries limit, by default 50. If it is 'unlimited', all available logs will be returned" }, { "key": "afterTimestamp", "value": "{{afterTimestamp}}", "disabled": true, "description": "The timestamp indicates the logs' bottom time boundary" } ], "variable": [ { "key": "pod", "value": "{{pod}}", "description": "Pod name", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets either pod or container related logs." }, "response": [] }, { "name": "/api/latest/ephemeral/pod/{pod}/logs/raw", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/pod/:pod/logs/raw", "query": [ { "key": "containerName", "value": "{{containerName}}", "disabled": true, "description": "Container name, by default empty" } ], "variable": [ { "key": "pod", "value": "{{pod}}", "description": "Pod name", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets either pod or container all logs in the raw, plain text form." }, "response": [] }, { "name": "/api/latest/ephemeral/templateConfiguration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/templateConfiguration", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true }, { "key": "limit", "value": "{{limit}}", "disabled": true }, { "key": "start", "value": "{{start}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch page of ephemeral templates." }, "response": [] }, { "name": "/api/latest/ephemeral/templateConfiguration", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/templateConfiguration", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create ephemeral template configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/ephemeral/templateConfiguration/{configurationId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/templateConfiguration/:configurationId", "query": [], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "description": "Configuration ID", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Gets ephemeral template configuration details." }, "response": [] }, { "name": "/api/latest/ephemeral/templateConfiguration/{configurationId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/templateConfiguration/:configurationId", "query": [], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "description": "Configuration ID", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update ephemeral agent template.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/ephemeral/templateConfiguration/{configurationId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/templateConfiguration/:configurationId", "query": [], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "description": "Configuration ID", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete ephemeral template configuration." }, "response": [] }, { "name": "/api/latest/ephemeral/templateConfiguration/{configurationId}/capability", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/templateConfiguration/:configurationId/capability", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true }, { "key": "start", "value": "{{start}}", "disabled": true } ], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "description": "Configuration ID", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch page of ephemeral agent template capabilities." }, "response": [] }, { "name": "/api/latest/ephemeral/templateConfiguration/{configurationId}/capability", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/templateConfiguration/:configurationId/capability", "query": [], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "description": "Configuration ID", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Update ephemeral agent template capability.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/ephemeral/templateConfiguration/{configurationId}/capability", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/templateConfiguration/:configurationId/capability", "query": [], "variable": [ { "key": "configurationId", "value": "{{configurationId}}", "description": "Configuration ID", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Add ephemeral agent template capability.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/ephemeral/templateConfiguration/{configurationId}/capability/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/ephemeral/templateConfiguration/:configurationId/capability/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Capability key", "disabled": false }, { "key": "configurationId", "value": "{{configurationId}}", "description": "Configuration ID", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove ephemeral agent template capability." }, "response": [] }, { "name": "/api/latest/info", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/info", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Bamboo instance details." }, "response": [] }, { "name": "/api/latest/job/{jobKey}/docker", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/job/:jobKey/docker", "query": [], "variable": [ { "key": "jobKey", "value": "{{jobKey}}", "description": "Key of the job", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves Docker configuration for given job." }, "response": [] }, { "name": "/api/latest/job/{jobKey}/docker", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/job/:jobKey/docker", "query": [], "variable": [ { "key": "jobKey", "value": "{{jobKey}}", "description": "Key of the job", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Updates Docker configuration for given job.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/available-groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/available-groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of groups which weren't granted explicitly any deployment project permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/available-users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/available-users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of users which weren't granted explicitly any deployment project permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of groups with their deployment project permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants deployment project permissions to a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes deployment project permissions from a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/roles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/roles", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of roles with their deployment project permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users." }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants deployment project permissions to a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes deployment project permissions from a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants deployment project permissions to a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/deployment/{id}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/deployment/:id/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment project entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes deployment project permissions from a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/available-groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/available-groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of groups which weren't granted explicitly any deployment environment permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/available-users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/available-users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of users which weren't granted explicitly any deployment environment permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of groups with their deployment environment permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Permission names to grant", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants deployment environment permissions to a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes deployment environment permissions from a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/roles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/roles", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of roles with their deployment environment permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users" }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants deployment environment permissions to a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes deployment environment permissions from a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants deployment environment permissions to a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/environment/{id}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/environment/:id/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Deployment environment entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes deployment environment permissions from a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/global/available-groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/available-groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" }, { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of groups which weren't granted explicitly any permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/global/available-users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/available-users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" }, { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of users which weren't granted explicitly any permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/global/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" }, { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of groups with their global permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/global/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/groups/:name", "query": [ { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants global permissions to a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/global/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/groups/:name", "query": [ { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes global permissions from a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/global/roles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/roles", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of roles with their global permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users" }, "response": [] }, { "name": "/api/latest/permissions/global/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/roles/:name", "query": [ { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants global permissions to a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/global/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/roles/:name", "query": [ { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes global permissions from a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/global/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" }, { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of users with their global permissions. The list can be filtered by some attributes. This resource is paged and returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/global/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/users/:name", "query": [ { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants global permissions to a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/global/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/global/users/:name", "query": [ { "key": "ignore", "value": "{{ignore}}", "disabled": true } ], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes global permissions from a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/available-groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/available-groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of groups which weren't granted explicitly any plan permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/available-users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/available-users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of users which weren't granted explicitly any plan permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of groups with their plan permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants plan permissions to a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes plan permissions from a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/roles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/roles", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of roles with their plan permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users." }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants plan permissions to a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes plan permissions from a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants plan permissions to a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/plan/{key}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/plan/:key/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Plan entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes plan permissions from a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/available-groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/available-groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of groups which weren't granted explicitly any project permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/available-users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/available-users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of users which weren't granted explicitly any project permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of groups with their project permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants project permissions to a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes project permissions from a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/roles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/roles", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of roles with their project permissions. This resource is paged returns a single page of results, although only LOGGED IN users role is supported" }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants project permissions to a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes project permissions from a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants project permissions to a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/project/{key}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/project/:key/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes project permissions from a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/available-groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/available-groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of groups which weren't granted explicitly any project plan permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/available-users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/available-users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of users which weren't granted explicitly any project plan permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of groups with their project plan permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants project plan permissions to a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes project plan permissions from a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/roles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/roles", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of roles with their project plan permissions. This resource is paged returns a single page of results, although only 2 roles are supported: LOGGED IN users, ANONYMOUS users." }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants project plan permissions to a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes project plan permissions from a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants project plan permissions to a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/projectplan/{key}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/projectplan/:key/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "key", "value": "{{key}}", "description": "Project entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes project plan permissions from a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/available-groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/available-groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of groups which weren't granted explicitly any repository permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/available-users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/available-users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns list of users which weren't granted explicitly any repository permissions. Resource is paged, returns single page of resources." }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/groups", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/groups", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "Group name filter, filter is case insensitive matches group name" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of groups with their repository permissions. The list can be filtered by some attributes. This resource is paged returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants repository permissions to a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/groups/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/groups/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected group", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes repository permissions from a given group.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/roles", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/roles", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of roles with their repository permissions. This resource is paged returns a single page of results, although only LOGGED IN users role is supported." }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants repository permissions to a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/roles/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/roles/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Affected role", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes repository permissions from a given role.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/users", "query": [ { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" }, { "key": "name", "value": "{{name}}", "disabled": true, "description": "User filter, filter is case insensitive matches: username, user's full name, user's email" } ], "variable": [ { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of users with their explicit permissions to given resource. The list can be filtered by some attributes. This resource is paged and returns a single page of results." }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Grants repository permissions to a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/permissions/repository/{id}/users/{name}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/permissions/repository/:id/users/:name", "query": [], "variable": [ { "key": "name", "value": "{{name}}", "description": "Username of the affected user", "disabled": false }, { "key": "id", "value": "{{id}}", "description": "Repository entity key", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Revokes repository permissions from a given user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/plan", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "Possible expand parameters: plans." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "List all plans that user has READ permission for and allowed to see.\n\nPossible expand parameters:\n\n- plans - list of plans\n\n- plans.plan - list of plans with plan details\n\n- plans.plan.actions - list of plans with actions details" }, "response": [] }, { "name": "/api/latest/plan/favicon/{planKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/favicon/:planKey", "query": [], "variable": [ { "key": "planKey", "value": "{{planKey}}", "description": "Plan key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Plan's favicon which depends on last build result." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "Possible expand parameters: actions, stages, branches, variableContext." } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Build key (might be planKey or composite planKey-jobKey)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch plan details." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Marks plan for deletion. Plan will be deleted by a batch job." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/artifact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/artifact", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of artifacts" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of artifacts" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch plan's shared artifact definitions." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/branch", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/branch", "query": [ { "key": "enabledOnly", "value": "{{enabledOnly}}", "disabled": true, "description": "Show enabled branches only" }, { "key": "cloverEnabled", "value": "{{cloverEnabled}}", "disabled": true, "description": "Show branches with Clover integration enabled" }, { "key": "my", "value": "{{my}}", "disabled": true, "description": "Show branches where current user is creator" }, { "key": "favourite", "value": "{{favourite}}", "disabled": true, "description": "Show favourite branches only" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch list of branches for specified plan." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/branch/enableSpecsForBranches", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/branch/enableSpecsForBranches", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "POST", "header": [], "description": "Enable specs scanning for all branches." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/branch/{branchName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/branch/:branchName", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false }, { "key": "branchName", "value": "{{branchName}}", "description": "Branch display name", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide details for specified branch of a specified plan." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/branch/{branchName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/branch/:branchName", "query": [ { "key": "cleanupEnabled", "value": "{{cleanupEnabled}}", "disabled": true, "description": "If plan branch expiry settings should be enabled" }, { "key": "vcsBranch", "value": "{{vcsBranch}}", "disabled": true, "description": "Name of the VCS branch" }, { "key": "enabled", "value": "{{enabled}}", "disabled": true, "description": "If plan branch should be enabled" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false }, { "key": "branchName", "value": "{{branchName}}", "description": "New branch name", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create branch for a plan. You can use **vcsBranch** query param to define which vcsBranch should newly created branch use. If not specified it will not override vcsBranch from the plan." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/enable", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/enable", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "POST", "header": [], "description": "Enable plan." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/enable", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/enable", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Disable plan." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/favourite", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/favourite", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "POST", "header": [], "description": "Add plan to favourite." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/favourite", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/favourite", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove plan from favorites." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/issue/{issueKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/issue/:issueKey", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "issueKey", "value": "{{issueKey}}", "description": "Jira issue key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch linked Jira issue details." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/label", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/label", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "List of labels for plan." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/label", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/label", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Add new label to plan.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/label/{labelName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/label/:labelName", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false }, { "key": "labelName", "value": "{{labelName}}", "description": "Label name to remove from plan", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove label from plan." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/specs", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/specs", "query": [ { "key": "package", "value": "{{package}}", "disabled": true, "description": "A package name for the exported spec" }, { "key": "format", "value": "{{format}}", "disabled": true, "description": "a format of code. It's 'java' by default." } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Export plan as Bamboo Specs code." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/test/{testId}/quarantine", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/test/:testId/quarantine", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false }, { "key": "testId", "value": "{{testId}}", "description": "Test id", "disabled": false } ] }, "method": "POST", "header": [], "description": "Quarantine plan's test." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/test/{testId}/unleash", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/test/:testId/unleash", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false }, { "key": "testId", "value": "{{testId}}", "description": "Test id", "disabled": false } ] }, "method": "POST", "header": [], "description": "Unleash plan's test from quarantine." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/variables", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/variables", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve the list of all variables for a plan." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/variables", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/variables", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Add a new plan variable.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/variables/{variableName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/variables/:variableName", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "variableName", "value": "{{variableName}}", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve the plan variable by given name." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/variables/{variableName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/variables/:variableName", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "variableName", "value": "{{variableName}}", "description": "Variable name", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update the plan variable.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/variables/{variableName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/variables/:variableName", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "variableName", "value": "{{variableName}}", "description": "Name of the variable to be deleted", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete the plan variable." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}-{buildKey}/vcsBranches", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey-:buildKey/vcsBranches", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of branches" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "Search term based on which the branch names will be filtered out" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of branches" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Plan key - only top level plans are supported", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "List of vcs branch names for branches that exist on the default repository of this plan." }, "response": [] }, { "name": "/api/latest/plan/{projectKey}/{buildKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/plan/:projectKey/:buildKey", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "Possible expand parameters: actions, stages, branches, variableContext." } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "Build key (might be planKey or composite planKey-jobKey)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch plan details." }, "response": [] }, { "name": "/api/latest/planDirectoryInfo/{planKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/planDirectoryInfo/:planKey", "query": [], "variable": [ { "key": "planKey", "value": "{{planKey}}", "description": "the plan key to retrieve directory information for. Can be a top-level key (i.e. 'PROJ-PLAN') or a branch key (i.e. 'PROJ-PLAN15')", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provides the directories where artifacts and build logs can be found for a given plan key. Disabled by default. See https://confluence.atlassian.com/display/BAMBOO/Plan+directory+information+REST+API for more information." }, "response": [] }, { "name": "/api/latest/project", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "Possible expand parameters: projects, projects.project.plans, projects.project.plans.plan" }, { "key": "showEmpty", "value": "{{showEmpty}}", "disabled": true, "description": "flag to display projects without plans" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "List all projects defined in Bamboo. Projects without any plan are not listed by default, unless _showEmpty_ query param is set to true.\n\n- projects - list of projects projects.project - list of projects with project details\n\n- projects.project.plans - list of project details and plans for project\n\n- projects.project.plans.plan - list of project details and plans for project with plan details" }, "response": [] }, { "name": "/api/latest/project", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create project.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/project/{projectKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "Possible expand parameters: plans, plans.plan, plans.plan.actions" }, { "key": "showEmpty", "value": "{{showEmpty}}", "disabled": true, "description": "flag to return project without plans, *true* by default" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get information for project specified as project key.\n\n- plans - list of plans for project\n\n- plans.plan - list of plans with plan details (only plans visible - READ permission for user)\n\n- plans.plan.actions - list of plans with plan details and actions available for user for plan\n\n" }, "response": [] }, { "name": "/api/latest/project/{projectKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Marks project for deletion. Project will be deleted by a batch job." }, "response": [] }, { "name": "/api/latest/project/{projectKey}/repositories", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/repositories", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "filter to retrieve matching results" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves paginated project repositories specified by the project key." }, "response": [] }, { "name": "/api/latest/project/{projectKey}/repository", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/repository", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch list of repositories which granted to create plan in given project by Repository stored Bamboo Specs." }, "response": [] }, { "name": "/api/latest/project/{projectKey}/repository", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/repository", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Grant permission to create/edit plan in given project by Bamboo Specs from given repository.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/project/{projectKey}/repository/search", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/repository/search", "query": [ { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "part of repository name. Used to filter output." } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Search for linked repositories which can be granted to create plans by Repository stored Bamboo Specs in given project" }, "response": [] }, { "name": "/api/latest/project/{projectKey}/repository/{repositoryId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/repository/:repositoryId", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "repositoryId", "value": "{{repositoryId}}", "description": "linked repository root id", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove approval to create plans in given project by given repository." }, "response": [] }, { "name": "/api/latest/project/{projectKey}/repository/{repositoryId}/enableAllRepositoriesAccess", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/repository/:repositoryId/enableAllRepositoriesAccess", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Repository id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Enables access (i.e. allowing usage) to all project's repositories by the Bamboo Specs code stored in this repository.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/project/{projectKey}/sharedCredentials", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/sharedCredentials", "query": [ { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "filter to retrieve matching results" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "Page request size. Default size is 25. Max value is 500" }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "Page request start index" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieves paginated shared credentials for the project specified by the project key." }, "response": [] }, { "name": "/api/latest/project/{projectKey}/sharedCredentials/{sharedCredentialId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/sharedCredentials/:sharedCredentialId", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "sharedCredentialId", "value": "{{sharedCredentialId}}", "description": "project shared credentials id", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Deletes shared project credentials specified by id." }, "response": [] }, { "name": "/api/latest/project/{projectKey}/specs", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/specs", "query": [ { "key": "package", "value": "{{package}}", "disabled": true, "description": "A package name for the exported spec" }, { "key": "format", "value": "{{format}}", "disabled": true, "description": "a format of code. It's 'java' by default." } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "The project to export for", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Export all of the plans for a project to Bamboo specs." }, "response": [] }, { "name": "/api/latest/project/{projectKey}/variable", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/variable", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create or update project variable.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/project/{projectKey}/variable/{variableName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/variable/:variableName", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "variableName", "value": "{{variableName}}", "description": "variable name", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve the project variable by given name." }, "response": [] }, { "name": "/api/latest/project/{projectKey}/variable/{variableName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/variable/:variableName", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "variableName", "value": "{{variableName}}", "description": "name of the variable to be deleted", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete the project variable." }, "response": [] }, { "name": "/api/latest/project/{projectKey}/variables", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/project/:projectKey/variables", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve the list of all variables for a project." }, "response": [] }, { "name": "/api/latest/queue", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/queue", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of builds" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index of builds" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide list of build scheduled for execution and waiting in build queue." }, "response": [] }, { "name": "/api/latest/queue/deployment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/queue/deployment", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "description": "expands deployment result queue items on request. Possible value: queuedDeployments" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide list of deployment results scheduled for execution and waiting in queue." }, "response": [] }, { "name": "/api/latest/queue/deployment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/queue/deployment", "query": [ { "key": "versionId", "value": "{{versionId}}", "disabled": false, "description": "Version (release) id" }, { "key": "environmentId", "value": "{{environmentId}}", "disabled": false, "description": "Deployment environment id" }, { "key": "verboseLogging", "value": "{{verboseLogging}}", "disabled": true, "description": "Runs deployments with verbose logs" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Trigger deployment for deployment environment and version." }, "response": [] }, { "name": "/api/latest/queue/deployment/{deploymentResultId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/queue/deployment/:deploymentResultId", "query": [], "variable": [ { "key": "deploymentResultId", "value": "{{deploymentResultId}}", "description": "id of deployment result in queue", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Remove deployment result from queue." }, "response": [] }, { "name": "/api/latest/queue/{projectKey}-{buildKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/queue/:projectKey-:buildKey", "query": [ { "key": "executeAllStages", "value": "{{executeAllStages}}", "disabled": true, "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." }, { "key": "customRevision", "value": "{{customRevision}}", "disabled": true, "description": "execute this plan for a custom revision instead of the latest one" }, { "key": "stage", "value": "{{stage}}", "disabled": true, "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" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (only top level plan key, can not be job key)", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fire build execution for specified plan.\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 either as form encoded POST payload or query parameters. PLEASE note: Query parameters are more important - override those stored in form payload.\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 default values for variables." }, "response": [] }, { "name": "/api/latest/queue/{projectKey}-{buildKey}-{buildNumber}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/queue/:projectKey-:buildKey-:buildNumber", "query": [ { "key": "executeAllStages", "value": "{{executeAllStages}}", "disabled": true, "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." }, { "key": "stage", "value": "{{stage}}", "disabled": true, "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" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (only top level plan key, can not be job key)", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "build number to resume/rerun", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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)." }, "response": [] }, { "name": "/api/latest/queue/{projectKey}-{buildKey}-{buildNumber}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/queue/:projectKey-:buildKey-:buildNumber", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "Project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "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.", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Stop build execution." }, "response": [] }, { "name": "/api/latest/quickFilter", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter", "query": [ { "key": "configured", "value": "{{configured}}", "disabled": true, "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" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Obtain a list of quick filters defined for this Bamboo instance." }, "response": [] }, { "name": "/api/latest/quickFilter", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/quickFilter/active", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter/active", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Return active quick filters for currently logged in user." }, "response": [] }, { "name": "/api/latest/quickFilter/deactivate", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter/deactivate", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Deactivates all quick filter for currently logged in user." }, "response": [] }, { "name": "/api/latest/quickFilter/visible", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter/visible", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Return visible quick filters for currently logged in user." }, "response": [] }, { "name": "/api/latest/quickFilter/visible", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter/visible", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Saves the list of visible quick filters for currently logged in user.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/quickFilter/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Quick filter id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a single quick filter by id." }, "response": [] }, { "name": "/api/latest/quickFilter/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Quick filter id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/quickFilter/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter/:id", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Quick filter id", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete a quick filter." }, "response": [] }, { "name": "/api/latest/quickFilter/{id}/activate", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter/:id/activate", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Quick filter id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Activates a quick filter for currently logged in user." }, "response": [] }, { "name": "/api/latest/quickFilter/{id}/deactivate", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quickFilter/:id/deactivate", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Quick filter id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Deactivates a quick filter for currently logged in user." }, "response": [] }, { "name": "/api/latest/quicksearch", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/quicksearch", "query": [ { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "to search for" }, { "key": "searchEntity", "value": "{{searchEntity}}", "disabled": true, "description": "entity to search for" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Performs a starts with search against projects, plans, plan branches, deployment projects" }, "response": [] }, { "name": "/api/latest/reindex", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/reindex", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Kicks off a reindex. Requires system admin permissions to perform this reindex." }, "response": [] }, { "name": "/api/latest/reindex", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/reindex", "query": [], "variable": [] }, "method": "POST", "header": [], "description": "Kicks off a reindex. Requires system admin permissions to perform this operation." }, "response": [] }, { "name": "/api/latest/repository", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository", "query": [ { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "Target repository id" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Search for existing linked repositories by name." }, "response": [] }, { "name": "/api/latest/repository/scan", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/scan", "query": [ { "key": "name", "value": "{{name}}", "disabled": true, "description": "Unique name of the linked repository which stores Bamboo Specs" }, { "key": "repositoryId", "value": "{{repositoryId}}", "disabled": true, "description": "alternative name of the query parameter to provide repository ID" }, { "key": "id", "value": "{{id}}", "disabled": true, "description": "ID of the linked repository which stores Bamboo Specs" }, { "key": "repositoryName", "value": "{{repositoryName}}", "disabled": true, "description": "Alternative name of the query parameter to provide repository name" } ], "variable": [] }, "method": "POST", "header": [], "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." }, "response": [] }, { "name": "/api/latest/repository/testConnection", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/testConnection", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Tests connection to a repository if the repository type supports connection testing. Request payload should contain repository configuration.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/enableAllProjectsAccess", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/enableAllProjectsAccess", "query": [], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Repository id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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).", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/enableAllRepositoriesAccess", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/enableAllRepositoriesAccess", "query": [], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Repository id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/enableCi", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/enableCi", "query": [], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Repository id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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).", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/enableProjectCreation", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/enableProjectCreation", "query": [], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Repository id", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Enables build and deployment project creation by the Bamboo Specs code stored in this repository.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/rssBranches", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/rssBranches", "query": [ { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "Part of branch name. Used to filter output" } ], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "id of the linked repository which stores Bamboo Specs", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Search for divergent branches names (i.e. vcs branches that have RSS execution results)." }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/rssrepository", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/rssrepository", "query": [], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Target repository id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch list of RSS repositories which can use given repository by RSS code." }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/rssrepository", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/rssrepository", "query": [], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Repository id", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "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.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/rssrepository/search", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/rssrepository/search", "query": [ { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "Part of repository name. Used to filter output" } ], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Target repository id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Search for existing linked repositories which can be granted to use given repository by RSS." }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/scan/status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/scan/status", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum number of spec status entries returned in the response" }, { "key": "branch", "value": "{{branch}}", "disabled": true, "description": "Optional branch of the repository. Works only if repository supports divergent branches" } ], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "id of the linked repository which stores Bamboo Specs", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Resource providing status of RSS processing for a given repository and optional branch." }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/scanNow", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/scanNow", "query": [ { "key": "branch", "value": "{{branch}}", "disabled": true, "description": "Optional branch of the repository. Works only if repository supports divergent branches" } ], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "id of the repository to trigger", "disabled": false } ] }, "method": "POST", "header": [], "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)." }, "response": [] }, { "name": "/api/latest/repository/{repositoryId}/usage", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:repositoryId/usage", "query": [ { "key": "max-plans", "value": "{{max-plans}}", "disabled": true, "description": "Maximum count of detailed plans at response" }, { "key": "max-environments", "value": "{{max-environments}}", "disabled": true, "description": "Maximum count of detailed environments at response" } ], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Repository id", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Search for usages of given repository." }, "response": [] }, { "name": "/api/latest/repository/{targetRepositoryId}/rssrepository/{repositoryId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/repository/:targetRepositoryId/rssrepository/:repositoryId", "query": [], "variable": [ { "key": "repositoryId", "value": "{{repositoryId}}", "description": "Linked repository root id", "disabled": false }, { "key": "targetRepositoryId", "value": "{{targetRepositoryId}}", "description": "Target repository id", "disabled": false } ] }, "method": "DELETE", "header": [], "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." }, "response": [] }, { "name": "/api/latest/result", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result", "query": [ { "key": "includeAllStates", "value": "{{includeAllStates}}", "disabled": true, "description": "return build results in all lifecycle states, including unknown and active states" }, { "key": "continuable", "value": "{{continuable}}", "disabled": true, "description": "filter only results that may be continued (stopped on Manual Stage)" }, { "key": "expand", "value": "{{expand}}", "disabled": true, "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" }, { "key": "issueKey", "value": "{{issueKey}}", "disabled": true, "description": "Filter by comma separated list of Jira issue key related to result" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "maximum size for returned list" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "start index for results list (zero based)" }, { "key": "label", "value": "{{label}}", "disabled": true, "description": "Filter by comma separated list of labels" }, { "key": "buildstate", "value": "{{buildstate}}", "disabled": true, "description": "filter results by state, valid values are Unknown, Successful, Failed" }, { "key": "favourite", "value": "{{favourite}}", "disabled": true, "description": "Filters build results list to show only results for favourite plans. Works only for authenticated user" }, { "key": "lifeCycleState", "value": "{{lifeCycleState}}", "disabled": true, "description": "return build results in given lifecycle state, valid values are Pending, Queued, InProgress, Finished, NotBuilt (multiple values can be separated by a comma)" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide list of the latest build results for top level plans visible for users." }, "response": [] }, { "name": "/api/latest/result/byChangeset/{csid}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/byChangeset/:csid", "query": [], "variable": [ { "key": "csid", "value": "{{csid}}", "description": "changeset id related to build result", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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." }, "response": [] }, { "name": "/api/latest/result/byCheckoutChangeset/{csid}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/byCheckoutChangeset/:csid", "query": [], "variable": [ { "key": "csid", "value": "{{csid}}", "description": "checkout changeset id related to build result", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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." }, "response": [] }, { "name": "/api/latest/result/status/{projectKey}-{buildKey}-{buildNumber}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/status/:projectKey-:buildKey-:buildNumber", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (must be a plan key, not a job key)", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number (numeric value only, 'latest' keyword is not supported for this method)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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." }, "response": [] }, { "name": "/api/latest/result/{projectKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey", "query": [ { "key": "includeAllStates", "value": "{{includeAllStates}}", "disabled": true, "description": "return build results in all lifecycle states, including unknown and active states" }, { "key": "continuable", "value": "{{continuable}}", "disabled": true, "description": "filter only results that may be continued (stopped on Manual Stage)" }, { "key": "expand", "value": "{{expand}}", "disabled": true, "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" }, { "key": "issueKey", "value": "{{issueKey}}", "disabled": true, "description": "Filter by comma separated list of Jira issue key related to result" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "Maximum size for returned list" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index for results list (zero based)" }, { "key": "label", "value": "{{label}}", "disabled": true, "description": "Filter by comma separated list of labels" }, { "key": "buildstate", "value": "{{buildstate}}", "disabled": true, "description": "filter results by state, valid values are Unknown, Successful, Failed" }, { "key": "favourite", "value": "{{favourite}}", "disabled": true, "description": "Filters build results list to show only results for favourite plans. Works only for authenticated user" }, { "key": "lifeCycleState", "value": "{{lifeCycleState}}", "disabled": true, "description": "return build results in given lifecycle state, valid values are Pending, Queued, InProgress, Finished, NotBuilt (multiple values can be separated by a comma)" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key to filter plan result list", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide list of latest build results for top level plans for specified project. List of results is limited to plans visible for user." }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey", "query": [ { "key": "includeAllStates", "value": "{{includeAllStates}}", "disabled": true, "description": "return build results in all lifecycle states, including unknown and active states" }, { "key": "continuable", "value": "{{continuable}}", "disabled": true, "description": "filter only results that may be continued (stopped on Manual Stage)" }, { "key": "expand", "value": "{{expand}}", "disabled": true, "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" }, { "key": "issueKey", "value": "{{issueKey}}", "disabled": true, "description": "Filter by comma separated list of Jira issue key related to result" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "Maximum size for returned list" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index for results list (zero based)" }, { "key": "label", "value": "{{label}}", "disabled": true, "description": "Filter by comma separated list of labels" }, { "key": "buildstate", "value": "{{buildstate}}", "disabled": true, "description": "filter results by state, valid values are Unknown, Successful, Failed" }, { "key": "favourite", "value": "{{favourite}}", "disabled": true, "description": "Filters build results list to show only results for favourite plans. Works only for authenticated user" }, { "key": "lifeCycleState", "value": "{{lifeCycleState}}", "disabled": true, "description": "return build results in given lifecycle state, valid values are Pending, Queued, InProgress, Finished, NotBuilt (multiple values can be separated by a comma)" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (might be simply planKey or composite planKey-jobKey)", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide list of build results for specified plan. Plan might be top level plan (projectKey-planKey) or job plan (projectKey-planKey-jobKey)." }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}-{buildNumber}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey-:buildNumber", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "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" }, { "key": "buildPositions", "value": "{{buildPositions}}", "disabled": true, "description": "in case of PENDING or QUEUED state expands build result queue position" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (might be simply planKey or composite planKey-jobKey)", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number may be specified as *latest* for the result with the highest build number", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide build result specified by projectKey-buildKey-buildNumber." }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/comment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey-:buildNumber/comment", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (might be simply planKey or composite planKey-jobKey)", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number may be specified as *latest* for the result with the highest build number", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide list of comments for build result specified by projectKey-buildKey-buildNumber." }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/comment", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey-:buildNumber/comment", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (might be simply planKey or composite planKey-jobKey)", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds new comment to build result.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/comment/{commentId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey-:buildNumber/comment/:commentId", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (might be simply planKey or composite planKey-jobKey)", "disabled": false }, { "key": "commentId", "value": "{{commentId}}", "description": "id of the comment", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Removes a comment from a build result." }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/label", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey-:buildNumber/label", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (must be a plan key, not a job key)", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number may be specified as \"latest\" for the result with the highest build number", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide list of labels for build result specified by projectKey-buildKey-buildNumber." }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/label", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey-:buildNumber/label", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (must be a plan key, not a job key)", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number may be specified as *latest* for the result with the highest build number", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds new label to build result specified by projectKey-buildKey-buildNumber.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}-{buildNumber}/label/{labelName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey-:buildNumber/label/:labelName", "query": [], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (must be a plan key, not a job key)", "disabled": false }, { "key": "labelName", "value": "{{labelName}}", "description": "Label name to remove from build result", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number may be specified as *latest* for the result with the highest build number", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Removes label from build result specified by projectKey-buildKey-buildNumber." }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}/branch/{branchName}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey/branch/:branchName", "query": [ { "key": "includeAllStates", "value": "{{includeAllStates}}", "disabled": true, "description": "return build results in all lifecycle states, including unknown and active states" }, { "key": "continuable", "value": "{{continuable}}", "disabled": true, "description": "filter only results that may be continued (stopped on Manual Stage)" }, { "key": "issueKey", "value": "{{issueKey}}", "disabled": true, "description": "Filter by comma separated list of Jira issue key related to result" }, { "key": "max-results", "value": "{{max-results}}", "disabled": true, "description": "Maximum size for returned list" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index for results list (zero based)" }, { "key": "label", "value": "{{label}}", "disabled": true, "description": "Filter by comma separated list of labels" }, { "key": "buildstate", "value": "{{buildstate}}", "disabled": true, "description": "filter results by state, valid values are Unknown, Successful, Failed" }, { "key": "favourite", "value": "{{favourite}}", "disabled": true, "description": "Filters build results list to show only results for favourite plans. Works only for authenticated user" }, { "key": "expand", "value": "{{expand}}", "disabled": true, "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." }, { "key": "lifeCycleState", "value": "{{lifeCycleState}}", "disabled": true, "description": "return build results in given lifecycle state, valid values are Pending, Queued, InProgress, Finished, NotBuilt (multiple values can be separated by a comma)" } ], "variable": [ { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (might be simply planKey or composite planKey-jobKey)", "disabled": false }, { "key": "branchName", "value": "{{branchName}}", "description": "Branch name", "disabled": false }, { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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)." }, "response": [] }, { "name": "/api/latest/result/{projectKey}-{buildKey}/{buildNumber}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/result/:projectKey-:buildKey/:buildNumber", "query": [ { "key": "expand", "value": "{{expand}}", "disabled": true, "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" } ], "variable": [ { "key": "projectKey", "value": "{{projectKey}}", "description": "project key", "disabled": false }, { "key": "buildKey", "value": "{{buildKey}}", "description": "plan key (might be simply planKey or composite planKey-jobKey)", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "Build number may be specified as *latest* for the result with the highest build number", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Provide build result specified by projectKey-buildKey-buildNumber." }, "response": [] }, { "name": "/api/latest/search/authors", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/search/authors", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of returned elements" }, { "key": "unlinkedOnly", "value": "{{unlinkedOnly}}", "disabled": true, "description": "if true will only include authors which are not currently linked to a user" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": false, "description": "The term to search for in authors" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "A starts-with search of authors based on their author name." }, "response": [] }, { "name": "/api/latest/search/branches", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/search/branches", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of returned elements" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "The term to search for in branches" }, { "key": "includeMasterBranch", "value": "{{includeMasterBranch}}", "disabled": true, "description": "Should master branch be included into result" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index" }, { "key": "branchNameOnly", "value": "{{branchNameOnly}}", "disabled": true, "description": "Whether the search should only use branch names of plan branches. Default includes the VCS branch name into the fuzzy search" }, { "key": "fuzzy", "value": "{{fuzzy}}", "disabled": true, "description": "Whether the search should be more relaxed when matching results. Default is false" }, { "key": "masterPlanKey", "value": "{{masterPlanKey}}", "disabled": false, "description": "planKey for plan where branches will be searched for" }, { "key": "releasedInDeployment", "value": "{{releasedInDeployment}}", "disabled": true, "description": "id of deployment project - will return only branches that are released in this deployment" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Performs a \"starts with\" search against full plan branch name and full plan branch key. Branches are restricted to \"masterPlanKey\" plan." }, "response": [] }, { "name": "/api/latest/search/deployments", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/search/deployments", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of returned elements" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "The term to search for in projects" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index" }, { "key": "permission", "value": "{{permission}}", "disabled": true, "description": "Only return those deployment projects that querying user has permission to. Default is READ" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Performs a contains search against deployment project name." }, "response": [] }, { "name": "/api/latest/search/jobs/{planKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/search/jobs/:planKey", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of returned elements" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "The term to search for in jobs" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index" } ], "variable": [ { "key": "planKey", "value": "{{planKey}}", "description": "planKey for plan where jobs will be searched for", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Performs a \"starts with\" search against full job name and full job key." }, "response": [] }, { "name": "/api/latest/search/plans", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/search/plans", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of returned elements" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "The term to search for in plans" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index" }, { "key": "permission", "value": "{{permission}}", "disabled": true, "description": "Only return those plans that querying user has permission to. Default is READ" }, { "key": "type", "value": "{{type}}", "disabled": true, "description": "Type of the plan to return" }, { "key": "fuzzy", "value": "{{fuzzy}}", "disabled": true, "description": "Whether the search should be more relaxed when matching results. Default is false" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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" }, "response": [] }, { "name": "/api/latest/search/projects", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/search/projects", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of returned elements" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "The term to search for in projects" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index" }, { "key": "permission", "value": "{{permission}}", "disabled": true, "description": "only return those projects that querying user has permission to. Default is READ" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Performs a contains search against project name." }, "response": [] }, { "name": "/api/latest/search/stages/{planKey}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/search/stages/:planKey", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of returned elements" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "The term to search for in stages" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index" }, { "key": "stageId", "value": "{{stageId}}", "disabled": true, "description": "Stage id" } ], "variable": [ { "key": "planKey", "value": "{{planKey}}", "description": "planKey for plan where stages will be searched for", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Performs a \"starts with\" search against full stage name." }, "response": [] }, { "name": "/api/latest/search/users", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/search/users", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of returned elements" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": false, "description": "The term to search for in users" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "A starts-with search of users based on their username, full-name and if allowed email address." }, "response": [] }, { "name": "/api/latest/search/versions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/search/versions", "query": [ { "key": "max-result", "value": "{{max-result}}", "disabled": true, "description": "Maximum count of returned elements" }, { "key": "branchKey", "value": "{{branchKey}}", "disabled": true, "description": "Narrow the search to releases created out of the branch" }, { "key": "searchTerm", "value": "{{searchTerm}}", "disabled": true, "description": "The term to search for in projects" }, { "key": "start-index", "value": "{{start-index}}", "disabled": true, "description": "Start index" }, { "key": "deploymentProjectId", "value": "{{deploymentProjectId}}", "disabled": false, "description": "The deployment project to search under" }, { "key": "chronologicalOrder", "value": "{{chronologicalOrder}}", "disabled": true, "description": "Sort releases by creation date" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Performs a contains search against a version name." }, "response": [] }, { "name": "/api/latest/server", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/server", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get both the asked node and cluster states." }, "response": [] }, { "name": "/api/latest/server/nodes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/server/nodes", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get both the asked node and cluster states together with all nodes' statuses." }, "response": [] }, { "name": "/api/latest/server/pause", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/server/pause", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Pauses the cluster." }, "response": [] }, { "name": "/api/latest/server/prepareForRestart", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/server/prepareForRestart", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Prepare the asked node for restarting: suspend change detection, stop indexing, stop ec2 instance ordering etc." }, "response": [] }, { "name": "/api/latest/server/resume", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/server/resume", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Resumes the cluster." }, "response": [] }, { "name": "/api/latest/status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/status", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "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." }, "response": [] }, { "name": "/api/latest/websudo-session", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/websudo-session", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the web sudo expiry from session." }, "response": [] }, { "name": "/api/latest/websudo-session", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/websudo-session", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Refresh the web sudo expiry for the current session." }, "response": [] }, { "name": "/api/latest/websudo-session", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}api/latest/websudo-session", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Remove web sudo from session." }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "http" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "api.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "%7Bbaseurl%7D/rest/" } ] }