Azure AI Search data plane
Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.
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 63
- GETAliases_List
/aliases?api-version=string&search=string&pageSize=1&searchType=prefixLists all aliases available for a search service. - POSTAliases_Create
/aliases?api-version=stringCreates a new search alias. - GETAliases_Get
/aliases(':aliasName')?api-version=stringRetrieves an alias definition. - PUTAliases_CreateOrUpdate
/aliases(':aliasName')?api-version=stringCreates a new search alias or updates an alias if it already exists. - DELETEAliases_Delete
/aliases(':aliasName')?api-version=stringDeletes a search alias and its associated mapping to an index. This operation is permanent, with no recovery option. The mapped index is untouched by this… - GETDataSources_List
/datasources?api-version=string&$select=string&search=string&pageSize=1&searchType=prefixLists all datasources available for a search service. - POSTDataSources_Create
/datasources?api-version=stringCreates a new datasource. - 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. - GETIndexers_List
/indexers?api-version=string&$select=string&search=string&pageSize=1&searchType=prefixLists all indexers available for a search service. - POSTIndexers_Create
/indexers?api-version=stringCreates a new indexer. - 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. - POSTIndexers_Reset
/indexers(':indexerName')/search.reset?api-version=stringResets the change tracking state associated with an indexer. - POSTIndexers_Resync
/indexers(':indexerName')/search.resync?api-version=stringResync selective options from the datasource to be re-ingested by the indexer." - POSTIndexers_Run
/indexers(':indexerName')/search.run?api-version=stringRuns an indexer on-demand. - GETIndexers_GetStatus
/indexers(':indexerName')/search.status?api-version=stringReturns the current status and execution history of an indexer. - GETIndexes_List
/indexes?api-version=string&search=string&pageSize=1&searchType=prefixLists 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')?api-version=string&allowIndexDowntime=trueCreates 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… - GETDocuments_SearchGet
/indexes(':indexName')/docs?api-version=string&search=string&$count=true&facet=string&$filter=string&highlight=string&highlightPostTag=string&highlightPreTag=string&minimumCoverage=0.0&moreLikeThis=string&$orderby=string&queryType=simple&scoringParameter=string&scoringProfile=string&searchFields=string&searchMode=any&scoringStatistics=local&sessionId=string&$select=string&$skip=0&$top=0&semanticConfiguration=string&semanticErrorHandling=partial&semanticMaxWaitInMilliseconds=700&answers=none&captions=none&semanticQuery=string&debug=disabledSearches for documents in the index. - GETDocuments_Count
/indexes(':indexName')/docs/$count?api-version=stringQueries the number of documents in the index. - GETDocuments_AutocompleteGet
/indexes(':indexName')/docs/search.autocomplete?api-version=string&search=string&suggesterName=string&autocompleteMode=oneTerm&$filter=string&fuzzy=true&highlightPostTag=string&highlightPreTag=string&minimumCoverage=0.0&searchFields=string&$top=0Autocompletes incomplete query terms based on input text and matching terms in the index. - POSTDocuments_Index
/indexes(':indexName')/docs/search.index?api-version=stringSends a batch of document write actions to the index. - POSTDocuments_AutocompletePost
/indexes(':indexName')/docs/search.post.autocomplete?api-version=stringAutocompletes incomplete query terms based on input text and matching terms in the index. - POSTDocuments_SearchPost
/indexes(':indexName')/docs/search.post.search?api-version=stringSearches for documents in the index. - POSTDocuments_SuggestPost
/indexes(':indexName')/docs/search.post.suggest?api-version=stringSuggests documents in the index that match the given partial query text. - GETDocuments_SuggestGet
/indexes(':indexName')/docs/search.suggest?api-version=string&search=string&suggesterName=string&$filter=string&fuzzy=true&highlightPostTag=string&highlightPreTag=string&minimumCoverage=0.0&$orderby=string&searchFields=string&$select=string&$top=0Suggests documents in the index that match the given partial query text. - GETDocuments_Get
/indexes(':indexName')/docs(':key')?api-version=string&$select=stringRetrieves a document from the index. - POSTIndexes_Analyze
/indexes(':indexName')/search.analyze?api-version=stringShows how an analyzer breaks text into tokens. - GETIndexes_GetStatistics
/indexes(':indexName')/search.stats?api-version=stringReturns statistics for the given index, including a document count and storage usage. - GETGetIndexStatsSummary
/indexstats?api-version=string&search=string&pageSize=1&searchType=prefixRetrieves a summary of statistics for all indexes in the search service. - GETKnowledgeBases_List
/knowledgebases?api-version=string&search=string&pageSize=1&searchType=prefixLists all knowledge bases available for a search service. - POSTKnowledgeBases_Create
/knowledgebases?api-version=stringCreates a new knowledge base. - GETKnowledgeBases_Get
/knowledgebases(':knowledgeBaseName')?api-version=stringRetrieves a knowledge base definition. - PUTKnowledgeBases_CreateOrUpdate
/knowledgebases(':knowledgeBaseName')?api-version=stringCreates a new knowledge base or updates a knowledge base if it already exists. - DELETEKnowledgeBases_Delete
/knowledgebases(':knowledgeBaseName')?api-version=stringDeletes a knowledge base. - POSTKnowledgeRetrieval_Retrieve
/knowledgebases(':knowledgeBaseName')/retrieve?api-version=stringKnowledgeBase retrieves relevant data from backing stores. - GETKnowledgeSources_List
/knowledgesources?api-version=string&search=string&pageSize=1&searchType=prefixLists all knowledge sources available for a search service. - POSTKnowledgeSources_Create
/knowledgesources?api-version=stringCreates a new knowledge source. - GETKnowledgeSources_Get
/knowledgesources(':sourceName')?api-version=stringRetrieves a knowledge source definition. - PUTKnowledgeSources_CreateOrUpdate
/knowledgesources(':sourceName')?api-version=stringCreates a new knowledge source or updates an knowledge source if it already exists. - DELETEKnowledgeSources_Delete
/knowledgesources(':sourceName')?api-version=stringDeletes an existing knowledge source. - GETKnowledgeSources_ListFiles
/knowledgesources(':sourceName')/files?api-version=string&prefix=string&search=string&pageSize=1&searchType=prefixLists all files in a File knowledge source. - POSTKnowledgeSources_UploadFileMultipart
/knowledgesources(':sourceName')/files?api-version=stringUploads a file to a File knowledge source using multipart/form-data: a JSON 'metadata' part (file name and custom metadata) and a 'content' part with the raw… - PUTKnowledgeSources_UpdateFile
/knowledgesources(':sourceName')/files(':fileId')?api-version=stringUpdates an existing file in a File knowledge source in place, replacing its indexed content. Uses multipart/form-data: a JSON 'metadata' part (file name and… - DELETEKnowledgeSources_DeleteFile
/knowledgesources(':sourceName')/files(':fileId')?api-version=stringDeletes a file from a File knowledge source and removes all indexed content derived from it. - GETKnowledgeSources_GetStatus
/knowledgesources(':sourceName')/status?api-version=stringRetrieves the status of a knowledge source. - GETGetServiceStatistics
/servicestats?api-version=stringGets service level statistics for a search service. - GETSkillsets_List
/skillsets?api-version=string&$select=string&search=string&pageSize=1&searchType=prefixList all skillsets in a search service. - POSTSkillsets_Create
/skillsets?api-version=stringCreates a new skillset in a search service. - 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. - GETSynonymMaps_List
/synonymmaps?api-version=string&$select=string&search=string&pageSize=1&searchType=prefixLists all synonym maps available for a search service. - POSTSynonymMaps_Create
/synonymmaps?api-version=stringCreates a new synonym map. - 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.
API details
- Authentication
- An API key in the api-key header
OAuth 2.0 (implicit flow) with 1 scope - Operations
- 63 operations on 37 pathsGET 27POST 18PUT 9DELETE 9
- Response formats
application/json- Description format
- Swagger 2.0, API version
2026-10-01 - Links
- OpenAPI document
How to test the Azure AI Search data plane in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure AI Search data plane collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the api-key header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Aliases_List” (GET /aliases?api-version=string&search=string&pageSize=1&searchType=prefix), 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 data plane?
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 63 endpoints.
Who publishes the Azure AI Search data plane?
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 data plane?
It accepts 2 methods: an API key in the api-key header; OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure AI Search data plane have?
63 operations on 37 paths (27 GET, 18 POST, 9 PUT, 9 DELETE).
Is forking the Azure AI Search data plane free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.