Discover Information about an Endpoint

Discover information about the Search API, such as it's name, version, indexes and other configured options.

URL: /api/discovery/

Method: GET

Content-Type: application/json

Discovery Response

Attribute	Description
apiVersion number	The version of the API. This number only increases if a breaking change occurs.
serverVersion string	The version of the Universal Search Server software running on this Endpoint.
displayName string	The display name of this endpoint.
indexes array	Array of Index names available to search on this Endpoint
issues array	Array of detected configuration issues present that may hinder normal operation.
stemmingFiles array	Array of StemmingFile filenames this endpoint support.
thesaurusFiles array	Array of Thesaurus Filenames this endpoint supports.
alphabetFiles array	Array of Alphabet filenames this endpoint supports.

Example

Response to a GET request to /api/discovery

{
    "apiVersion": 1,
    "serverVersion": null,
    "displayName": "Contoso",

    "indexes": [
        "Classics",

        "Legal Documents",        
    ],
    "issues": [],
    "stemmingFiles": [
        "stemming"
    ],
    "thesaurusFiles": [
        "colours",
        "currencies",
        "irregular nouns",
        "irregular verbs"
    ],
    "alphabetFiles": [
        "default",
        "English"
    ]
}

---

Last update: June 21, 2020