APIHub
Back to Explore

SearchServiceClient

Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.

Cloud
none
HTTPS
CORS: Unknown
Visit official documentation

Latency

5ms p95

Uptime

0.0% 30d

Playground

Verified

live

Endpoints

REST · JSON
GET

/datasources

Lists all datasources available for a search service.

  • $select (query) — Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
POST

/datasources

Creates a new datasource.

  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
DELETE

/datasources('{dataSourceName}')

Deletes a datasource.

  • dataSourceName (path, required) — The name of the datasource to delete.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • api-version (query, required) — Client Api Version.
GET

/datasources('{dataSourceName}')

Retrieves a datasource definition.

  • dataSourceName (path, required) — The name of the datasource to retrieve.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
PUT

/datasources('{dataSourceName}')

Creates a new datasource or updates a datasource if it already exists.

  • dataSourceName (path, required) — The name of the datasource to create or update.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • Prefer (header, required) — For HTTP PUT requests, instructs the service to return the created/updated resource on success.
  • api-version (query, required) — Client Api Version.
GET

/indexers

Lists all indexers available for a search service.

  • $select (query) — Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
POST

/indexers

Creates a new indexer.

  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
POST

/synonymmaps

Creates a new synonym map.

  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
DELETE

/indexers('{indexerName}')

Deletes an indexer.

  • indexerName (path, required) — The name of the indexer to delete.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • api-version (query, required) — Client Api Version.
GET

/indexers('{indexerName}')

Retrieves an indexer definition.

  • indexerName (path, required) — The name of the indexer to retrieve.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
PUT

/indexers('{indexerName}')

Creates a new indexer or updates an indexer if it already exists.

  • indexerName (path, required) — The name of the indexer to create or update.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • Prefer (header, required) — For HTTP PUT requests, instructs the service to return the created/updated resource on success.
  • api-version (query, required) — Client Api Version.
POST

/indexers('{indexerName}')/search.reset

Resets the change tracking state associated with an indexer.

  • indexerName (path, required) — The name of the indexer to reset.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
POST

/indexers('{indexerName}')/search.run

Runs an indexer on-demand.

  • indexerName (path, required) — The name of the indexer to run.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
GET

/indexers('{indexerName}')/search.status

Returns the current status and execution history of an indexer.

  • indexerName (path, required) — The name of the indexer for which to retrieve status.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
GET

/indexes

Lists all indexes available for a search service.

  • $select (query) — Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
POST

/indexes

Creates a new search index.

  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
DELETE

/indexes('{indexName}')

Deletes a search index and all the documents it contains.

  • indexName (path, required) — The name of the index to delete.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • api-version (query, required) — Client Api Version.
GET

/indexes('{indexName}')

Retrieves an index definition.

  • indexName (path, required) — The name of the index to retrieve.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
DELETE

/synonymmaps('{synonymMapName}')

Deletes a synonym map.

  • synonymMapName (path, required) — The name of the synonym map to delete.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • api-version (query, required) — Client Api Version.
PUT

/indexes('{indexName}')

Creates a new search index or updates an index if it already exists.

  • indexName (path, required) — The definition of the index to create or update.
  • allowIndexDowntime (query) — Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • Prefer (header, required) — For HTTP PUT requests, instructs the service to return the created/updated resource on success.
  • api-version (query, required) — Client Api Version.
POST

/indexes('{indexName}')/search.analyze

Shows how an analyzer breaks text into tokens.

  • indexName (path, required) — The name of the index for which to test an analyzer.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
GET

/indexes('{indexName}')/search.stats

Returns statistics for the given index, including a document count and storage usage.

  • indexName (path, required) — The name of the index for which to retrieve statistics.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
GET

/servicestats

Gets service level statistics for a search service.

  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
GET

/skillsets

List all skillsets in a search service.

  • $select (query) — Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
POST

/skillsets

Creates a new skillset in a search service.

  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
DELETE

/skillsets('{skillsetName}')

Deletes a skillset in a search service.

  • skillsetName (path, required) — The name of the skillset to delete.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • api-version (query, required) — Client Api Version.
GET

/skillsets('{skillsetName}')

Retrieves a skillset in a search service.

  • skillsetName (path, required) — The name of the skillset to retrieve.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
PUT

/skillsets('{skillsetName}')

Creates a new skillset in a search service or updates the skillset if it already exists.

  • skillsetName (path, required) — The name of the skillset to create or update.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • Prefer (header, required) — For HTTP PUT requests, instructs the service to return the created/updated resource on success.
  • api-version (query, required) — Client Api Version.
GET

/synonymmaps

Lists all synonym maps available for a search service.

  • $select (query) — Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
GET

/synonymmaps('{synonymMapName}')

Retrieves a synonym map definition.

  • synonymMapName (path, required) — The name of the synonym map to retrieve.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • api-version (query, required) — Client Api Version.
PUT

/synonymmaps('{synonymMapName}')

Creates a new synonym map or updates a synonym map if it already exists.

  • synonymMapName (path, required) — The name of the synonym map to create or update.
  • client-request-id (header) — The tracking ID sent with the request to help with debugging.
  • If-Match (header) — Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.
  • If-None-Match (header) — Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.
  • Prefer (header, required) — For HTTP PUT requests, instructs the service to return the created/updated resource on success.
  • api-version (query, required) — Client Api Version.

31 endpoints auto-detected

curl -X GET \
  "https://azure.local/datasources"

azure.local · HTTPS only