Skip to main content
GET
/
1
/
configs
/
{indexName}
/
status
curl
curl --request GET \
  --url https://query-suggestions.us.algolia.com/1/configs/ALGOLIA_INDEX_NAME/status \
  --header 'accept: application/json' \
  --header 'x-algolia-api-key: ALGOLIA_API_KEY' \
  --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID'
{
  "indexName": "ALGOLIA_INDEX_NAME",
  "isRunning": false,
  "lastBuiltAt": "2023-07-05T08:03:53Z",
  "lastSuccessfulBuiltAt": "2023-07-05T08:03:53Z",
  "lastSuccessfulBuildDuration": 28
}
Required ACL: settings

Authorizations

​
x-algolia-application-id
string
header
required

Your Algolia application ID.

​
x-algolia-api-key
string
header
required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

​
indexName
string
required

Query Suggestions index name.

Example:

"ALGOLIA_INDEX_NAME"

Response

OK

​
indexName
string

Name of the Query Suggestions index (case-sensitive).

Example:

"ALGOLIA_INDEX_NAME"

​
isRunning
boolean

Whether the creation or update of the Query Suggestions index is in progress.

Example:

false

​
lastBuiltAt
string

Date and time when the Query Suggestions index was last built, in RFC 3339 format.

Example:

"2023-07-05T08:03:53Z"

​
lastSuccessfulBuiltAt
string

Date and time when the Query Suggestions index was last updated successfully.

Example:

"2023-07-05T08:03:53Z"

​
lastSuccessfulBuildDuration
string

Duration of the last successful build in seconds.

Example:

28

⌘I