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

GET

https://{hostname}/api/indexadmin/config

The example below shows a request for the Elasticsearch global configuration settings.

Sample Request URL

https://{hostname}/api/indexadmin/config

Sample request headers

Accept: application/json
X-Csrf-Token_acmepaymentscorp: TokenID%3D8ed70a13-8469-11e8-b37a-b155e4eabeb8%2CexpirationTime%3D153...

Sample request body

Not applicable.

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

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

None.

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

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"
}

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

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

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

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.