Get Indexer (Azure Search Service REST API)

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

Request

HTTPS is required for all services requests. The Get Indexer request can be constructed using the GET method.

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

The [indexer name] in the request URI specifies which indexer definition to return from the indexers collection.

The [api-version] is required. The current version is 2019-05-06. See API versions in Azure Search for details.

Request Headers

The following list describes the required and optional request headers.

Request Header Description
Content-Type: Required. Set this to application/json.
api-key: Required. The api-key is used to authenticate the request to your Search service. It is a string value, unique to your service. The Get Indexer request must include an api-key header set to your admin key (as opposed to a query key).

You will also need the service name to construct the request URL. You can get both the service name and api-key from your service dashboard in the Azure portal. See Create an Azure Search services 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 Search Service 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 }  
    }  

See also

Azure Search Service REST
HTTP status codes (Azure Search)
Indexer operations (Azure Search Service REST API)
Naming rules (Azure Search)
API versions in Azure Search