GET /api/indexadmin/config

Returns information about the global configuration settings for Elasticsearch on the Akana API Platform.

Authorization Roles/Permissions: System Administrator only.

This topic includes the following sections:

HTTP Method


Back to top



Back to top

Sample Request

The example below shows...

Request URL


Sample request headers

Accept: application/json

Sample request body

Not applicable.

Back to top

Request Headers

For general information on request header values, refer to HTTP Request Headers.

Header Description
Accept application/json, application/vnd.soa.v85+json

Back to top

Request Parameters


Back to top


If successful, this operation returns HTTP status code 200, with information about the Elasticsearch cluster.

Back to top

Sample Response

The sample response below shows successful completion of this operation.

Sample response headers: application/json

HTTP/1.1 200 OK
Date: Tue, 09 Oct 2018 22:12:57 GMT
Content-Type: application/json

Sample response body: application/json

  "clientUrl": "localhost:9330",
  "clusterName": "akana",
  "deploymentMode": "Transport Client"

Back to top

Response Headers

For general information on response header values, refer to HTTP Response Headers.

Header Description
Content-Type application/json, application/vnd.soa.v85+json

Back to top

Response Body

Name Type Description
ESGlobalConfig ESGlobalConfig Contains information about the Elasticsearch global configuration settings.

Back to top

Error Codes/Messages

If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.

Item Value
401 Unauthorized. For example, you would get this response if you didn't include the custom X-Csrf-Token_{fedmemberID} header in the request, when it was required by the platform settings; or if you included an invalid or expired value for this header. You would also get this response for any operation that requires login (almost all) if the login cookie was missing.
500 An error occurred processing the call.

More information about Akana API Platform API error messages.

Back to top

Related Topics