config/RestApis/ado.json
|
{ "GeneralInfo": { "Name": "ADO", "Description": "Azure DevOps Rest API", "AuthorizationType": "EncryptBasicToken", "version": "5.1", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/?view=azure-devops-rest-5.1" }, "Services": { "Accounts": [ { "Operation": "Accounts - List", "Method": "GET", "Uri": "https://app.vssps.visualstudio.com/_apis/accounts?api-version=6.1-preview.1", "Description": "Get a list of accounts for a specific owner or a specific member.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/account/accounts/list?view=azure-devops-rest-6.1" } ], "Audit": [ { "Operation": "Actions - List", "Method": "GET", "Uri": "https://auditservice.dev.azure.com/{organization}/_apis/audit/actions?api-version=6.1-preview.1", "Description": "Get all auditable actions filterable by area.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/actions/list?view=azure-devops-rest-6.1" }, { "Operation": "Audit Log - Query", "Method": "GET", "Uri": "https://auditservice.dev.azure.com/{organization}/_apis/audit/auditlog?api-version=6.1-preview.1", "Description": "Queries audit log entries", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/audit%20log/query?view=azure-devops-rest-6.1" }, { "Operation": "Download Log - Download Log", "Method": "GET", "Uri": "https://auditservice.dev.azure.com/{organization}/_apis/audit/downloadlog?format={format}&api-version=6.1-preview.1", "Description": "Downloads audit log entries.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/download%20log/download%20log?view=azure-devops-rest-6.1" }, { "Operation": "Streams - Create", "Method": "POST", "Uri": "https://auditservice.dev.azure.com/{organization}/_apis/audit/streams?daysToBackfill={daysToBackfill}&api-version=6.1-preview.1", "Description": "Create new Audit Stream", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/streams/create?view=azure-devops-rest-6.1" }, { "Operation": "Streams - Delete", "Method": "DELETE", "Uri": "https://auditservice.dev.azure.com/{organization}/_apis/audit/streams/{streamId}?api-version=6.1-preview.1", "Description": "Delete Audit Stream", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/streams/delete?view=azure-devops-rest-6.1" }, { "Operation": "Streams - Query All Streams", "Method": "GET", "Uri": "https://auditservice.dev.azure.com/{organization}/_apis/audit/streams?api-version=6.1-preview.1", "Description": "Return all Audit Streams scoped to an organization", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/streams/query%20all%20streams?view=azure-devops-rest-6.1" }, { "Operation": "Streams - Query Stream By Id", "Method": "GET", "Uri": "https://auditservice.dev.azure.com/{organization}/_apis/audit/streams/{streamId}?api-version=6.1-preview.1", "Description": "Return Audit Stream with id of streamId if one exists otherwise throw", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/streams/query%20stream%20by%20id?view=azure-devops-rest-6.1" }, { "Operation": "Streams - Update Status", "Method": "PUT", "Uri": "https://auditservice.dev.azure.com/{organization}/_apis/audit/streams/{streamId}?status={status}&api-version=6.1-preview.1", "Description": "Update existing Audit Stream status", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/streams/update%20status?view=azure-devops-rest-6.1" }, { "Operation": "Streams - Update Stream", "Method": "PUT", "Uri": "https://auditservice.dev.azure.com/{organization}/_apis/audit/streams?api-version=6.1-preview.1", "Description": "Update existing Audit Stream", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/audit/streams/update%20stream?view=azure-devops-rest-6.1" } ], "Build": [ { "Operation": "Artifacts - Create", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/artifacts?api-version=6.1-preview.5", "Description": "Associates an artifact with a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/artifacts/create?view=azure-devops-rest-6.1" }, { "Operation": "Artifacts - Get Artifact", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/artifacts?artifactName={artifactName}&api-version=6.1-preview.5", "Description": "Gets a specific artifact for a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/artifacts/get%20artifact?view=azure-devops-rest-6.1" }, { "Operation": "Artifacts - Get File", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/artifacts?artifactName={artifactName}&fileId={fileId}&fileName={fileName}&api-version=6.1-preview.5", "Description": "Gets a file from the build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/artifacts/get%20file?view=azure-devops-rest-6.1" }, { "Operation": "Artifacts - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/artifacts?api-version=6.1-preview.5", "Description": "Gets all artifacts for a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/artifacts/list?view=azure-devops-rest-6.1" }, { "Operation": "Attachments - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/{timelineId}/{recordId}/attachments/{type}/{name}?api-version=6.1-preview.2", "Description": "Gets a specific attachment.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/attachments/get?view=azure-devops-rest-6.1" }, { "Operation": "Attachments - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/attachments/{type}?api-version=6.1-preview.2", "Description": "Gets the list of attachments of a specific type that are associated with a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/attachments/list?view=azure-devops-rest-6.1" }, { "Operation": "Authorizedresources - Authorize Project Resources", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/authorizedresources?api-version=6.1-preview.1", "Description": "", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/authorizedresources/authorize%20project%20resources?view=azure-devops-rest-6.1" }, { "Operation": "Authorizedresources - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/authorizedresources?api-version=6.1-preview.1", "Description": "", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/authorizedresources/list?view=azure-devops-rest-6.1" }, { "Operation": "Badge - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/public/build/definitions/{project}/{definitionId}/badge?api-version=6.1-preview.2", "Description": "This endpoint is deprecated. Please see the Build Status REST endpoint.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/badge/get?view=azure-devops-rest-6.1" }, { "Operation": "Badge - Get Build Badge Data", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/repos/{repoType}/badge?api-version=6.1-preview.2", "Description": "Gets a badge that indicates the status of the most recent build for the specified branch.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/badge/get%20build%20badge%20data?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}?api-version=6.1-preview.6", "Description": "Deletes a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/delete?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}?api-version={version}", "Description": "Gets a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get?view=azure-devops-rest-5.1" }, { "Operation": "Builds - Get Build Changes", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/changes?api-version=6.1-preview.2", "Description": "Gets the changes associated with a build", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get%20build%20changes?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Get Build Log", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/logs/{logId}?api-version=6.1-preview.2", "Description": "Gets an individual log file for a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get%20build%20log?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Get Build Logs", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/logs?api-version=6.1-preview.2", "Description": "Gets the logs for a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get%20build%20logs?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Get Build Work Items Refs", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/workitems?api-version=6.1-preview.2", "Description": "Gets the work items associated with a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get%20build%20work%20items%20refs?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Get Build Work Items Refs From Commits", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/workitems?api-version=6.1-preview.2", "Description": "Gets the work items associated with a build, filtered to specific commits.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get%20build%20work%20items%20refs%20from%20commits?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Get Changes Between Builds", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/changes?api-version=6.1-preview.2", "Description": "Gets the changes made to the repository between two given builds.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get%20changes%20between%20builds?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Get Work Items Between Builds", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/workitems?fromBuildId={fromBuildId}&toBuildId={toBuildId}&api-version=6.1-preview.2", "Description": "Gets all the work items between two builds.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/get%20work%20items%20between%20builds?view=azure-devops-rest-6.1" }, { "Operation": "Builds - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version={version}", "Description": "Gets a list of builds.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/list?view=azure-devops-rest-5.1" }, { "Operation": "Builds - Queue", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=6.1-preview.6", "Description": "Queues a build", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/queue?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Update Build", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}?api-version=6.1-preview.6", "Description": "Updates a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/update%20build?view=azure-devops-rest-6.1" }, { "Operation": "Builds - Update Builds", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds?api-version=6.1-preview.6", "Description": "Updates multiple builds.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/builds/update%20builds?view=azure-devops-rest-6.1" }, { "Operation": "Controllers - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/build/controllers/{controllerId}?api-version=6.1-preview.2", "Description": "Gets a controller", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/controllers/get?view=azure-devops-rest-6.1" }, { "Operation": "Controllers - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/build/controllers?api-version=6.1-preview.2", "Description": "Gets controller, optionally filtered by name", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/controllers/list?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - Create", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions?api-version={version}", "Description": "Creates a new definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/create?view=azure-devops-rest-5.1" }, { "Operation": "Definitions - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}?api-version=6.1-preview.7", "Description": "Deletes a definition and all associated builds.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/delete?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}?revision?api-version={version}", "Description": "Gets a definition, returns the latest revision.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/get?view=azure-devops-rest-5.1" }, { "Operation": "Definitions - Get Definition Revisions", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/revisions?api-version=6.1-preview.3", "Description": "Gets all revisions of a definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/get%20definition%20revisions?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - Get Definition Yaml", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}?dummyValue={dummyValue}&api-version=6.1-preview.7", "Description": "", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/get%20definition%20yaml?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions?{version}", "Description": "Gets a list of definitions.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/list?view=azure-devops-rest-5.1" }, { "Operation": "Definitions - Restore Definition", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}?deleted={deleted}&api-version=6.1-preview.7", "Description": "Restores a deleted definition", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/restore%20definition?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - Update", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}?api-version=6.1-preview.7", "Description": "Updates an existing build definition. In order for this operation to succeed, the value of the 'Revision' property of the request body must match the existing build definition's. It is recommended that you obtain the existing build definition by using GET, modify the build definition as necessary, and then submit the modified definition with PUT.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/definitions/update?view=azure-devops-rest-6.1" }, { "Operation": "Folders - Create", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/folders?path={path}&api-version=6.1-preview.2", "Description": "Creates a new folder.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/folders/create?view=azure-devops-rest-6.1" }, { "Operation": "Folders - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/folders?path={path}&api-version=6.1-preview.2", "Description": "Deletes a definition folder. Definitions and their corresponding builds will also be deleted.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/folders/delete?view=azure-devops-rest-6.1" }, { "Operation": "Folders - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/folders/{path}?api-version=6.1-preview.2", "Description": "Gets a list of build definition folders.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/folders/list?view=azure-devops-rest-6.1" }, { "Operation": "Folders - Update", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/folders?path={path}&api-version=6.1-preview.2", "Description": "Updates an existing folder at given existing path", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/folders/update?view=azure-devops-rest-6.1" }, { "Operation": "General Settings - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/generalsettings?api-version=6.1-preview.1", "Description": "Gets pipeline general settings.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/general%20settings/get?view=azure-devops-rest-6.1" }, { "Operation": "General Settings - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/generalsettings?api-version=6.1-preview.1", "Description": "Updates pipeline general settings.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/general%20settings/update?view=azure-devops-rest-6.1" }, { "Operation": "History - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/build/retention/history?api-version=6.1-preview.1", "Description": "Returns the retention history for the project collection. This includes pipelines that have custom retention rules that may prevent the retention job from cleaning them up, runs per pipeline with retention type, files associated with pipelines owned by the collection with retention type, and the number of files per pipeline.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/history/get?view=azure-devops-rest-6.1" }, { "Operation": "Latest - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/latest/{definition}?api-version=6.1-preview.1", "Description": "Gets the latest build for a definition, optionally scoped to a specific branch.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/latest/get?view=azure-devops-rest-6.1" }, { "Operation": "Leases - Add", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=6.1-preview.1", "Description": "Adds new leases for pipeline runs.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/leases/add?view=azure-devops-rest-6.1" }, { "Operation": "Leases - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?ids={ids}&api-version=6.1-preview.1", "Description": "Removes specific retention leases.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/leases/delete?view=azure-devops-rest-6.1" }, { "Operation": "Leases - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases/{leaseId}?api-version=6.1-preview.1", "Description": "Returns the details of the retention lease given a lease id.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/leases/get?view=azure-devops-rest-6.1" }, { "Operation": "Leases - Get Retention Leases By Minimal Retention Leases", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?leasesToFetch={leasesToFetch}&api-version=6.1-preview.1", "Description": "Returns any leases matching the specified MinimalRetentionLeases", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/leases/get%20retention%20leases%20by%20minimal%20retention%20leases?view=azure-devops-rest-6.1" }, { "Operation": "Leases - Get Retention Leases By Owner Id", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?api-version=6.1-preview.1", "Description": "Returns any leases owned by the specified entity, optionally scoped to a single pipeline definition and run.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/leases/get%20retention%20leases%20by%20owner%20id?view=azure-devops-rest-6.1" }, { "Operation": "Leases - Get Retention Leases By User Id", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/retention/leases?userOwnerId={userOwnerId}&api-version=6.1-preview.1", "Description": "Returns any leases owned by the specified user, optionally scoped to a single pipeline definition and run.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/leases/get%20retention%20leases%20by%20user%20id?view=azure-devops-rest-6.1" }, { "Operation": "Metrics - Get Definition Metrics", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/metrics?api-version=6.1-preview.1", "Description": "Gets build metrics for a definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/metrics/get%20definition%20metrics?view=azure-devops-rest-6.1" }, { "Operation": "Metrics - Get Project Metrics", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/metrics/{metricAggregationType}?api-version=6.1-preview.1", "Description": "Gets build metrics for a project.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/metrics/get%20project%20metrics?view=azure-devops-rest-6.1" }, { "Operation": "Options - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/options?api-version=6.1-preview.2", "Description": "Gets all build definition options supported by the system.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/options/list?view=azure-devops-rest-6.1" }, { "Operation": "Properties - Get Build Properties", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/properties?api-version=6.1-preview.1", "Description": "Gets properties for a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/properties/get%20build%20properties?view=azure-devops-rest-6.1" }, { "Operation": "Properties - Get Definition Properties", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/properties?api-version=6.1-preview.1", "Description": "Gets properties for a definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/properties/get%20definition%20properties?view=azure-devops-rest-6.1" }, { "Operation": "Properties - Update Build Properties", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/properties?api-version=6.1-preview.1", "Description": "Updates properties for a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/properties/update%20build%20properties?view=azure-devops-rest-6.1" }, { "Operation": "Properties - Update Definition Properties", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/properties?api-version=6.1-preview.1", "Description": "Updates properties for a definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/properties/update%20definition%20properties?view=azure-devops-rest-6.1" }, { "Operation": "Report - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/report?api-version=6.1-preview.2", "Description": "Gets a build report.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/report/get?view=azure-devops-rest-6.1" }, { "Operation": "Resource Usage - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/build/resourceusage?api-version=6.1-preview.2", "Description": "Gets information about build resources in the system.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/resource%20usage/get?view=azure-devops-rest-6.1" }, { "Operation": "Resources - Authorize Definition Resources", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/resources?api-version=6.1-preview.1", "Description": "", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/resources/authorize%20definition%20resources?view=azure-devops-rest-6.1" }, { "Operation": "Resources - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{definitionId}/resources?api-version=6.1-preview.1", "Description": "", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/resources/list?view=azure-devops-rest-6.1" }, { "Operation": "Retention - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/retention?api-version=6.1-preview.1", "Description": "Gets the project's retention settings.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/retention/get?view=azure-devops-rest-6.1" }, { "Operation": "Retention - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/retention?api-version=6.1-preview.1", "Description": "Updates the project's retention settings.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/retention/update?view=azure-devops-rest-6.1" }, { "Operation": "Settings - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/settings?api-version=6.1-preview.1", "Description": "Gets the build settings.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/settings/get?view=azure-devops-rest-6.1" }, { "Operation": "Settings - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/settings?api-version=6.1-preview.1", "Description": "Updates the build settings.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/settings/update?view=azure-devops-rest-6.1" }, { "Operation": "Source Providers - Get File Contents", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/filecontents?api-version=6.1-preview.1", "Description": "Gets the contents of a file in the given source code repository.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/get%20file%20contents?view=azure-devops-rest-6.1" }, { "Operation": "Source Providers - Get Path Contents", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/pathcontents?api-version=6.1-preview.1", "Description": "Gets the contents of a directory in the given source code repository.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/get%20path%20contents?view=azure-devops-rest-6.1" }, { "Operation": "Source Providers - Get Pull Request", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/pullrequests/{pullRequestId}?api-version=6.1-preview.1", "Description": "Gets a pull request object from source provider.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/get%20pull%20request?view=azure-devops-rest-6.1" }, { "Operation": "Source Providers - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/sourceproviders?api-version=6.1-preview.1", "Description": "Get a list of source providers and their capabilities.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/list?view=azure-devops-rest-6.1" }, { "Operation": "Source Providers - List Branches", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/branches?api-version=6.1-preview.1", "Description": "Gets a list of branches for the given source code repository.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/list%20branches?view=azure-devops-rest-6.1" }, { "Operation": "Source Providers - List Repositories", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/repositories?api-version=6.1-preview.1", "Description": "Gets a list of source code repositories.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/list%20repositories?view=azure-devops-rest-6.1" }, { "Operation": "Source Providers - List Webhooks", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/webhooks?api-version=6.1-preview.1", "Description": "Gets a list of webhooks installed in the given source code repository.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/list%20webhooks?view=azure-devops-rest-6.1" }, { "Operation": "Source Providers - Restore Webhooks", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/sourceProviders/{providerName}/webhooks?api-version=6.1-preview.1", "Description": "Recreates the webhooks for the specified triggers in the given source code repository.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/source%20providers/restore%20webhooks?view=azure-devops-rest-6.1" }, { "Operation": "Stages - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/stages/{stageRefName}?api-version=6.1-preview.1", "Description": "Update a build stage", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/stages/update?view=azure-devops-rest-6.1" }, { "Operation": "Status - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/status/{definition}?api-version=6.1-preview.1", "Description": "Gets the build status for a definition, optionally scoped to a specific branch, stage, job, and configuration. If there are more than one, then it is required to pass in a stageName value when specifying a jobName, and the same rule then applies for both if passing a configuration parameter.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/status/get?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Add Build Tag", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/tags/{tag}?api-version=6.1-preview.2", "Description": "Adds a tag to a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/add%20build%20tag?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Add Build Tags", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/tags?api-version=6.1-preview.2", "Description": "Adds tags to a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/add%20build%20tags?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Add Definition Tag", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags/{tag}?api-version=6.1-preview.2", "Description": "Adds a tag to a definition", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/add%20definition%20tag?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Add Definition Tags", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags?api-version=6.1-preview.2", "Description": "Adds multiple tags to a definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/add%20definition%20tags?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Add Definition Tags", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags?api-version=6.1-preview.2", "Description": "Adds multiple tags to a definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/add%20definition%20tags?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Delete Build Tag", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/tags/{tag}?api-version=6.1-preview.2", "Description": "Removes a tag from a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/delete%20build%20tag?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Delete Definition Tag", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags/{tag}?api-version=6.1-preview.2", "Description": "Removes a tag from a definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/delete%20definition%20tag?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Delete Tag", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/tags/{tag}?api-version=6.1-preview.2", "Description": "Removes a tag from builds, definitions, and from the tag store", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/delete%20tag?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Get Build Tags", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/tags?api-version=6.1-preview.2", "Description": "Gets the tags for a build.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/get%20build%20tags?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Get Definition Tags", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/{DefinitionId}/tags?api-version=6.1-preview.2", "Description": "Gets the tags for a definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/get%20definition%20tags?view=azure-devops-rest-6.1" }, { "Operation": "Tags - Get Tags", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/tags?api-version=6.1-preview.2", "Description": "Gets a list of all build tags in the project.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/tags/get%20tags?view=azure-devops-rest-6.1" }, { "Operation": "Templates - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/templates/{templateId}?api-version=6.1-preview.3", "Description": "Deletes a build definition template.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/templates/delete?view=azure-devops-rest-6.1" }, { "Operation": "Templates - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/templates/{templateId}?api-version=6.1-preview.3", "Description": "Gets a specific build definition template.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/templates/get?view=azure-devops-rest-6.1" }, { "Operation": "Templates - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/templates?api-version=6.1-preview.3", "Description": "Gets all definition templates.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/templates/list?view=azure-devops-rest-6.1" }, { "Operation": "Templates - Save Template", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/definitions/templates/{templateId}?api-version=6.1-preview.3", "Description": "Updates an existing build definition template.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/templates/save%20template?view=azure-devops-rest-6.1" }, { "Operation": "Timeline - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/build/builds/{buildId}/timeline/{timelineId}?api-version=6.1-preview.2", "Description": "Gets details for a build", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/build/timeline/get?view=azure-devops-rest-6.1" } ], "Descriptors": [ { "Operation": "Descriptors - Get", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/descriptors/{storageKey}?api-version=6.0-preview.1", "Description": "Resolve a storage key to a descriptor", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/descriptors/get?view=azure-devops-rest-6.0" } ], "Distributed Task": [ { "Operation": "Agents - Add", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents?api-version=6.1-preview.1", "Description": "Adds an agent to a pool. You probably don't want to call this endpoint directly. Instead, configure an agent using the agent download package.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/add?view=azure-devops-rest-6.1" }, { "Operation": "Agents - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId}?api-version=6.1-preview.1", "Description": "Delete an agent. You probably don't want to call this endpoint directly. Instead, use the agent configuration script to remove an agent from your organization.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/delete?view=azure-devops-rest-6.1" }, { "Operation": "Agents - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId}?api-version=6.1-preview.1", "Description": "Get information about an agent.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/get?view=azure-devops-rest-6.1" }, { "Operation": "Agents - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents?api-version=6.1-preview.1", "Description": "Get a list of agents.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/list?view=azure-devops-rest-6.1" }, { "Operation": "Agents - Replace Agent", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId}?api-version=6.1-preview.1", "Description": "Replace an agent. You probably don't want to call this endpoint directly. Instead, use the agent configuration script to remove and reconfigure an agent from your organization.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/replace%20agent?view=azure-devops-rest-6.1" }, { "Operation": "Agents - Update", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents/{agentId}?api-version=6.1-preview.1", "Description": "Update agent details.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/update?view=azure-devops-rest-6.1" }, { "Operation": "Deploymentgroups - Add", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups?api-version=6.1-preview.1", "Description": "Create a deployment group.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/deploymentgroups/add?view=azure-devops-rest-6.1" }, { "Operation": "Deploymentgroups - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=6.1-preview.1", "Description": "Delete a deployment group.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/deploymentgroups/delete?view=azure-devops-rest-6.1" }, { "Operation": "Deploymentgroups - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=6.1-preview.1", "Description": "Get a deployment group by its ID.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/deploymentgroups/get?view=azure-devops-rest-6.1" }, { "Operation": "Deploymentgroups - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups?api-version=6.1-preview.1", "Description": "Get a list of deployment groups by name or IDs.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/deploymentgroups/list?view=azure-devops-rest-6.1" }, { "Operation": "Deploymentgroups - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/deploymentgroups/{deploymentGroupId}?api-version=6.1-preview.1", "Description": "Update a deployment group.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/deploymentgroups/update?view=azure-devops-rest-6.1" }, { "Operation": "Environments - Add", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments?api-version=6.1-preview.1", "Description": "Create an environment.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/environments/add?view=azure-devops-rest-6.1" }, { "Operation": "Environments - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}?api-version=6.1-preview.1", "Description": "Delete the specified environment.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/environments/delete?view=azure-devops-rest-6.1" }, { "Operation": "Environments - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}?api-version=6.1-preview.1", "Description": "Get an environment by its ID.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/environments/get?view=azure-devops-rest-6.1" }, { "Operation": "Environments - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments?api-version=6.1-preview.1", "Description": "Get all environments.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/environments/list?view=azure-devops-rest-6.1" }, { "Operation": "Environments - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}?api-version=6.1-preview.1", "Description": "Update the specified environment.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/environments/update?view=azure-devops-rest-6.1" }, { "Operation": "Pools - Add", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools?api-version=6.1-preview.1", "Description": "Create an agent pool.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/add?view=azure-devops-rest-6.1" }, { "Operation": "Pools - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}?api-version=6.1-preview.1", "Description": "Delete an agent pool.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/delete?view=azure-devops-rest-6.1" }, { "Operation": "Pools - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}?api-version=6.1-preview.1", "Description": "Get information about an agent pool.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get?view=azure-devops-rest-6.1" }, { "Operation": "Pools - Get Agent Pools", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools?api-version=6.1-preview.1", "Description": "Get a list of agent pools.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get%20agent%20pools?view=azure-devops-rest-6.1" }, { "Operation": "Pools - Get Agent Pools By Ids", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools?poolIds={poolIds}&api-version=6.1-preview.1", "Description": "Get a list of agent pools.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get%20agent%20pools%20by%20ids?view=azure-devops-rest-6.1" }, { "Operation": "Pools - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}?api-version=6.1-preview.1", "Description": "Update properties on an agent pool", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/update?view=azure-devops-rest-6.1" }, { "Operation": "Virtualmachines - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}/providers/virtualmachinegroups/{resourceId}/virtualmachines?api-version=6.1-preview.1", "Description": "", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/virtualmachines/list?view=azure-devops-rest-6.1" }, { "Operation": "Virtualmachines - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}/providers/virtualmachinegroups/{resourceId}/virtualmachines?api-version=6.1-preview.1", "Description": "", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/virtualmachines/update?view=azure-devops-rest-6.1" } ], "Git": [ { "Operation": "Items - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?path={path}&api-version=6.0", "Description": "Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content, which is always returned as a download.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/items/get?view=azure-devops-rest-6.0" }, { "Operation": "Items - Get Items Batch", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/itemsbatch?api-version=6.0", "Description": "Post for retrieving a creating a batch out of a set of items in a repo / project given a list of paths or a long path", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/items/get%20items%20batch?view=azure-devops-rest-6.0" }, { "Operation": "Items - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/items?api-version=6.0", "Description": "Get Item Metadata and/or Content for a collection of items. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/items/list?view=azure-devops-rest-6.0" }, { "Operation": "Policy Configurations - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/policy/configurations?repositoryId={repositoryId}&api-version=6.1-preview.1", "Description": "Retrieve a list of policy configurations by a given set of scope/filtering criteria. See link for more information.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/policy%20configurations/get?view=azure-devops-rest-6.1" }, { "Operation": "Policy Configurations - Get All", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/policy/configurations?api-version=6.1-preview.1", "Description": "Retrieve a list of policy configurations by a given set of scope/filtering criteria. See link for more information.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/policy%20configurations/get?view=azure-devops-rest-6.1" }, { "Operation": "Pull Requests - Create", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?api-version=6.1-preview.1", "Description": "Create a pull request.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull%20requests/create?view=azure-devops-rest-6.1" }, { "Operation": "Pull Requests - Get Pull Request", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}?api-version=6.1-preview.1", "Description": "Retrieve a pull request.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull%20requests/get%20pull%20request?view=azure-devops-rest-6.1" }, { "Operation": "Pull Requests - Get Pull Request By Id", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/pullrequests/{pullRequestId}?api-version=6.1-preview.1", "Description": "Retrieve a pull request.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull%20requests/get%20pull%20request%20by%20id?view=azure-devops-rest-6.1" }, { "Operation": "Pull Requests - Get Pull Requests", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests?api-version=6.1-preview.1", "Description": "Retrieve all pull requests matching a specified criteria.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull%20requests/get%20pull%20requests?view=azure-devops-rest-6.1" }, { "Operation": "Pull Requests - Get Pull Requests By Project", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/pullrequests?api-version=6.1-preview.1", "Description": "Retrieve all pull requests matching a specified criteria.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull%20requests/get%20pull%20requests%20by%20project?view=azure-devops-rest-6.1" }, { "Operation": "Pull Requests - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullrequests/{pullRequestId}?api-version=6.1-preview.1", "Description": "Update a pull request", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull%20requests/update?view=azure-devops-rest-6.1" }, { "Operation": "Pull Request Work Items - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/workitems?api-version=6.1-preview.1", "Description": "Retrieve a list of work items associated with a pull request.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull%20request%20work%20items/list?view=azure-devops-rest-6.1" }, { "Operation": "Repositories - Create", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories?api-version=5.1{version}", "Description": "Create a git repository in a team project.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/repositories/create?view=azure-devops-rest-5.1" }, { "Operation": "Repositories - Get Repository", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}?api-version={version}", "Description": "Retrieve a git repository.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/repositories/get%20repository?view=azure-devops-rest-5.1" }, { "Operation": "Repositories - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories?api-version={version}", "Description": "Retrieve git repositories.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/repositories/list?view=azure-devops-rest-5.1" }, { "Operation": "Pull Request Reviewers - Create Pull Request Reviewer", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId}?api-version=6.0", "Description": "Add a reviewer to a pull request or cast a vote.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-reviewers/create-pull-request-reviewer?view=azure-devops-rest-6.0" }, { "Operation": "Pull Request Reviewers - Create Pull Request Reviewers", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers?api-version=6.0", "Description": "Add reviewers to a pull request.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-reviewers/create-pull-request-reviewers?view=azure-devops-rest-6.0" }, { "Operation": "Pull Request Reviewers - Create Unmaterialized Pull Request Reviewer", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers?api-version=6.0", "Description": "Add an unmaterialized identity to the reviewers of a pull request.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-reviewers/create-unmaterialized-pull-request-reviewer?view=azure-devops-rest-6.0" }, { "Operation": "Pull Request Reviewers - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId}?api-version=6.0", "Description": "Remove a reviewer from a pull request.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-reviewers/delete?view=azure-devops-rest-6.0" }, { "Operation": "Pull Request Reviewers - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId}?api-version=6.0", "Description": "Retrieve information about a particular reviewer on a pull request", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-reviewers/get?view=azure-devops-rest-6.0" }, { "Operation": "Pull Request Reviewers - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers?api-version=6.0", "Description": "Retrieve the reviewers for a pull request", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-reviewers/list?view=azure-devops-rest-6.0" }, { "Operation": "Pull Request Reviewers - Update Pull Request Reviewer", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers/{reviewerId}?api-version=6.0", "Description": "Edit a reviewer entry. These fields are patchable: isFlagged, hasDeclined", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-reviewers/update-pull-request-reviewer?view=azure-devops-rest-6.0" }, { "Operation": "Pull Request Reviewers - Update Pull Request Reviewers", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/git/repositories/{repositoryId}/pullRequests/{pullRequestId}/reviewers?api-version=6.0", "Description": "Reset the votes of multiple reviewers on a pull request. NOTE: This endpoint only supports updating votes, but does not support updating required reviewers (use policy) or display names.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/git/pull-request-reviewers/update-pull-request-reviewers?view=azure-devops-rest-6.0" } ], "Groups": [ { "Operation": "Groups - Create", "Method": "POST", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/groups?api-version=6.0-preview.1", "Description": "Create a new Azure DevOps group or materialize an existing AAD group.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/groups/create?view=azure-devops-rest-6.0" }, { "Operation": "Groups - Delete", "Method": "DELETE", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/groups/{groupDescriptor}?api-version=6.0-preview.1", "Description": "Removes an Azure DevOps group from all of its parent groups. The group will still be visible, but membership checks for the group, and all descendants which derive membership through it, will return false.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/groups/delete?view=azure-devops-rest-6.0" }, { "Operation": "Groups - Get", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/groups/{groupDescriptor}?api-version=6.0-preview.1", "Description": "Get a group by its descriptor. The group will be returned even if it has been deleted from the account or has had all its memberships deleted.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/groups/get?view=azure-devops-rest-6.0" }, { "Operation": "Groups - List", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/groups?api-version=6.0-preview.1", "Description": "Gets a list of all groups in the current scope (usually organization or account). The optional parameters are used to filter down the returned results. Returned results are in no guaranteed order. Since the list of groups may be large, results are returned in pages of groups. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/groups/list?view=azure-devops-rest-6.0" }, { "Operation": "Groups - List with Continuation Token", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/groups?continuationToken={continuationToken}&api-version=6.0-preview.1", "Description": "Gets a list of all groups in the current scope (usually organization or account). The optional parameters are used to filter down the returned results. Returned results are in no guaranteed order. Since the list of groups may be large, results are returned in pages of groups. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/groups/list?view=azure-devops-rest-6.0" } ], "Identities": [ { "Operation": "Identities - Read Identities", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/identities?api-version=7.1-preview.1", "Description": "Resolve legacy identity information for use with older APIs such as the Security APIs", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/ims/identities/read-identities?view=azure-devops-rest-7.1" } ], "Iterations": [ { "Operation": "List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations?api-version={version}", "Description": "Get a team's iterations using timeframe filter", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/work/iterations/list?view=azure-devops-rest-5.1" }, { "Operation": "Post Team Iteration", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/{team}/_apis/work/teamsettings/iterations?api-version={version}", "Description": "Add an iteration to the team.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/work/iterations/post%20team%20iteration?view=azure-devops-rest-5.1" } ], "Member Entitlement Management": [ { "Operation": "Group Entitlements - Get", "Method": "GET", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/groupentitlements/{groupId}?api-version=6.0-preview.1", "Description": "Get a group entitlement. If the group entitlement does not exist, returns null.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/group%20entitlements/get?view=azure-devops-rest-6.0" }, { "Operation": "Group Entitlements - Delete", "Method": "DELETE", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements/{userId}?api-version=6.0-preview.3", "Description": "Delete a user from the account. The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/delete?view=azure-devops-rest-6.0" }, { "Operation": "Group Entitlements - List", "Method": "GET", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/groupentitlements?api-version=6.1-preview.1", "Description": "Get the group entitlements for an account.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/group%20entitlements/list?view=azure-devops-rest-6.1" }, { "Operation": "Members - Add", "Method": "PUT", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/GroupEntitlements/{groupId}/members/{memberId}?api-version=6.0-preview.1", "Description": "Add a member to a Group.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/members/add?view=azure-devops-rest-6.0" }, { "Operation": "Members - Get", "Method": "GET", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/GroupEntitlements/{groupId}/members?api-version=6.1-preview.1", "Description": "Get direct members of a Group.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/members/get?view=azure-devops-rest-6.1" }, { "Operation": "Get User Entitlement", "Method": "GET", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements/{userId}?api-version=5.1-preview.2", "Description": "Get User Entitlement for a user.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/get%20user%20entitlement?view=azure-devops-rest-5.1" }, { "Operation": "Get User Entitlements", "Method": "GET", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements?api-version=5.1-preview.2", "Description": "Get a paged set of user entitlements matching the filter criteria. If no filter is is passed, a page from all the account users is returned.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/get%20user%20entitlements?view=azure-devops-rest-5.1" }, { "Operation": "User Entitlements - Add", "Method": "POST", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements?api-version=6.0-preview.3", "Description": "Add a user, assign license and extensions and make them a member of a project group in an account.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/add?view=azure-devops-rest-6.0" }, { "Operation": "User Entitlements - Delete", "Method": "DELETE", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements/{userId}?api-version=5.1-preview.2", "Description": "Delete a user from the account. The delete operation includes unassigning Extensions and Licenses and removing the user from all project memberships. The user would continue to have access to the account if she is member of an AAD group, that is added directly to the account.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/delete?view=azure-devops-rest-5.1" }, { "Operation": "User Entitlements - Get User Entitlements", "Method": "GET", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements?api-version=5.0-preview.2", "Description": "Get a paged set of user entitlements matching the filter criteria. If no filter is is passed, a page from all the account users is returned.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/get%20user%20entitlements?view=azure-devops-rest-5.0" }, { "Operation": "User Entitlements - Search User Entitlements", "Method": "GET", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements?api-version=6.0-preview.3", "Description": "Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/search%20user%20entitlements?view=azure-devops-rest-6.0" }, { "Operation": "User Entitlements - Search User Entitlements (by filter)", "Method": "GET", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements?select={select}&$filter={$filter}&api-version=6.0-preview.3", "Description": "Get a paged set of user entitlements matching the filter and sort criteria built with properties that match the select input.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/search%20user%20entitlements?view=azure-devops-rest-6.0" }, { "Operation": "User Entitlements - Update User Entitlement", "Method": "PATCH", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements/{userId}?api-version=6.0-preview.3", "Description": "Edit the entitlements (License, Extensions, Projects, Teams etc) for a user.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/update%20user%20entitlement?view=azure-devops-rest-6.0" }, { "Operation": "User Entitlements - Update User Entitlements", "Method": "PATCH", "Uri": "https://vsaex.dev.azure.com/{organization}/_apis/userentitlements?api-version=6.0-preview.3", "Description": "Edit the entitlements (License, Extensions, Projects, Teams etc) for one or more users.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/memberentitlementmanagement/user%20entitlements/update%20user%20entitlements?view=azure-devops-rest-6.0" } ], "Memberships": [ { "Operation": "Memberships - Add", "Method": "PUT", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/memberships/{subjectDescriptor}/{containerDescriptor}?api-version=6.0-preview.1", "Description": "Create a new membership between a container and subject.", "Do,cs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/memberships/add?view=azure-devops-rest-6.0" }, { "Operation": "Memberships - Check Membership Existence", "Method": "HEAD", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/memberships/{subjectDescriptor}/{containerDescriptor}?api-version=6.0-preview.1", "Description": "Check to see if a membership relationship between a container and subject exists.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/memberships/check%20membership%20existence?view=azure-devops-rest-6.0" }, { "Operation": "Memberships - Get", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/memberships/{subjectDescriptor}/{containerDescriptor}?api-version=6.0-preview.1", "Description": "Get a membership relationship between a container and subject.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/memberships/get?view=azure-devops-rest-6.0" }, { "Operation": "Memberships - List", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/Memberships/{subjectDescriptor}?api-version=6.0-preview.1", "Description": "Get all the memberships where this descriptor is a member in the relationship. The default value for direction is 'up' meaning return all memberships where the subject is a member (e.g. all groups the subject is a member of). Alternatively, passing the direction as 'down' will return all memberships where the subject is a container (e.g. all members of the subject group).", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/memberships/list?view=azure-devops-rest-6.0" }, { "Operation": "Memberships - Remove Membership", "Method": "DELETE", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/memberships/{subjectDescriptor}/{containerDescriptor}?api-version=6.0-preview.1", "Description": "Deletes a membership between a container and subject.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/memberships/remove%20membership?view=azure-devops-rest-6.0" } ], "Permissions Report": [ { "Operation": "Permissions Report - Create", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/permissionsreport?api-version=6.1-preview.1", "Description": "Request a permissions report to be created asyncronously", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/permissionsreport/permissions%20report/create?view=azure-devops-rest-6.1" }, { "Operation": "Permissions Report - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/permissionsreport?api-version=6-preview.1", "Description": "Get a list of permissions reports.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/permissionsreport/permissions%20report/list?view=azure-devops-rest-6.0" }, { "Operation": "Permissions Report - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/permissionsreport/{id}?api-version=6-preview.1", "Description": "Get a specific permissions report.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/permissionsreport/permissions%20report/get?view=azure-devops-rest-6.0" } ], "Personal Access Tokens": [ { "Operation": "List", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/tokenadmin/personalaccesstokens/{subjectDescriptor}?api-version={version}-preview.1", "Description": "Lists of all the session token details of the personal access tokens (PATs) for a particular user.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/tokenadmin/personal%20access%20tokens" } ], "Pipelines": [ { "Operation": "Artifacts - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}/artifacts?artifactName={artifactName}&api-version=6.1-preview.1", "Description": "Get a specific artifact from a pipeline run", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/artifacts/get?view=azure-devops-rest-6.1" }, { "Operation": "Logs - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}/logs/{logId}?api-version=6.1-preview.1", "Description": "Get a specific log from a pipeline run", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/logs/get?view=azure-devops-rest-6.1" }, { "Operation": "Logs - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}/logs?api-version=6.1-preview.1", "Description": "Get a list of logs from a pipeline run.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/logs/list?view=azure-devops-rest-6.1" }, { "Operation": "Pipelines - Create", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines?api-version=6.1-preview.1", "Description": "Create a pipeline.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/pipelines/create?view=azure-devops-rest-6.1" }, { "Operation": "Pipelines - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}?api-version=6.1-preview.1", "Description": "Gets a pipeline, optionally at the specified version", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/pipelines/get?view=azure-devops-rest-6.1" }, { "Operation": "Pipelines - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines?api-version=6.1-preview.1", "Description": "Get a list of pipelines.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/pipelines/list?view=azure-devops-rest-6.1" }, { "Operation": "Preview - Preview", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/preview?api-version=6.1-preview.1", "Description": "Queues a dry run of the pipeline and returns an object containing the final yaml.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/preview/preview?view=azure-devops-rest-6.1" }, { "Operation": "Runs - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs/{runId}?api-version=6.1-preview.1", "Description": "Gets a run for a particular pipeline.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/runs/get?view=azure-devops-rest-6.1" }, { "Operation": "Runs - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=6.1-preview.1", "Description": "Gets top 10000 runs for a particular pipeline.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/runs/list?view=azure-devops-rest-6.1" }, { "Operation": "Runs - Run Pipeline", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/pipelines/{pipelineId}/runs?api-version=6.1-preview.1", "Description": "Runs a pipeline.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/pipelines/runs/run%20pipeline?view=azure-devops-rest-6.1" } ], "Projects": [ { "Operation": "Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/projects/{projectId}?api-version={version}", "Description": "Get project with the specified id or name, optionally including capabilities.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/core/projects/get?view=azure-devops-rest-5.1" }, { "Operation": "List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/projects?api-version={version}", "Description": "Get all projects in the organization that the authenticated user has access to.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/core/projects/list?view=azure-devops-rest-5.1" } ], "Release": [ { "Operation": "Approvals - List", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals?api-version=6.1-preview.3", "Description": "Get a list of approvals.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/approvals/list?view=azure-devops-rest-6.1" }, { "Operation": "Approvals - Update", "Method": "PATCH", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/approvals/{approvalId}?api-version=6.1-preview.3", "Description": "Update status of an approval", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/approvals/update?view=azure-devops-rest-6.1" }, { "Operation": "Attachments - Get Release Task Attachment Content", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/attempts/{attemptId}/plan/{planId}/timelines/{timelineId}/records/{recordId}/attachments/{type}/{name}?api-version=6.1-preview.1", "Description": "Get a release task attachment.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/attachments/get%20release%20task%20attachment%20content?view=azure-devops-rest-6.1" }, { "Operation": "Attachments - Get Release Task Attachments", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/attempts/{attemptId}/plan/{planId}/attachments/{type}?api-version=6.1-preview.1", "Description": "Get the release task attachments.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/attachments/get%20release%20task%20attachments?view=azure-devops-rest-6.1" }, { "Operation": "Attachments - Get Task Attachment Content", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/attempts/{attemptId}/timelines/{timelineId}/records/{recordId}/attachments/{type}/{name}?api-version=6.1-preview.1", "Description": "GetTaskAttachmentContent API is deprecated. Use GetReleaseTaskAttachmentContent API instead.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/attachments/get%20task%20attachment%20content?view=azure-devops-rest-6.1" }, { "Operation": "Attachments - Get Task Attachments", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/attempts/{attemptId}/timelines/{timelineId}/attachments/{type}?api-version=6.1-preview.1", "Description": "GetTaskAttachments API is deprecated. Use GetReleaseTaskAttachments API instead.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/attachments/get%20task%20attachments?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - Create", "Method": "POST", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=6.1-preview.4", "Description": "Create a release definition", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/definitions/create?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - Delete", "Method": "DELETE", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?api-version=6.1-preview.4", "Description": "Delete a release definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/definitions/delete?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - Get", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions/{definitionId}?api-version={version}", "Description": "Get a release definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/definitions/get?view=azure-devops-rest-5.1" }, { "Operation": "Definitions - Get Definition Revision", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/definitions/{definitionId}/revisions/{revision}?api-version=6.1-preview.1", "Description": "Get release definition for a given definitionId and revision", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/definitions/get%20definition%20revision?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - Get Release Definition History", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/definitions/{definitionId}/revisions?api-version=6.1-preview.1", "Description": "Get revision history for a release definition", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/definitions/get%20release%20definition%20history?view=azure-devops-rest-6.1" }, { "Operation": "Definitions - List", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version={version}", "Description": "Get a list of release definitions.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/definitions/list?view=azure-devops-rest-5.1" }, { "Operation": "Definitions - Update", "Method": "PUT", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/definitions?api-version=6.1-preview.4", "Description": "Update a release definition.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/definitions/update?view=azure-devops-rest-6.1" }, { "Operation": "Deployments - List", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/deployments?api-version=6.1-preview.2", "Description": "", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/deployments/list?view=azure-devops-rest-6.1" }, { "Operation": "Folders - Create", "Method": "POST", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/folders/{path}?api-version=6.1-preview.2", "Description": "This method is no longer supported. Use CreateFolder with folder parameter API.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/folders/create?view=azure-devops-rest-6.1" }, { "Operation": "Folders - Delete", "Method": "DELETE", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/folders/{path}?api-version=6.1-preview.2", "Description": "Deletes a definition folder for given folder name and path and all it's existing definitions.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/folders/delete?view=azure-devops-rest-6.1" }, { "Operation": "Folders - List", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/folders/{path}?api-version=6.1-preview.2", "Description": "Gets folders.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/folders/list?view=azure-devops-rest-6.1" }, { "Operation": "Folders - Update", "Method": "PATCH", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/folders/{path}?api-version=6.1-preview.2", "Description": "Updates an existing folder at given existing path.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/folders/update?view=azure-devops-rest-6.1" }, { "Operation": "Gates - Update", "Method": "PATCH", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/gates/{gateStepId}?api-version=6.1-preview.1", "Description": "Updates the gate for a deployment.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/gates/update?view=azure-devops-rest-6.1" }, { "Operation": "Manual Interventions - Get", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/manualinterventions/{manualInterventionId}?api-version=6.1-preview.1", "Description": "Get manual intervention for a given release and manual intervention id.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/manual%20interventions/get?view=azure-devops-rest-6.1" }, { "Operation": "Manual Interventions - List", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/manualinterventions?api-version=6.1-preview.1", "Description": "List all manual interventions for a given release.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/manual%20interventions/list?view=azure-devops-rest-6.1" }, { "Operation": "Manual Interventions - Update", "Method": "PATCH", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/manualinterventions/{manualInterventionId}?api-version=6.1-preview.1", "Description": "Update manual intervention.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/manual%20interventions/update?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Create", "Method": "POST", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?api-version=6.1-preview.8", "Description": "Create a release.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/create?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Get Logs", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/logs?api-version=6.1-preview.2", "Description": "Get logs for a release Id.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/get%20logs?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Get Release", "Method": "GET", "Uri": "GET https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=6.1-preview.8", "Description": "Get a Release.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/get%20release?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Get Release Environment", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=6.1-preview.7", "Description": "Get a release environment.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/get%20release%20environment?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Get Release Environment", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=6.1-preview.7", "Description": "Get a release environment.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/get%20release%20environment?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Get Release Revision", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?definitionSnapshotRevision={definitionSnapshotRevision}&api-version=6.1-preview.8", "Description": "Get release for a given revision number.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/get%20release%20revision?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Get Task Log", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}/environments/{environmentId}/deployPhases/{releaseDeployPhaseId}/tasks/{taskId}/logs?api-version=6.1-preview.2", "Description": "Gets the task log of a release as a plain text file.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/get%20task%20log?view=azure-devops-rest-6.1" }, { "Operation": "Releases - List", "Method": "GET", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases?api-version=6.1-preview.8", "Description": "Get a list of releases.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/list?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Update Release", "Method": "PUT", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=6.1-preview.8", "Description": "Update a complete release object.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/update%20release?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Update Release Environment", "Method": "PATCH", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/Release/releases/{releaseId}/environments/{environmentId}?api-version=6.1-preview.7", "Description": "Update the status of a release environment", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/update%20release%20environment?view=azure-devops-rest-6.1" }, { "Operation": "Releases - Update Release Resource", "Method": "PATCH", "Uri": "https://vsrm.dev.azure.com/{organization}/{project}/_apis/release/releases/{releaseId}?api-version=6.1-preview.8", "Description": "Update few properties of a release.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/release/releases/update%20release%20resource?view=azure-devops-rest-6.1" } ], "Security": [ { "Operation": "Access Control Entries - Remove Access Control Entries", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/_apis/accesscontrolentries/{securityNamespaceId}?api-version=7.1-preview.1", "Description": "Remove the specified ACEs from the ACL belonging to the specified token.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access-control-entries/remove-access-control-entries?view=azure-devops-rest-7.1" }, { "Operation": "Access Control Entries - Set Access Control Entries", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/accesscontrolentries/{securityNamespaceId}?api-version=7.1-preview.1", "Description": "Add or update ACEs in the ACL for the provided token. The request body contains the target token, a list of ACEs and a optional merge parameter. In the case of a collision (by identity descriptor) with an existing ACE in the ACL, the 'merge' parameter determines the behavior. If set, the existing ACE has its allow and deny merged with the incoming ACE's allow and deny. If unset, the existing ACE is displaced.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access-control-entries/set-access-control-entries?view=azure-devops-rest-7.1" }, { "Operation": "Access Control Lists - Query", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/accesscontrollists/{securityNamespaceId}?api-version=7.1-preview.1", "Description": "Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access-control-lists/query?view=azure-devops-rest-7.1" }, { "Operation": "Access Control Lists - Remove Access Control Lists", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/_apis/accesscontrollists/{securityNamespaceId}?api-version=7.1-preview.1", "Description": "Remove access control lists under the specfied security namespace.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access-control-lists/remove-access-control-lists?view=azure-devops-rest-7.1" }, { "Operation": "Access Control Lists - Set Access Control Lists", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/accesscontrollists/{securityNamespaceId}?api-version=7.1-preview.1", "Description": "Create or update one or more access control lists. All data that currently exists for the ACLs supplied will be overwritten.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/security/access-control-lists/set-access-control-lists?view=azure-devops-rest-7.1" }, { "Operation": "Permissions - Has Permissions", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/permissions/{securityNamespaceId}/{permissions}?api-version=7.1-preview.2", "Description": "Evaluates whether the caller has the specified permissions on the specified set of security tokens.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/security/permissions/has-permissions?view=azure-devops-rest-7.1" }, { "Operation": "Permissions - Has Permissions Batch", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/security/permissionevaluationbatch?api-version=7.1-preview.1", "Description": "Evaluates multiple permissions for the calling user. Note: This method does not aggregate the results, nor does it short-circuit if one of the permissions evaluates to false.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/security/permissions/has-permissions-batch?view=azure-devops-rest-7.1" }, { "Operation": "Permissions - Remove Permission", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/_apis/permissions/{securityNamespaceId}/{permissions}?descriptor={descriptor}&api-version=7.1-preview.2", "Description": "Removes the specified permissions on a security token for a user or group.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/security/permissions/remove-permission?view=azure-devops-rest-7.1" }, { "Operation": "Security Namespaces - Query", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/securitynamespaces/{securityNamespaceId}?api-version=7.1-preview.1", "Description": "List all security namespaces or just the specified namespace.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/security/security-namespaces/query?view=azure-devops-rest-7.1" } ], "Service Endpoint": [ { "Operation": "Endpoints - Create", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints?api-version=6.1-preview.4", "Description": "Creates a new service endpoint", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/create?view=azure-devops-rest-6.1" }, { "Operation": "Endpoints - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId}?projectIds={projectIds}&api-version=6.1-preview.4", "Description": "Delete a service endpoint", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/delete?view=azure-devops-rest-6.1" }, { "Operation": "Endpoints - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints/{endpointId}?api-version=6.1-preview.4", "Description": "Get the service endpoint details.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/get?view=azure-devops-rest-6.1" }, { "Operation": "Endpoints - Get Service Endpoints", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?api-version=6.1-preview.4", "Description": "Get the service endpoints.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/get%20service%20endpoints?view=azure-devops-rest-6.1" }, { "Operation": "Endpoints - Get Service Endpoints By Names", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?endpointNames={endpointNames}&api-version=6.1-preview.4", "Description": "Get the service endpoints by name.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/get%20service%20endpoints%20by%20names?view=azure-devops-rest-6.1" }, { "Operation": "Endpoints - Get Service Endpoints With Refreshed Authentication", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/serviceendpoint/endpoints?endpointIds={endpointIds}&api-version=6.1-preview.4", "Description": "Gets the service endpoints and patch new authorization parameters", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/get%20service%20endpoints%20with%20refreshed%20authentication?view=azure-devops-rest-6.1" }, { "Operation": "Endpoints - Share Service Endpoint", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId}?api-version=6.1-preview.4", "Description": "Share service endpoint across projects", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/share%20service%20endpoint?view=azure-devops-rest-6.1" }, { "Operation": "Endpoints - Update Service Endpoint", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints/{endpointId}?api-version=6.1-preview.4", "Description": "Update the service endpoint", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/update%20service%20endpoint?view=azure-devops-rest-6.1" }, { "Operation": "Endpoints - Update Service Endpoints", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/_apis/serviceendpoint/endpoints?api-version=6.1-preview.4", "Description": "Update the service endpoints.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/serviceendpoint/endpoints/update%20service%20endpoints?view=azure-devops-rest-6.1" } ], "Service Hooks": [ { "Operation": "Consumers - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}?api-version=6.0", "Description": "Get a specific consumer service. Optionally filter out consumer actions that do not support any event types for the specified publisher.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/consumers/get?view=azure-devops-rest-6.0" }, { "Operation": "Consumers - Get Consumer Action", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}/actions/{consumerActionId}?api-version=6.0", "Description": "Get details about a specific consumer action.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/consumers/get%20consumer%20action?view=azure-devops-rest-6.0" }, { "Operation": "Consumers - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/consumers?api-version=6.0", "Description": "Get a list of available service hook consumer services. Optionally filter by consumers that support at least one event type from the specific publisher.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/consumers/list?view=azure-devops-rest-6.0" }, { "Operation": "Consumers - List Consumer Actions", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/consumers/{consumerId}/actions?api-version=6.0", "Description": "Get a list of consumer actions for a specific consumer.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/consumers/list%20consumer%20actions?view=azure-devops-rest-6.0" }, { "Operation": "Subscriptions - Create", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/subscriptions?api-version=6.0", "Description": "Create a subscription.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/create?view=azure-devops-rest-6.0" }, { "Operation": "Subscriptions - Create Subscriptions Query", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/subscriptionsquery?api-version=6.0", "Description": "Query for service hook subscriptions.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/create%20subscriptions%20query?view=azure-devops-rest-6.0" }, { "Operation": "Subscriptions - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId}?api-version=6.0", "Description": "Delete a specific service hooks subscription.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/delete?view=azure-devops-rest-6.0" }, { "Operation": "Subscriptions - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId}?api-version=6.0", "Description": "Get a specific service hooks subscription.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/get?view=azure-devops-rest-6.0" }, { "Operation": "Subscriptions - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/subscriptions?api-version=6.0", "Description": "Get a list of subscriptions.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/list?view=azure-devops-rest-6.0" }, { "Operation": "Subscriptions - Replace Subscription", "Method": "PUT", "Uri": "https://dev.azure.com/{organization}/_apis/hooks/subscriptions/{subscriptionId}?api-version=6.0", "Description": "Update a subscription. ID for a subscription that you wish to update.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/hooks/subscriptions/replace%20subscription?view=azure-devops-rest-6.0" } ], "Task Agent": [ { "Operation": "Agents - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools/{poolId}/agents?api-version={version}", "Description": "Get a list of agents.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/agents/list?view=azure-devops-rest-5.1" }, { "Operation": "Environments - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}?api-version=6.0-preview.1", "Description": "Get an environment by its ID.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/environments/get?view=azure-devops-rest-6.0" }, { "Operation": "Job Requests - Get", "Method": "GET", "Uri": "https://dev.azure.com//{organization}/_apis/distributedtask/pools/{poolId}/jobrequests?agentId={agentId}&?api-version=6.0", "Description": "Get all job requests related to a build agent and pool.", "Docs": "No documentation available." }, { "Operation": "Environments - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments?api-version=6.0-preview.1", "Description": "Get all environments.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/environments/list?view=azure-devops-rest-6.0" }, { "Operation": "Pools - Get Agent Pools", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/distributedtask/pools?api-version={version}", "Description": "Get a list of agent pools.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/pools/get%20agent%20pools?view=azure-devops-rest-5.1" }, { "Operation": "Queues - Add", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues?api-version=6.0-preview.1", "Description": "reate a new agent queue to connect a project to an agent pool.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/add?view=azure-devops-rest-6.0" }, { "Operation": "Queues - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues/{queueId}?api-version=6.0-preview.1", "Description": "Removes an agent queue from a project.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/delete?view=azure-devops-rest-6.0" }, { "Operation": "Queues - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues/{queueId}?api-version=6.0-preview.1", "Description": "Get information about an agent queue.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/get?view=azure-devops-rest-6.0" }, { "Operation": "Queues - Get Agent Queues", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues?api-version=6.0-preview.1", "Description": "Get a list of agent queues.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/get%20agent%20queues?view=azure-devops-rest-6.0" }, { "Operation": "Queues - Get Agent Queues By Ids", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues?queueIds={queueIds}&api-version=6.0-preview.1", "Description": "Get a list of agent queues by their IDs", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/get%20agent%20queues%20by%20ids?view=azure-devops-rest-6.0" }, { "Operation": "Queues - Get Agent Queues By Names", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues?queueNames={queueNames}&api-version=6.0-preview.1", "Description": "Get a list of agent queues by their names", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/get%20agent%20queues%20by%20names?view=azure-devops-rest-6.0" }, { "Operation": "Queues - Get Agent Queues For Pools", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/distributedtask/queues?poolIds={poolIds}&api-version=6.0-preview.1", "Description": "Get a list of agent queues by pool ids", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/distributedtask/queues/get%20agent%20queues%20for%20pools?view=azure-devops-rest-6.0" } ], "Teams": [ { "Operation": "Get All Teams", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/teams?api-version={version}-preview.3", "Description": "Get a list of all teams.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/core/teams/get%20all%20teams?view=azure-devops-rest-5.1" }, { "Operation": "Get Teams", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams?api-version={version}-preview.3", "Description": "Get a list of teams.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/core/teams/get%20teams?view=azure-devops-rest-5.1" }, { "Operation": "Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId}?api-version={version}-preview.3", "Description": "Get a specific team.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/core/teams/get?view=azure-devops-rest-5.1" }, { "Operation": "Create", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams?api-version={version}-preview.3", "Description": "Create a team in a team project.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/core/teams/create?view=azure-devops-rest-5.1" }, { "Operation": "Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId}?api-version={version}-preview.3", "Description": "Delete a team.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/core/teams/delete?view=azure-devops-rest-5.1" }, { "Operation": "Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams/{teamId}?api-version={version}-preview.3", "Description": "Update a team's name and/or description..", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/core/teams/update?view=azure-devops-rest-5.1" } ], "Users": [ { "Operation": "Create", "Method": "POST", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/users?api-version=7.1-preview.1", "Description": "NOT VALIDATED!!! Materialize an existing AAD or MSA user into the VSTS account.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/create?view=azure-devops-rest-7.1", "Body": "$Example = @{ principalName = 'ado.test.svc@clearesult.com' } | ConvertTo-JSon" }, { "Operation": "Create with Group Membership", "Method": "POST", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/users?groupDescriptors={groupDescriptors}&api-version=7.1-preview.1", "Description": "NOT VALIDATED!!! Materialize an existing AAD or MSA user into the VSTS account and put in group.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/create?view=azure-devops-rest-7.1", "Body": "$Example = @{ principalName = 'ado.test.svc@clearesult.com' } | ConvertTo-JSon" }, { "Operation": "Delete", "Method": "DELETE", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/users/{userDescriptor}?api-version=7.1-preview.1", "Description": "Disables a user. The user will still be visible, but membership checks for the user will return false.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/delete" }, { "Operation": "Get", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/users/{userDescriptor}?api-version=7.1-preview.1", "Description": "Get a user by its descriptor.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/get" }, { "Operation": "List", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/users?api-version=7.1-preview.1", "Description": "Get a list of all users in a given scope.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/list" }, { "Operation": "List with Continuation Token", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/users?continuationToken={continuationToken}&api-version=7.1-preview.1", "Description": "Get a list of all users in a given scope. Since the list of users may be large, results are returned in pages of users. If there are more results than can be returned in a single page, the result set will contain a continuation token for retrieval of the next set of results.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/list?view=azure-devops-rest-7.1" }, { "Operation": "List by Scope", "Method": "GET", "Uri": "https://vssps.dev.azure.com/{organization}/_apis/graph/users?scopeDescriptor={scopeDescriptor}&api-version=7.1-preview.1", "Description": "Get a list of all users in a given scope.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/graph/users/list" } ], "Work Item Tracking": [ { "Operation": "Work Items - Get Work Item", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/workitems/{id}?api-version={version}", "Description": "Returns a single work item.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/get%20work%20item?view=azure-devops-rest-5.1" }, { "Operation": "Work Items - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/workitems?ids={ids}&api-version={version}", "Description": "Returns a list of work items (Maximum 200)", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20items/list?view=azure-devops-rest-5.1" }, { "Operation": "Queries - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/queries/{query}?$depth=2&api-version={version}", "Description": "Retrieves an individual query and its children", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/queries/get?view=azure-devops-rest-5.1" }, { "Operation": "Queries - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/queries?$depth=2&api-version={version}", "Description": "Gets the root queries and their children", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/queries/list?view=azure-devops-rest-5.1" }, { "Operation": "Tags - Delete", "Method": "DELETE", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/tags/{tagIdOrName}?api-version=7.2-preview.1", "Description": "Delete the tag for the project. Please note, that the deleted tag will be removed from all Work Items as well as Pull Requests.", "Docs": "https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/tags/delete?view=azure-devops-rest-7.2&tabs=HTTP" }, { "Operation": "Tags - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/tags/{tagIdOrName}?api-version=7.2-preview.1", "Description": "Get the tag for the project.", "Docs": "https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/tags/get?view=azure-devops-rest-7.2&tabs=HTTP" }, { "Operation": "Tags - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/tags?api-version=7.2-preview.1", "Description": "Get all the tags for the project.", "Docs": "https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/tags/list?view=azure-devops-rest-7.2&tabs=HTTP" }, { "Operation": "Tags - Update", "Method": "PATCH", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/tags/{tagIdOrName}?api-version=7.2-preview.1", "Description": "Update the tag for the project.", "Docs": "https://learn.microsoft.com/en-us/rest/api/azure/devops/wit/tags/update?view=azure-devops-rest-7.2&tabs=HTTP" }, { "Operation": "Updates - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{id}/updates/{updateNumber}?api-version=5.1", "Description": "Returns a single update for a work item", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/updates/get?view=azure-devops-rest-5.1" }, { "Operation": "Updates - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/_apis/wit/workItems/{id}/updates?api-version=5.1", "Description": "Returns a the deltas between work item revisions", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/updates/list?view=azure-devops-rest-5.1" }, { "Operation": "Wiql - Query By Id", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?api-version={version}", "Description": "Gets the results of the query given the query ID.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query%20by%20id?view=azure-devops-rest-5.1" }, { "Operation": "Wiql - Query By Wiql", "Method": "POST", "Uri": "https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql?api-version={version}", "Description": "Gets the results of the query given its WIQL.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/query%20by%20wiql?view=azure-devops-rest-5.1" }, { "Operation": "Wiql - Get", "Method": "HEAD", "Uri": "https://dev.azure.com/{organization}/{project}/{team}/_apis/wit/wiql/{id}?api-version={version}", "Description": "Gets the results of the query given the query ID.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/wiql/get?view=azure-devops-rest-5.1" } ], "Work Item Tracking Process": [ { "Operation": "Fields - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields/{fieldRefName}?api-version={version}-preview.2", "Description": "Returns a field in a work item type.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/fields/get?view=azure-devops-rest-5.1" }, { "Operation": "Fields - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/fields?api-version={version}-preview.2", "Description": "Returns a list of all fields in a work item type.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/fields/list?view=azure-devops-rest-5.1" }, { "Operation": "Processes - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/work/processes/{processTypeId}?api-version={version}-preview.2", "Description": "Get a single process of a specified ID.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/processes/get?view=azure-devops-rest-5.1" }, { "Operation": "Processes - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/work/processes?api-version={version}-preview.2", "Description": "Get list of all processes including system and inherited.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/processes/list?view=azure-devops-rest-5.1" }, { "Operation": "States - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states/{stateId}?api-version={version}-preview.1", "Description": "Returns a single state definition in a work item type of the process.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/states/get?view=azure-devops-rest-5.1" }, { "Operation": "States - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workItemTypes/{witRefName}/states?api-version={version}-preview.1", "Description": "Returns a list of all state definitions in a work item type of the process.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/states/list?view=azure-devops-rest-5.1" }, { "Operation": "Work Item Types - Get", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes/{witRefName}?api-version={version}-preview.2", "Description": "Returns a single work item type in a process.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/work%20item%20types/get?view=azure-devops-rest-5.1" }, { "Operation": "Work Item Types - List", "Method": "GET", "Uri": "https://dev.azure.com/{organization}/_apis/work/processes/{processId}/workitemtypes?api-version={version}-preview.2", "Description": "Returns a list of all work item types in a process.", "Docs": "https://docs.microsoft.com/en-us/rest/api/azure/devops/processes/work%20item%20types/list?view=azure-devops-rest-5.1" } ] } } |