Compatibility
Products
| Product | Highest API version | Source | Verified |
| Azure DevOps Services | 7.1 | 7.1 is the newest released version in the REST API reference | Not verified |
| Azure DevOps Server | 7.1 | its release notes describe 7.2-preview features, so it accepts 7.1 | Not verified |
| Azure DevOps Server 2022 | 7.0 | REST API versioning page | Not verified |
Entry points
An entry point works with every product whose highest API version is at least the entry point's API version. Every product accepts all lower API versions.
| Import | API version | Products |
@hypothesi/azure-devops-api/7.0 | 7.0 | Azure DevOps Services, Azure DevOps Server, Azure DevOps Server 2022 |
@hypothesi/azure-devops-api/7.1 | 7.1 | Azure DevOps Services, Azure DevOps Server |
@hypothesi/azure-devops-api/services | 7.1 | Azure DevOps Services, Azure DevOps Server |
@hypothesi/azure-devops-api/server | 7.1 | Azure DevOps Services, Azure DevOps Server |
@hypothesi/azure-devops-api/server-2022 | 7.0 | Azure DevOps Services, Azure DevOps Server, Azure DevOps Server 2022 |
Client versions and API versions
The version of @hypothesi/azure-devops-api is independent of the Azure DevOps API versions. The client uses semver with these rules.
| Change | Release type |
| New API version entry point, such as 7.2 | Minor |
| Spec update with only identical or additive changes | Minor |
| Spec update with a breaking change in a supported version | Major |
| API version removed because its last product left mainstream support | Major |
| Transport or helper fix | Patch |
Changes between API versions
Identical means the same operations, parameters, request bodies, and schemas. Additive means only new operations, new optional properties, new optional parameters, or new enum values. Breaking means removed operations or properties, changed types, or new required inputs.
Account (account)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
PipelinePermissions, PipelinesChecks, Approval (approvalsAndChecks)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | operation GET /{project}/_apis/pipelines/approvals: optional parameter query state addedoperation GET /{project}/_apis/pipelines/approvals: optional parameter query top addedoperation GET /{project}/_apis/pipelines/approvals: optional parameter query userIds addedschema ApprovalsQueryParameters: property approverStatus addedschema ApprovalsQueryParameters: property top addedschema ApprovalsQueryParameters: property userIds addedschema CheckConfiguration: property isDisabled addedschema CheckConfiguration: property issue addedschema CheckData: property defaultCheckSettings addedschema CheckIssue addedschema CheckIssueData addedschema ResourceCheckIssue added
|
Feed, Provenance, SBOM (artifacts)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema FeedIdsResult addedschema SBOMTelemetry: property taskName addedschema SBOMTelemetry: property telemetryId addedschema SignResponseBase: property result anyOf [0] enum value "failCanRetry" added
|
Maven, Npm, NuGet, PyPiApi, UPackApi (artifactsPackageTypes)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema PackageNuGet: property listed added
|
Audit (audit)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema AuditLogEntry: property actorClientId addedschema DecoratedAuditLogEntry: property actorClientId added
|
Build (build)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema Build: property appendCommitMessageToRunName addedschema PipelineGeneralSettings: property auditEnforceSettableVar addedschema PipelineGeneralSettings: property buildsEnabledForForks addedschema PipelineGeneralSettings: property disableClassicBuildPipelineCreation addedschema PipelineGeneralSettings: property disableClassicPipelineCreation addedschema PipelineGeneralSettings: property disableClassicReleasePipelineCreation addedschema PipelineGeneralSettings: property enableShellTasksArgsSanitizing addedschema PipelineGeneralSettings: property enableShellTasksArgsSanitizingAudit addedschema PipelineGeneralSettings: property enforceJobAuthScopeForForks addedschema PipelineGeneralSettings: property enforceNoAccessToSecretsFromForks addedschema PipelineGeneralSettings: property forkProtectionEnabled addedschema PipelineGeneralSettings: property isCommentRequiredForPullRequest addedschema PipelineGeneralSettings: property requireCommentsForNonTeamMemberAndNonContributors addedschema PipelineGeneralSettings: property requireCommentsForNonTeamMembersOnly addedschema PipelineTriggerSettings addedschema PullRequestTrigger: property pipelineTriggerSettings added
|
Core (core)
| Versions | Change | Changes |
| 7.1 vs 7.0 | breaking | operation GET /_apis/projects: parameter query continuationToken schema format addedoperation GET /_apis/projects: parameter query continuationToken schema type changed from "string" to "integer"schema CategorizedWebApiTeams addedschema TeamProjectCollectionReference: property avatarUrl added
|
Dashboard (dashboard)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema Dashboard: property lastAccessedDate addedschema Dashboard: property modifiedBy addedschema Dashboard: property modifiedDate added
|
Elastic, Task, TaskAgent (distributedTask)
| Versions | Change | Changes |
| 7.1 vs 7.0 | breaking | operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "assignedPendingDelete" addedoperation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "failedToRestartPendingDelete" addedoperation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "failedToStartPendingDelete" addedoperation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "failedVMPendingDelete" addedoperation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "reimagingCompute" addedoperation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "restartingAgent" addedoperation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "retryDelete" addedoperation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "unhealthyVm" addedoperation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "unhealthyVmPendingDelete" addedoperation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: operationId changed from "Agents_Get" to "Agents_Get Pool Permission"operation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: parameter query includeAssignedRequest removedoperation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: parameter query includeCapabilities removedoperation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: parameter query includeLastCompletedRequest removedoperation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: parameter query propertyFilters removedoperation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: required parameter query isCheckPermissions addedoperation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: response 200 application/json schema $ref removedoperation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: response 200 application/json schema type addedschema ElasticNode: property computeState anyOf [0] enum value "reimaging" addedschema ElasticNode: property computeState anyOf [0] enum value "unhealthyVm" addedschema ElasticNode: property computeState anyOf [0] enum value "unhealthyVmssVm" addedschema ElasticNode: property desiredState anyOf [0] enum value "assignedPendingDelete" addedschema ElasticNode: property desiredState anyOf [0] enum value "failedToRestartPendingDelete" addedschema ElasticNode: property desiredState anyOf [0] enum value "failedToStartPendingDelete" addedschema ElasticNode: property desiredState anyOf [0] enum value "failedVMPendingDelete" addedschema ElasticNode: property desiredState anyOf [0] enum value "reimagingCompute" addedschema ElasticNode: property desiredState anyOf [0] enum value "restartingAgent" addedschema ElasticNode: property desiredState anyOf [0] enum value "retryDelete" addedschema ElasticNode: property desiredState anyOf [0] enum value "unhealthyVm" addedschema ElasticNode: property desiredState anyOf [0] enum value "unhealthyVmPendingDelete" addedschema ElasticNode: property state anyOf [0] enum value "assignedPendingDelete" addedschema ElasticNode: property state anyOf [0] enum value "failedToRestartPendingDelete" addedschema ElasticNode: property state anyOf [0] enum value "failedToStartPendingDelete" addedschema ElasticNode: property state anyOf [0] enum value "failedVMPendingDelete" addedschema ElasticNode: property state anyOf [0] enum value "reimagingCompute" addedschema ElasticNode: property state anyOf [0] enum value "restartingAgent" addedschema ElasticNode: property state anyOf [0] enum value "retryDelete" addedschema ElasticNode: property state anyOf [0] enum value "unhealthyVm" addedschema ElasticNode: property state anyOf [0] enum value "unhealthyVmPendingDelete" addedschema ElasticNodeSettings: property state anyOf [0] enum value "assignedPendingDelete" addedschema ElasticNodeSettings: property state anyOf [0] enum value "failedToRestartPendingDelete" addedschema ElasticNodeSettings: property state anyOf [0] enum value "failedToStartPendingDelete" addedschema ElasticNodeSettings: property state anyOf [0] enum value "failedVMPendingDelete" addedschema ElasticNodeSettings: property state anyOf [0] enum value "reimagingCompute" addedschema ElasticNodeSettings: property state anyOf [0] enum value "restartingAgent" addedschema ElasticNodeSettings: property state anyOf [0] enum value "retryDelete" addedschema ElasticNodeSettings: property state anyOf [0] enum value "unhealthyVm" addedschema ElasticNodeSettings: property state anyOf [0] enum value "unhealthyVmPendingDelete" addedschema ElasticPool: property orchestrationType addedschema ElasticPoolSettings: property orchestrationType addedschema JObject removedschema JObjectTask addedschema JObjectTaskAgent addedschema ServiceEndpoint: property operationStatus anyOf [0] $ref changed from "#/components/schemas/JObject" to "#/components/schemas/JObjectTaskAgent"schema TaskAgentCloudRequest: property agentData anyOf [0] $ref changed from "#/components/schemas/JObject" to "#/components/schemas/JObjectTaskAgent"schema TaskAgentCloudRequest: property agentSpecification anyOf [0] $ref changed from "#/components/schemas/JObject" to "#/components/schemas/JObjectTaskAgent"schema TaskAgentJobRequest: property agentSpecification anyOf [0] $ref changed from "#/components/schemas/JObject" to "#/components/schemas/JObjectTaskAgent"schema TaskCompletedEvent: property deliveryFailed addedschema TaskDefinition: property execution additionalProperties $ref changed from "#/components/schemas/JObject" to "#/components/schemas/JObjectTaskAgent"schema TaskDefinition: property postJobExecution additionalProperties $ref changed from "#/components/schemas/JObject" to "#/components/schemas/JObjectTaskAgent"schema TaskDefinition: property preJobExecution additionalProperties $ref changed from "#/components/schemas/JObject" to "#/components/schemas/JObjectTaskAgent"schema TaskHubOidcToken addedschema TimelineRecord: property agentSpecification anyOf [0] $ref changed from "#/components/schemas/JObject" to "#/components/schemas/JObjectTaskAgent"
|
ExtensionManagement (extensionManagement)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
Favorite (favorite)
No earlier version to compare.
Git (git)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | operation GET /{project}/_apis/git/pullrequests: optional parameter query searchCriteria.maxTime addedoperation GET /{project}/_apis/git/pullrequests: optional parameter query searchCriteria.minTime addedoperation GET /{project}/_apis/git/pullrequests: optional parameter query searchCriteria.queryTimeRangeType addedoperation GET /{project}/_apis/git/repositories/{repositoryId}/items: optional parameter query zipForUnix addedoperation GET /{project}/_apis/git/repositories/{repositoryId}/pullrequests: optional parameter query searchCriteria.maxTime addedoperation GET /{project}/_apis/git/repositories/{repositoryId}/pullrequests: optional parameter query searchCriteria.minTime addedoperation GET /{project}/_apis/git/repositories/{repositoryId}/pullrequests: optional parameter query searchCriteria.queryTimeRangeType addedschema AdvSecEnablementStatus addedschema AdvSecEnablementUpdate addedschema BillableCommitter addedschema BillableCommitterDetail addedschema GitCommitRef: property commitTooManyChanges addedschema GitPullRequestIteration: property reason anyOf [0] enum value "resolveConflicts" addedschema GitPullRequestSearchCriteria: property maxTime addedschema GitPullRequestSearchCriteria: property minTime addedschema GitPullRequestSearchCriteria: property queryTimeRangeType addedschema GitRepository: property isInMaintenance addedschema IdentityRefWithVote: property isReapprove addedschema TeamProjectCollectionReference: property avatarUrl added
|
Graph (graph)
| Versions | Change | Changes |
| 7.1 vs 7.0 | breaking | schema AadGraphMember addedschema GraphServicePrincipal addedschema GraphServicePrincipalCreationContext addedschema GraphServicePrincipalOriginIdCreationContext addedschema GraphServicePrincipalOriginIdUpdateContext addedschema GraphServicePrincipalUpdateContext addedschema GraphUser: allOf [0] $ref changed from "#/components/schemas/GraphMember" to "#/components/schemas/AadGraphMember"schema GraphUser: property directoryAlias removedschema GraphUser: property isDeletedInOrigin removedschema GraphUser: property metaType removedschema GraphUserPrincipalNameUpdateContext addedschema IdentityMapping addedschema IdentityMappings addedschema MappingResult addedschema PagedGraphMembers addedschema PagedGraphServicePrincipals addedschema ResolveDisconnectedUsersResponse addedschema UserPrincipalName added
|
ServiceHooks (hooks)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
Identity (ims)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
MemberEntitlementManagement (memberEntitlementManagement)
| Versions | Change | Changes |
| 7.1 vs 7.0 | breaking | operation GET /_apis/userentitlements: response 200 application/json schema $ref changed from "#/components/schemas/PagedGraphMemberList" to "#/components/schemas/PagedUserEntitlementsList"schema AadGraphMember addedschema EntitlementBase addedschema EntitlementOperationResultBase addedschema GraphServicePrincipal addedschema GraphUser: allOf [0] $ref changed from "#/components/schemas/GraphMember" to "#/components/schemas/AadGraphMember"schema GraphUser: property directoryAlias removedschema GraphUser: property isDeletedInOrigin removedschema GraphUser: property metaType removedschema MemberEntitlement2 addedschema MemberEntitlement2OperationReference addedschema MemberEntitlement2OperationResult addedschema MemberEntitlement2PatchResponse addedschema MemberEntitlement2PostResponse addedschema MemberEntitlement2ResponseBase addedschema PagedUserEntitlementsList addedschema ServicePrincipalEntitlement addedschema ServicePrincipalEntitlementOperationReference addedschema ServicePrincipalEntitlementOperationResult addedschema ServicePrincipalEntitlementsPatchResponse addedschema ServicePrincipalEntitlementsPostResponse addedschema ServicePrincipalEntitlementsResponseBase addedschema UserEntitlement: allOf addedschema UserEntitlement: property accessLevel removedschema UserEntitlement: property dateCreated removedschema UserEntitlement: property groupAssignments removedschema UserEntitlement: property id removedschema UserEntitlement: property lastAccessedDate removedschema UserEntitlement: property projectEntitlements removedschema UserEntitlementOperationResult: allOf addedschema UserEntitlementOperationResult: property errors removedschema UserEntitlementOperationResult: property isSuccess removedschema UserEntitlementOperationResult: property result removed
|
Notification (notification)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
Operations (operations)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
PermissionsReport (permissionsReport)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
Pipelines (pipelines)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema Container addedschema ContainerResource addedschema PipelineResource addedschema Run: property templateParameters addedschema RunResources: property containers addedschema RunResources: property pipelines added
|
Policy (policy)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
WorkItemTrackingProcessTemplate (processadmin)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
WorkItemTracking (processes)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema FieldModel: property isLocked addedschema ProcessWorkItemTypeField: property isLocked added
|
Profile (profile)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
Release (release)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema DeploymentManualInterventionPendingEvent: property approval added
|
Search (search)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
Security (security)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
SecurityRoles (securityRoles)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
ServiceEndpoint (serviceEndpoint)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | operation GET /{project}/_apis/serviceendpoint/endpoints?: optional parameter query actionFilter addedschema AzureSpnOperationStatus: property severity addedschema ServiceEndpointExecutionData: property ownerDetails added
|
Status (status)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema LiveSiteEvent: property isDeleted addedschema StatusImpact added
|
Symbol (symbol)
| Versions | Change | Changes |
| 7.1 vs 7.0 | identical | None |
Test (test)
| Versions | Change | Changes |
| 7.1 vs 7.0 | breaking | schema CodeCoverageSummary: property coverageDetailedSummaryStatus addedschema TestLogStoreAttachment addedschema TestLogStoreAttachmentReference addedschema TestResultFailureType addedschema TestResultFailureTypeRequestModel addedschema TestRunSummary2: property testRunStatsId format changed from "int32" to "int64"
|
TestPlan (testPlan)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema ExportTestCaseParams added
|
TestResults (testResults)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema CodeCoverageSummary: property coverageDetailedSummaryStatus addedschema TestLogStoreAttachment addedschema TestLogStoreAttachmentReference addedschema TestResultFailureType addedschema TestResultFailureTypeRequestModel added
|
Tfvc (tfvc)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema GitRepository: property isInMaintenance addedschema TeamProjectCollectionReference: property avatarUrl added
|
TokenAdmin (tokenAdmin)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema SessionTokenResult: property sessionTokenError anyOf [0] enum value "deploymentHostNotSupported" addedschema SessionTokenResult: property sessionTokenError anyOf [0] enum value "invalidAudience" addedschema SessionTokenResult: property sessionTokenError anyOf [0] enum value "invalidSubject" addedschema SessionTokenResult: property sessionTokenError anyOf [0] enum value "invalidTokenType" added
|
Tokens (tokens)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema PatTokenResult: property patTokenError anyOf [0] enum value "deploymentHostNotSupported" addedschema PatTokenResult: property patTokenError anyOf [0] enum value "invalidAudience" addedschema PatTokenResult: property patTokenError anyOf [0] enum value "invalidSubject" addedschema PatTokenResult: property patTokenError anyOf [0] enum value "invalidTokenType" added
|
Wiki (wiki)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema GitRepository: property isInMaintenance addedschema TeamProjectCollectionReference: property avatarUrl added
|
WorkItemTracking (wit)
| Versions | Change | Changes |
| 7.1 vs 7.0 | breaking | operation GET /{project}/_apis/wit/fields/{fieldNameOrRefName}: response 200 application/json schema $ref changed from "#/components/schemas/WorkItemField" to "#/components/schemas/WorkItemField2"operation GET /{project}/_apis/wit/fields: response 200 application/json schema items $ref changed from "#/components/schemas/WorkItemField" to "#/components/schemas/WorkItemField2"operation PATCH /{project}/_apis/wit/fields/{fieldNameOrRefName}: requestBody application/json schema $ref changed from "#/components/schemas/UpdateWorkItemField" to "#/components/schemas/FieldUpdate"operation PATCH /{project}/_apis/wit/fields/{fieldNameOrRefName}: response 200 application/json schema $ref changed from "#/components/schemas/WorkItemField" to "#/components/schemas/WorkItemField2"operation PATCH /{project}/_apis/wit/workItems/{workItemId}/comments/{commentId}: operationId changed from "Comments_Update" to "Comments_Update Comment"operation POST /{project}/_apis/wit/fields: requestBody application/json schema $ref changed from "#/components/schemas/WorkItemField" to "#/components/schemas/WorkItemField2"operation POST /{project}/_apis/wit/fields: response 200 application/json schema $ref changed from "#/components/schemas/WorkItemField" to "#/components/schemas/WorkItemField2"operation POST /{project}/_apis/wit/workItems/{workItemId}/comments: operationId changed from "Comments_Add" to "Comments_Add Comment"schema Comment: property format addedschema Comment: property renderedText addedschema FieldUpdate addedschema GitHubConnectionModel addedschema GitHubConnectionRepoModel addedschema GitHubConnectionReposBatchRequest addedschema TemporaryQueryRequestModel addedschema TemporaryQueryResponseModel addedschema WorkItemComment: property format addedschema WorkItemComment: property renderedText addedschema WorkItemDeleteBatch addedschema WorkItemDeleteBatchRequest addedschema WorkItemField2 addedschema WorkItemFieldAllowedValues addedschema WorkItemTagDefinition: property lastUpdated addedschema WorkItemTypeColorAndIcon: property isDisabled added
|
Work (work)
| Versions | Change | Changes |
| 7.1 vs 7.0 | additive | schema BoardRow: property color addedschema Plan: property lastAccessed added
|