Update Data Source (Azure AI Search REST API)
Important
This API reference is for a legacy version. See Data plane REST operations for updated reference documentation. Use the filter on the top left to select a version.
Overwrites an existing data source definition with a revised version.
PUT https://[service name].search.windows.net/datasources/[data source name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
URI Parameters
| Parameter | Description |
|---|---|
| service name | Required. Set this to the unique, user-defined name of your search service. |
| data source name | Required. The request URI specifies the name of the data source to update. |
| api-version | Required. The current stable version is api-version=2020-06-30. See API versions for more versions. |
Request Headers
The following table describes the required and optional request headers.
| Fields | Description |
|---|---|
| Content-Type | Required. Set this to application/json |
| api-key | Optional if you're using Azure roles and a bearer token is provided on the request, otherwise a key is required. An api-key is a unique, system-generated string that authenticates the request to your search service. Update requests must include an api-key header set to your admin key (as opposed to a query key). See Connect to Azure AI Search using key authentication for details. |
Request Body
The request body syntax is the same as for Create Data Source.
When updating an existing data source, the entire definition is replaced with the contents of the request body. In general, the best pattern to use for updates is to retrieve the data source definition with a GET, modify it, and then update it with PUT.
Response
For a successful request: 201 Created if a new data source was created, and 204 No Content if an existing data source was updated
Note
Some properties cannot be updated on an existing data source. For example, you cannot change the type of an existing data source.