Microsoft Azure

Azure AI Search: Searchservice

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

AI & machine learning#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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

Endpoints 31

DataSources

  • GETDataSources_Get/datasources(':dataSourceName')?api-version=stringRetrieves a datasource definition.
  • PUTDataSources_CreateOrUpdate/datasources(':dataSourceName')?api-version=stringCreates a new datasource or updates a datasource if it already exists.
  • DELETEDataSources_Delete/datasources(':dataSourceName')?api-version=stringDeletes a datasource.
  • GETDataSources_List/datasources?$select=string&api-version=stringLists all datasources available for a search service.
  • POSTDataSources_Create/datasources?api-version=stringCreates a new datasource.

Indexers

  • POSTIndexers_Reset/indexers(':indexerName')/search.reset?api-version=stringResets the change tracking state associated with an indexer.
  • POSTIndexers_Run/indexers(':indexerName')/search.run?api-version=stringRuns an indexer on-demand.
  • GETIndexers_Get/indexers(':indexerName')?api-version=stringRetrieves an indexer definition.
  • PUTIndexers_CreateOrUpdate/indexers(':indexerName')?api-version=stringCreates a new indexer or updates an indexer if it already exists.
  • DELETEIndexers_Delete/indexers(':indexerName')?api-version=stringDeletes an indexer.
  • GETIndexers_List/indexers?$select=string&api-version=stringLists all indexers available for a search service.
  • POSTIndexers_Create/indexers?api-version=stringCreates a new indexer.
  • GETIndexers_GetStatus/indexers(':indexerName')/search.status?api-version=stringReturns the current status and execution history of an indexer.

Skillsets

  • GETSkillsets_Get/skillsets(':skillsetName')?api-version=stringRetrieves a skillset in a search service.
  • PUTSkillsets_CreateOrUpdate/skillsets(':skillsetName')?api-version=stringCreates a new skillset in a search service or updates the skillset if it already exists.
  • DELETESkillsets_Delete/skillsets(':skillsetName')?api-version=stringDeletes a skillset in a search service.
  • GETSkillsets_List/skillsets?$select=string&api-version=stringList all skillsets in a search service.
  • POSTSkillsets_Create/skillsets?api-version=stringCreates a new skillset in a search service.

SynonymMaps

  • GETSynonymMaps_Get/synonymmaps(':synonymMapName')?api-version=stringRetrieves a synonym map definition.
  • PUTSynonymMaps_CreateOrUpdate/synonymmaps(':synonymMapName')?api-version=stringCreates a new synonym map or updates a synonym map if it already exists.
  • DELETESynonymMaps_Delete/synonymmaps(':synonymMapName')?api-version=stringDeletes a synonym map.
  • GETSynonymMaps_List/synonymmaps?$select=string&api-version=stringLists all synonym maps available for a search service.
  • POSTSynonymMaps_Create/synonymmaps?api-version=stringCreates a new synonym map.

Indexes

  • GETIndexes_List/indexes?$select=string&api-version=stringLists all indexes available for a search service.
  • POSTIndexes_Create/indexes?api-version=stringCreates a new search index.
  • GETIndexes_Get/indexes(':indexName')?api-version=stringRetrieves an index definition.
  • PUTIndexes_CreateOrUpdate/indexes(':indexName')?allowIndexDowntime=true&api-version=stringCreates a new search index or updates an index if it already exists.
  • DELETEIndexes_Delete/indexes(':indexName')?api-version=stringDeletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index…
  • GETIndexes_GetStatistics/indexes(':indexName')/search.stats?api-version=stringReturns statistics for the given index, including a document count and storage usage.
  • POSTIndexes_Analyze/indexes(':indexName')/search.analyze?api-version=stringShows how an analyzer breaks text into tokens.

Service

  • GETGetServiceStatistics/servicestats?api-version=stringGets service level statistics for a search service.

API details

Authentication
None declared in the description
Operations
31 operations on 16 pathsGET 13POST 8PUT 5DELETE 5
Main resources
Indexers 8Indexes 7DataSources 5Skillsets 5SynonymMaps 5Service 1
Response formats
application/json
Description format
Swagger 2.0, API version 2025-09-01

How to test the Azure AI Search: Searchservice in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Azure AI Search: Searchservice collection, without the publisher's secrets.
  3. Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
  4. Send a requestPick an endpoint, for example “DataSources_Get” (GET /datasources(':dataSourceName')?api-version=string), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Azure AI Search: Searchservice?

Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service. It is listed under AI & machine learning and has 31 endpoints.

Who publishes the Azure AI Search: Searchservice?

It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.

How do I authenticate with the Azure AI Search: Searchservice?

Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.

How many endpoints does the Azure AI Search: Searchservice have?

31 operations on 16 paths (13 GET, 8 POST, 5 PUT, 5 DELETE). The largest groups are Indexers, Indexes, DataSources, Skillsets.

Is forking the Azure AI Search: Searchservice free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.