Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
This article lists the current and past versions of the Management REST APIs for Azure AI Search.
Versioned API docs
REST API docs are versioned. When you open an API reference page, select the API version from the dropdown filter.
Stable versions
| API version | Specification | API updates |
|---|---|---|
2025-05-01 (Latest) |
Swagger specification | Release note |
2023-11-01 |
Swagger specification | Release note |
2022-09-01 |
Swagger specification | Release note |
2020-08-01 |
Swagger specification | Release note |
2020-03-13 |
Swagger specification | Release note |
2015-08-19 |
Swagger specification | Release note |
Preview versions
Preview versions are released to test new functionality, gather feedback, and discover and fix issues. Preview APIs are available under Supplemental Terms of Use and aren't recommended for production workloads.
| API version | Specification | API updates |
|---|---|---|
2025-02-01-Preview (Latest) |
Swagger specification | Release note |
2024-06-01-Preview |
Swagger specification | Release note |
2024-03-01-Preview |
Swagger specification | Release note |
2021-04-01-Preview |
Swagger specification | Release note |
2020-08-01-Preview |
Swagger specification | Release note |
2019-10-01-Preview |
Swagger specification | Release note |
Release notes
2025-05-01
This generally available version makes the following updates:
| Update | REST API |
|---|---|
| Promotes service upgrade from preview to general availability. | Upgrade Service |
| Promotes pricing tier change from preview to general availability. | Update Service (sku property) |
| Promotes user-assigned managed identity from preview to general availability. | Update Service (identity property) |
2025-02-01-Preview
This preview version makes the following updates:
| Update | REST API |
|---|---|
| Adds support for upgrading your search service. If you created your service before April 2024 in a supported region, perform a one-time upgrade to get higher storage and vector limits. | Upgrade Service |
| Adds support for changing your pricing tier. Currently, you can only switch between Basic and Standard (S1, S2, and S3) tiers. | Update Service (sku property) |
2024-06-01-Preview
This preview version makes the following updates:
| Update | REST API |
|---|---|
| Adds support for assigning your search service to a network security perimeter. | Network Security Perimeter Configurations |
Adds the AzureServices value to NetworkRuleSet.Bypass. If requests originate from a trusted service on Azure, you can bypass the network IP rules. |
Create or Update Service and Update Service (NetworkRuleSet.Bypass property) |
Adds support for renaming SearchService.ProvisioningState to uppercase, such as changing succeeded to Succeeded. |
Create or Update Service and Update Service (SearchService.ProvisioningState property) |
2024-03-01-Preview
This preview version makes the following updates:
| Update | REST API |
|---|---|
| Adds APIs for network security perimeter, which isn't currently available. | Network Security Perimeter Configurations |
2023-11-01
This generally available version makes the following updates:
| Update | REST API |
|---|---|
| Promotes semantic ranking from preview to general availability. | Create or Update Service and Update Service |
2022-09-01
This generally available version makes the following updates:
| Update | REST API |
|---|---|
| Adds authentication properties to the applicable REST APIs. | Create or Update Service and Update Service |
| Promotes role-based access control from preview to general availability. | Create or Update Service and Update Service |
2021-04-01-Preview
This preview version makes the following updates:
| Update | REST API |
|---|---|
| Adds support for enabling or disabling role-based access control on your search service. | Create or Update Service and Update Service |
| Adds support for enabling or disabling semantic ranker on your search service. | Create or Update Service and Update Service |
| Adds support for customer-managed keys to enforce encryption of data plane resources. Existing search services that don't meet this requirement are marked as noncompliant. | Create or Update Service and Update Service |
Adds support for disabling workloads that push data from Azure AI Search to external resources. Setting properties.disabledDataExfiltrationOptions to "All" disables Power Query connectors, debug sessions, enrichment cache, knowledge stores, and skillsets with custom skills. |
Create or Update Service and Update Service (disabledDataExfiltrationOptions property) |
2020-08-01-Preview
This preview version adds sharedPrivateLinkResources support for two new resource types. New groupId values include mysqlServer (Azure database for MySQL) and sites (Azure Functions/app services).
2020-08-01
This generally available version adds Shared Private Link Resources support for all outbound-accessed resources except those noted in the preview version.
2020-03-13
This generally available version adds Private Endpoint Connections support through Azure Private Link, and network IP rules for new services.
2019-10-01-Preview
This is the first preview version. No preview features are introduced in this list. This preview is functionally equivalent to 2020-03-13 and remains available. Any script or code that calls that version works, but we recommend using a more recent generally available or preview API version to get the same results.
2015-08-19
This is the initial release of the Management REST API. It provided APIs for creating and deleting a search service, provisioning replicas and partitions, and managing API keys.