Compatibility

Products

ProductHighest API versionSourceVerified
Azure DevOps Services7.17.1 is the newest released version in the REST API referenceNot verified
Azure DevOps Server7.1its release notes describe 7.2-preview features, so it accepts 7.1Not verified
Azure DevOps Server 20227.0REST API versioning pageNot 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.

ImportAPI versionProducts
@hypothesi/azure-devops-api/7.07.0Azure DevOps Services, Azure DevOps Server, Azure DevOps Server 2022
@hypothesi/azure-devops-api/7.17.1Azure DevOps Services, Azure DevOps Server
@hypothesi/azure-devops-api/services7.1Azure DevOps Services, Azure DevOps Server
@hypothesi/azure-devops-api/server7.1Azure DevOps Services, Azure DevOps Server
@hypothesi/azure-devops-api/server-20227.0Azure 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.

ChangeRelease type
New API version entry point, such as 7.2Minor
Spec update with only identical or additive changesMinor
Spec update with a breaking change in a supported versionMajor
API version removed because its last product left mainstream supportMajor
Transport or helper fixPatch

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)

VersionsChangeChanges
7.1 vs 7.0identicalNone

PipelinePermissions, PipelinesChecks, Approval (approvalsAndChecks)

VersionsChangeChanges
7.1 vs 7.0additive
  • operation GET /{project}/_apis/pipelines/approvals: optional parameter query state added
  • operation GET /{project}/_apis/pipelines/approvals: optional parameter query top added
  • operation GET /{project}/_apis/pipelines/approvals: optional parameter query userIds added
  • schema ApprovalsQueryParameters: property approverStatus added
  • schema ApprovalsQueryParameters: property top added
  • schema ApprovalsQueryParameters: property userIds added
  • schema CheckConfiguration: property isDisabled added
  • schema CheckConfiguration: property issue added
  • schema CheckData: property defaultCheckSettings added
  • schema CheckIssue added
  • schema CheckIssueData added
  • schema ResourceCheckIssue added

Feed, Provenance, SBOM (artifacts)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema FeedIdsResult added
  • schema SBOMTelemetry: property taskName added
  • schema SBOMTelemetry: property telemetryId added
  • schema SignResponseBase: property result anyOf [0] enum value "failCanRetry" added

Maven, Npm, NuGet, PyPiApi, UPackApi (artifactsPackageTypes)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema PackageNuGet: property listed added

Audit (audit)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema AuditLogEntry: property actorClientId added
  • schema DecoratedAuditLogEntry: property actorClientId added

Build (build)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema Build: property appendCommitMessageToRunName added
  • schema PipelineGeneralSettings: property auditEnforceSettableVar added
  • schema PipelineGeneralSettings: property buildsEnabledForForks added
  • schema PipelineGeneralSettings: property disableClassicBuildPipelineCreation added
  • schema PipelineGeneralSettings: property disableClassicPipelineCreation added
  • schema PipelineGeneralSettings: property disableClassicReleasePipelineCreation added
  • schema PipelineGeneralSettings: property enableShellTasksArgsSanitizing added
  • schema PipelineGeneralSettings: property enableShellTasksArgsSanitizingAudit added
  • schema PipelineGeneralSettings: property enforceJobAuthScopeForForks added
  • schema PipelineGeneralSettings: property enforceNoAccessToSecretsFromForks added
  • schema PipelineGeneralSettings: property forkProtectionEnabled added
  • schema PipelineGeneralSettings: property isCommentRequiredForPullRequest added
  • schema PipelineGeneralSettings: property requireCommentsForNonTeamMemberAndNonContributors added
  • schema PipelineGeneralSettings: property requireCommentsForNonTeamMembersOnly added
  • schema PipelineTriggerSettings added
  • schema PullRequestTrigger: property pipelineTriggerSettings added

Core (core)

VersionsChangeChanges
7.1 vs 7.0breaking
  • operation GET /_apis/projects: parameter query continuationToken schema format added
  • operation GET /_apis/projects: parameter query continuationToken schema type changed from "string" to "integer"
  • schema CategorizedWebApiTeams added
  • schema TeamProjectCollectionReference: property avatarUrl added

Dashboard (dashboard)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema Dashboard: property lastAccessedDate added
  • schema Dashboard: property modifiedBy added
  • schema Dashboard: property modifiedDate added

Elastic, Task, TaskAgent (distributedTask)

VersionsChangeChanges
7.1 vs 7.0breaking
  • operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "assignedPendingDelete" added
  • operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "failedToRestartPendingDelete" added
  • operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "failedToStartPendingDelete" added
  • operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "failedVMPendingDelete" added
  • operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "reimagingCompute" added
  • operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "restartingAgent" added
  • operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "retryDelete" added
  • operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "unhealthyVm" added
  • operation GET /_apis/distributedtask/elasticpools/{poolId}/nodes: parameter query $state schema enum value "unhealthyVmPendingDelete" added
  • operation 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 removed
  • operation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: parameter query includeCapabilities removed
  • operation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: parameter query includeLastCompletedRequest removed
  • operation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: parameter query propertyFilters removed
  • operation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: required parameter query isCheckPermissions added
  • operation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: response 200 application/json schema $ref removed
  • operation GET /_apis/distributedtask/pools/{poolId}/agents/{agentId}: response 200 application/json schema type added
  • schema ElasticNode: property computeState anyOf [0] enum value "reimaging" added
  • schema ElasticNode: property computeState anyOf [0] enum value "unhealthyVm" added
  • schema ElasticNode: property computeState anyOf [0] enum value "unhealthyVmssVm" added
  • schema ElasticNode: property desiredState anyOf [0] enum value "assignedPendingDelete" added
  • schema ElasticNode: property desiredState anyOf [0] enum value "failedToRestartPendingDelete" added
  • schema ElasticNode: property desiredState anyOf [0] enum value "failedToStartPendingDelete" added
  • schema ElasticNode: property desiredState anyOf [0] enum value "failedVMPendingDelete" added
  • schema ElasticNode: property desiredState anyOf [0] enum value "reimagingCompute" added
  • schema ElasticNode: property desiredState anyOf [0] enum value "restartingAgent" added
  • schema ElasticNode: property desiredState anyOf [0] enum value "retryDelete" added
  • schema ElasticNode: property desiredState anyOf [0] enum value "unhealthyVm" added
  • schema ElasticNode: property desiredState anyOf [0] enum value "unhealthyVmPendingDelete" added
  • schema ElasticNode: property state anyOf [0] enum value "assignedPendingDelete" added
  • schema ElasticNode: property state anyOf [0] enum value "failedToRestartPendingDelete" added
  • schema ElasticNode: property state anyOf [0] enum value "failedToStartPendingDelete" added
  • schema ElasticNode: property state anyOf [0] enum value "failedVMPendingDelete" added
  • schema ElasticNode: property state anyOf [0] enum value "reimagingCompute" added
  • schema ElasticNode: property state anyOf [0] enum value "restartingAgent" added
  • schema ElasticNode: property state anyOf [0] enum value "retryDelete" added
  • schema ElasticNode: property state anyOf [0] enum value "unhealthyVm" added
  • schema ElasticNode: property state anyOf [0] enum value "unhealthyVmPendingDelete" added
  • schema ElasticNodeSettings: property state anyOf [0] enum value "assignedPendingDelete" added
  • schema ElasticNodeSettings: property state anyOf [0] enum value "failedToRestartPendingDelete" added
  • schema ElasticNodeSettings: property state anyOf [0] enum value "failedToStartPendingDelete" added
  • schema ElasticNodeSettings: property state anyOf [0] enum value "failedVMPendingDelete" added
  • schema ElasticNodeSettings: property state anyOf [0] enum value "reimagingCompute" added
  • schema ElasticNodeSettings: property state anyOf [0] enum value "restartingAgent" added
  • schema ElasticNodeSettings: property state anyOf [0] enum value "retryDelete" added
  • schema ElasticNodeSettings: property state anyOf [0] enum value "unhealthyVm" added
  • schema ElasticNodeSettings: property state anyOf [0] enum value "unhealthyVmPendingDelete" added
  • schema ElasticPool: property orchestrationType added
  • schema ElasticPoolSettings: property orchestrationType added
  • schema JObject removed
  • schema JObjectTask added
  • schema JObjectTaskAgent added
  • schema 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 added
  • schema 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 added
  • schema TimelineRecord: property agentSpecification anyOf [0] $ref changed from "#/components/schemas/JObject" to "#/components/schemas/JObjectTaskAgent"

ExtensionManagement (extensionManagement)

VersionsChangeChanges
7.1 vs 7.0identicalNone

Favorite (favorite)

No earlier version to compare.

Git (git)

VersionsChangeChanges
7.1 vs 7.0additive
  • operation GET /{project}/_apis/git/pullrequests: optional parameter query searchCriteria.maxTime added
  • operation GET /{project}/_apis/git/pullrequests: optional parameter query searchCriteria.minTime added
  • operation GET /{project}/_apis/git/pullrequests: optional parameter query searchCriteria.queryTimeRangeType added
  • operation GET /{project}/_apis/git/repositories/{repositoryId}/items: optional parameter query zipForUnix added
  • operation GET /{project}/_apis/git/repositories/{repositoryId}/pullrequests: optional parameter query searchCriteria.maxTime added
  • operation GET /{project}/_apis/git/repositories/{repositoryId}/pullrequests: optional parameter query searchCriteria.minTime added
  • operation GET /{project}/_apis/git/repositories/{repositoryId}/pullrequests: optional parameter query searchCriteria.queryTimeRangeType added
  • schema AdvSecEnablementStatus added
  • schema AdvSecEnablementUpdate added
  • schema BillableCommitter added
  • schema BillableCommitterDetail added
  • schema GitCommitRef: property commitTooManyChanges added
  • schema GitPullRequestIteration: property reason anyOf [0] enum value "resolveConflicts" added
  • schema GitPullRequestSearchCriteria: property maxTime added
  • schema GitPullRequestSearchCriteria: property minTime added
  • schema GitPullRequestSearchCriteria: property queryTimeRangeType added
  • schema GitRepository: property isInMaintenance added
  • schema IdentityRefWithVote: property isReapprove added
  • schema TeamProjectCollectionReference: property avatarUrl added

Graph (graph)

VersionsChangeChanges
7.1 vs 7.0breaking
  • schema AadGraphMember added
  • schema GraphServicePrincipal added
  • schema GraphServicePrincipalCreationContext added
  • schema GraphServicePrincipalOriginIdCreationContext added
  • schema GraphServicePrincipalOriginIdUpdateContext added
  • schema GraphServicePrincipalUpdateContext added
  • schema GraphUser: allOf [0] $ref changed from "#/components/schemas/GraphMember" to "#/components/schemas/AadGraphMember"
  • schema GraphUser: property directoryAlias removed
  • schema GraphUser: property isDeletedInOrigin removed
  • schema GraphUser: property metaType removed
  • schema GraphUserPrincipalNameUpdateContext added
  • schema IdentityMapping added
  • schema IdentityMappings added
  • schema MappingResult added
  • schema PagedGraphMembers added
  • schema PagedGraphServicePrincipals added
  • schema ResolveDisconnectedUsersResponse added
  • schema UserPrincipalName added

ServiceHooks (hooks)

VersionsChangeChanges
7.1 vs 7.0identicalNone

Identity (ims)

VersionsChangeChanges
7.1 vs 7.0identicalNone

MemberEntitlementManagement (memberEntitlementManagement)

VersionsChangeChanges
7.1 vs 7.0breaking
  • operation GET /_apis/userentitlements: response 200 application/json schema $ref changed from "#/components/schemas/PagedGraphMemberList" to "#/components/schemas/PagedUserEntitlementsList"
  • schema AadGraphMember added
  • schema EntitlementBase added
  • schema EntitlementOperationResultBase added
  • schema GraphServicePrincipal added
  • schema GraphUser: allOf [0] $ref changed from "#/components/schemas/GraphMember" to "#/components/schemas/AadGraphMember"
  • schema GraphUser: property directoryAlias removed
  • schema GraphUser: property isDeletedInOrigin removed
  • schema GraphUser: property metaType removed
  • schema MemberEntitlement2 added
  • schema MemberEntitlement2OperationReference added
  • schema MemberEntitlement2OperationResult added
  • schema MemberEntitlement2PatchResponse added
  • schema MemberEntitlement2PostResponse added
  • schema MemberEntitlement2ResponseBase added
  • schema PagedUserEntitlementsList added
  • schema ServicePrincipalEntitlement added
  • schema ServicePrincipalEntitlementOperationReference added
  • schema ServicePrincipalEntitlementOperationResult added
  • schema ServicePrincipalEntitlementsPatchResponse added
  • schema ServicePrincipalEntitlementsPostResponse added
  • schema ServicePrincipalEntitlementsResponseBase added
  • schema UserEntitlement: allOf added
  • schema UserEntitlement: property accessLevel removed
  • schema UserEntitlement: property dateCreated removed
  • schema UserEntitlement: property groupAssignments removed
  • schema UserEntitlement: property id removed
  • schema UserEntitlement: property lastAccessedDate removed
  • schema UserEntitlement: property projectEntitlements removed
  • schema UserEntitlementOperationResult: allOf added
  • schema UserEntitlementOperationResult: property errors removed
  • schema UserEntitlementOperationResult: property isSuccess removed
  • schema UserEntitlementOperationResult: property result removed

Notification (notification)

VersionsChangeChanges
7.1 vs 7.0identicalNone

Operations (operations)

VersionsChangeChanges
7.1 vs 7.0identicalNone

PermissionsReport (permissionsReport)

VersionsChangeChanges
7.1 vs 7.0identicalNone

Pipelines (pipelines)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema Container added
  • schema ContainerResource added
  • schema PipelineResource added
  • schema Run: property templateParameters added
  • schema RunResources: property containers added
  • schema RunResources: property pipelines added

Policy (policy)

VersionsChangeChanges
7.1 vs 7.0identicalNone

WorkItemTrackingProcessTemplate (processadmin)

VersionsChangeChanges
7.1 vs 7.0identicalNone

WorkItemTracking (processes)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema FieldModel: property isLocked added
  • schema ProcessWorkItemTypeField: property isLocked added

Profile (profile)

VersionsChangeChanges
7.1 vs 7.0identicalNone

Release (release)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema DeploymentManualInterventionPendingEvent: property approval added
VersionsChangeChanges
7.1 vs 7.0identicalNone

Security (security)

VersionsChangeChanges
7.1 vs 7.0identicalNone

SecurityRoles (securityRoles)

VersionsChangeChanges
7.1 vs 7.0identicalNone

ServiceEndpoint (serviceEndpoint)

VersionsChangeChanges
7.1 vs 7.0additive
  • operation GET /{project}/_apis/serviceendpoint/endpoints?: optional parameter query actionFilter added
  • schema AzureSpnOperationStatus: property severity added
  • schema ServiceEndpointExecutionData: property ownerDetails added

Status (status)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema LiveSiteEvent: property isDeleted added
  • schema StatusImpact added

Symbol (symbol)

VersionsChangeChanges
7.1 vs 7.0identicalNone

Test (test)

VersionsChangeChanges
7.1 vs 7.0breaking
  • schema CodeCoverageSummary: property coverageDetailedSummaryStatus added
  • schema TestLogStoreAttachment added
  • schema TestLogStoreAttachmentReference added
  • schema TestResultFailureType added
  • schema TestResultFailureTypeRequestModel added
  • schema TestRunSummary2: property testRunStatsId format changed from "int32" to "int64"

TestPlan (testPlan)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema ExportTestCaseParams added

TestResults (testResults)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema CodeCoverageSummary: property coverageDetailedSummaryStatus added
  • schema TestLogStoreAttachment added
  • schema TestLogStoreAttachmentReference added
  • schema TestResultFailureType added
  • schema TestResultFailureTypeRequestModel added

Tfvc (tfvc)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema GitRepository: property isInMaintenance added
  • schema TeamProjectCollectionReference: property avatarUrl added

TokenAdmin (tokenAdmin)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema SessionTokenResult: property sessionTokenError anyOf [0] enum value "deploymentHostNotSupported" added
  • schema SessionTokenResult: property sessionTokenError anyOf [0] enum value "invalidAudience" added
  • schema SessionTokenResult: property sessionTokenError anyOf [0] enum value "invalidSubject" added
  • schema SessionTokenResult: property sessionTokenError anyOf [0] enum value "invalidTokenType" added

Tokens (tokens)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema PatTokenResult: property patTokenError anyOf [0] enum value "deploymentHostNotSupported" added
  • schema PatTokenResult: property patTokenError anyOf [0] enum value "invalidAudience" added
  • schema PatTokenResult: property patTokenError anyOf [0] enum value "invalidSubject" added
  • schema PatTokenResult: property patTokenError anyOf [0] enum value "invalidTokenType" added

Wiki (wiki)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema GitRepository: property isInMaintenance added
  • schema TeamProjectCollectionReference: property avatarUrl added

WorkItemTracking (wit)

VersionsChangeChanges
7.1 vs 7.0breaking
  • 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 added
  • schema Comment: property renderedText added
  • schema FieldUpdate added
  • schema GitHubConnectionModel added
  • schema GitHubConnectionRepoModel added
  • schema GitHubConnectionReposBatchRequest added
  • schema TemporaryQueryRequestModel added
  • schema TemporaryQueryResponseModel added
  • schema WorkItemComment: property format added
  • schema WorkItemComment: property renderedText added
  • schema WorkItemDeleteBatch added
  • schema WorkItemDeleteBatchRequest added
  • schema WorkItemField2 added
  • schema WorkItemFieldAllowedValues added
  • schema WorkItemTagDefinition: property lastUpdated added
  • schema WorkItemTypeColorAndIcon: property isDisabled added

Work (work)

VersionsChangeChanges
7.1 vs 7.0additive
  • schema BoardRow: property color added
  • schema Plan: property lastAccessed added