Get Indexer (Azure AI Search REST API)

  • Article

The Get Indexer operation gets the indexer definition from Azure AI Search.

GET https://[service name].search.windows.net/indexers/[indexer name]?api-version=[api-version]  
  Content-Type: application/json  
  api-key: [admin key]

URI Parameters

Parameter Description
service name Required. Set to the unique, user-defined name of your search service.
indexer name Required. The request URI specifies the name of the indexer to return.
api-version See API versions for a list of supported versions.

Request Headers

The following table describes the required and optional request headers.

Fields Description
Content-Type Required. Set 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. If you're using API keys, specify an admin key (as opposed to a query key) to return object information from the search service. See Connect to Azure AI Search using key authentication for details.

Request Body

None.

Response

Status Code: 200 OK is returned for a successful response. The response is similar to examples in Create Indexer (Azure AI Search REST API):

{  
    "name" : "myindexer",  
    "description" : "a cool indexer",  
    "dataSourceName" : "ordersds",  
    "targetIndexName" : "orders",  
    "schedule" : { "interval" : "PT1H", "startTime" : "2015-01-01T00:00:00Z" },  
    "parameters" : { "maxFailedItems" : 10, "maxFailedItemsPerBatch" : 5, "base64EncodeKeys": false },
    "encryptionKey": null
}

Note

If the indexer has an encryption key, the search service must have access to the encryption key to retrieve the indexer definition. Without access to the encryption key, a 400 Bad Request is returned. Restoring access to the key allows the search service to retrieve the indexer definition again.

See also