PUT /api/indexadmin/config

Updates the global configuration settings for Elasticsearch on the Akana API Platform.

Note: To check the existing global configuration settings before modifying them, run the GET /api/indexadmin/config operation.

Authorization Roles/Permissions: System Administrator only.

This topic includes the following sections:

HTTP Method

PUT

URL

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

Sample Request

The example below shows updating the settings for the Elasticsearch cluster to change the port number.

Sample Request URL

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

Sample request headers

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

Sample request body

{
  "clientUrl": "localhost:9370",
  "clusterName": "akana",
  "deploymentMode": "Transport Client"
}

Request Headers

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

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

Request Parameters

Parameter	Parm Type	Data Type	Required	Description
Body	ESGlobalConfig	ESGlobalConfig	Required	Contains information about the Elasticsearch global configuration settings.

Response

If successful, this operation returns HTTP status code 200, with the updated Elasticsearch configuration values.

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:57:41 GMT
Content-Type: application/json

Sample response body: application/json

{
  "clientUrl": "localhost:9370",
  "clusterName": "akana",
  "deploymentMode": "Transport Client"
}

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

Response Body

Name	Type	Description
ESGlobalConfig	ESGlobalConfig	Contains information about the Elasticsearch global configuration settings. The updated settings are returned in the response.

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.

Related Topics