KB-2227 401 unauthorized error caused by apiKey mismatch

Ryan Good — Wed, 25 Sep 2024 20:02:52 GMT

Current Revision posted to Appian Knowledge Base by Ryan Good on 9/25/2024 8:02:52 PM

Symptoms

When starting up the search server after an upgrade, the following errors appear:

In tomcat-stdOut.log:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

In search-server.log:

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API key values in Appian:

The value: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The value: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

When upgrading Appian and deploying configurations, the two API keys will match. However, the upgrade documentation points to manually copying over the old custom.properties file located at <OLD_APPIAN_HOME>/conf/ to <APPIAN_HOME>/conf/. This will overwrite the newly generated search-server apiKey value with the old search-server apiKey value.

The apiKey value in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated API key.
The apiKey value in <APPIAN_HOME>/conf/custom.properties will be the old API key.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Ensure the values of the search server API key properties are the same in custom.properties in <APPIAN_HOME>/conf/ (via conf.data.search-server.restclient.apiKey) and custom.properties in <APPIAN_HOME>/search-server/conf/ (via conf.search-server.http.auth.apiKey). This can be done in either one of the following ways:

Copy the value from conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/ to conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/.
Copy the value from conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/ to conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/.

Affected Versions

This article applies to versions of Appian upgrading from 20.4 and earlier to versions that fall between 21.1 and 24.2.

Last Reviewed: September 2024

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey

KB-2227 401 unauthorized error caused by apiKey mismatch

Ryan Good — Wed, 25 Sep 2024 20:02:37 GMT

Revision 12 posted to Appian Knowledge Base by Ryan Good on 9/25/2024 8:02:37 PM

Symptoms

When starting up the search server after an upgrade, the following errors appear:

In tomcat-stdOut.log:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

In search-server.log:

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API key values in Appian:

The value: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The value: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

The apiKey value in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated API key.
The apiKey value in <APPIAN_HOME>/conf/custom.properties will be the old API key.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Copy the value from conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/ to conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/.
Copy the value from conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/ to conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/.

Affected Versions

This article applies to versions of Appian upgrading from 20.4 and earlier to versions that fall between 21.1 and 24.2.

Last Reviewed: May 2023

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey

KB-2227 401 unauthorized error caused by apiKey mismatch

Maggie Deppe-Walker — Wed, 24 May 2023 05:17:44 GMT

Revision 11 posted to Appian Knowledge Base by Maggie Deppe-Walker on 5/24/2023 5:17:44 AM

Symptoms

When starting up the search server after an upgrade, the following errors appear:

In tomcat-stdOut.log:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

In search-server.log:

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API key values in Appian:

The value: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The value: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

The apiKey value in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated API key.
The apiKey value in <APPIAN_HOME>/conf/custom.properties will be the old API key.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Copy the value from conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/ to conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/.
Copy the value from conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/ to conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/.

Affected Versions

This article applies to versions of Appian upgrading from 20.4 and earlier to 21.1 and later.

Last Reviewed: May 2023

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey

KB-2227 401 unauthorized error caused by apiKey mismatch

Maggie Deppe-Walker — Thu, 17 Nov 2022 06:37:41 GMT

Revision 10 posted to Appian Knowledge Base by Maggie Deppe-Walker on 11/17/2022 6:37:41 AM

Symptoms

When starting up the search server after an upgrade, the following errors appear:

In tomcat-stdOut.log:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

In search-server.log:

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API key values in Appian:

The value: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The value: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

The apiKey value in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated API key.
The apiKey value in <APPIAN_HOME>/conf/custom.properties will be the old API key.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Copy the value from conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/search-server/conf/ to conf.search-server.http.auth.apiKey in <APPIAN_HOME>/conf/.
Copy the value from conf.search-server.http.auth.apiKey in <APPIAN_HOME>/conf/ to conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/search-server/conf/.

Affected Versions

This article applies to versions of Appian upgrading from 20.4 and earlier to 21.1 and later.

Last Reviewed: November 2022

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey

DRAFT SP-7917 401 unauthorized error caused by apiKey mismatch

Maggie Deppe-Walker — Thu, 17 Nov 2022 06:35:07 GMT

Revision 9 posted to Appian Knowledge Base by Maggie Deppe-Walker on 11/17/2022 6:35:07 AM

Symptoms

When starting up the search server after an upgrade, the following errors appear:

In tomcat-stdOut.log:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

In search-server.log:

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API key values in Appian:

The value: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The value: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

The apiKey value in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated API key.
The apiKey value in <APPIAN_HOME>/conf/custom.properties will be the old API key.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Copy the value from conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/search-server/conf/ to conf.search-server.http.auth.apiKey in <APPIAN_HOME>/conf/.
Copy the value from conf.search-server.http.auth.apiKey in <APPIAN_HOME>/conf/ to conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/search-server/conf/.

Affected Versions

This article applies to versions of Appian upgrading from 20.4 and earlier to 21.1 and later.

Last Reviewed: November 2022

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey

DRAFT SP-7917 401 unauthorized error caused by apiKey mismatch

Maggie Deppe-Walker — Mon, 10 Oct 2022 21:31:43 GMT

Revision 8 posted to Appian Knowledge Base by Maggie Deppe-Walker on 10/10/2022 9:31:43 PM

Symptoms

When starting up the search server after an upgrade, the following errors appear:

In tomcat-stdOut.log:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

In search-server.log:

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API key values in Appian:

The value: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The value: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

The apiKey value in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated API key.
The apiKey value in <APPIAN_HOME>/conf/custom.properties will be the old API key.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Copy the value from conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/search-server/conf/ to conf.search-server.http.auth.apiKey in <APPIAN_HOME>/conf/.
Copy the value from conf.search-server.http.auth.apiKey in <APPIAN_HOME>/conf/ to conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/search-server/conf/.

Affected Versions

This article applies to versions of Appian upgrading from 20.4 and earlier to 21.1 and later.

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey

DRAFT SP-7917 401 unauthorized error caused by apiKey mismatch

Maggie Deppe-Walker — Mon, 10 Oct 2022 21:31:26 GMT

Revision 7 posted to Appian Knowledge Base by Maggie Deppe-Walker on 10/10/2022 9:31:26 PM

Symptoms

When starting up the search server after an upgrade, the following errors appear:

In tomcat-stdOut.log:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

In search-server.log:

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API key values in Appian:

The value: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The value: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

The apiKey value in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated API key.
The apiKey value in <APPIAN_HOME>/conf/custom.properties will be the old API key.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Copy the value from conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/search-server/conf/ to conf.search-server.http.auth.apiKey in <APPIAN_HOME>/conf/.
Copy the value from conf.search-server.http.auth.apiKey in <APPIAN_HOME>/conf/ to conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/search-server/conf/.

Affected Versions

This article applies to versions of Appian upgrading from 20.4 and earlier to 21.1 and later.

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey

DRAFT SP-7917 401 unauthorized error caused by apiKey mismatch

Sam Hammermaster — Mon, 03 Oct 2022 15:10:25 GMT

Revision 3 posted to Appian Knowledge Base by Sam Hammermaster on 10/3/2022 3:10:25 PM

Symptoms

There are a few different symptoms that can be experienced. The error will appear after starting the search server post upgrade. The following errors have been observed:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API keys in Appian:

The field: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The field: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

When upgrading Appian and deploying configurations, the two API keys will match. However, the upgrade documentation then points to merging configurations. Copying over the old custom.properties file into the new Appian install directory will overwrite the newly generated search-server apiKey with the old one.

The apiKey in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated one.
The apiKey in <APPIAN_HOME>/conf/custom.properties will be the old one.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Copy the search server API key from <APPIAN_HOME>/conf/custom.properties in the conf.data.search-server.restclient.apiKey section to <APPIAN_HOME>/search-server/conf/custom.properties in the conf.search-server.http.auth.apiKey section.
The content of the apiKey does not matter as long as the values are the same, so copying over the other way works too.

Affected Versions

This article applies to upgrading from all versions of Appian starting with 21.1

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey

DRAFT SP-7917 401 unauthorized error caused by apiKey mismatch

Sam Hammermaster — Mon, 03 Oct 2022 15:10:03 GMT

Revision 2 posted to Appian Knowledge Base by Sam Hammermaster on 10/3/2022 3:10:03 PM

Symptoms

There are a few different symptoms that can be experienced. The error will appear after starting the search server post upgrade. The following errors have been observed:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API keys in Appian:

The field: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The field: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

The apiKey in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated one.
The apiKey in <APPIAN_HOME>/conf/custom.properties will be the old one.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Copy the search server API key from <APPIAN_HOME>/conf/custom.properties in the conf.data.search-server.restclient.apiKey section to <APPIAN_HOME>/search-server/conf/custom.properties in the conf.search-server.http.auth.apiKey section.
The content of the apiKey does not matter as long as the values are the same, so copying over the other way works too.

Affected Versions

This section includes any relevant version information for Appian or other third/party configurations. Some examples of valid affected versions are as follows:

This article applies to upgrading from all versions of Appian starting with 21.1

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey

DRAFT SP-7917 401 unauthorized error caused by apiKey mismatch

Sam Hammermaster — Mon, 03 Oct 2022 15:08:41 GMT

Revision 1 posted to Appian Knowledge Base by Sam Hammermaster on 10/3/2022 3:08:41 PM

Symptoms

There are a few different symptoms that can be experienced from this problem. The error will appear after starting the search server post upgrade. The following errors have been observed:

method [GET], host http://localhost:9200, URI [/_nodes/http?timeout=1000ms], status line [HTTP/1.1 401 Unauthorized]

com.appiancorp.common.persistence.search.AppianSearchSpringConfig - error initializing client

fetching geoip databases overview from [https://geoip.elastic.co/v1/database?elastic_geoip_service_tos=agree] exception during geoip databases update java.net.SocketTimeoutException: connect timed out

Cause

There are two places for search server API keys in Appian:

The field: conf.data.search-server.restclient.apiKey in <APPIAN_HOME>/conf/custom.properties
The field: conf.search-server.http.auth.apiKey in <APPIAN_HOME>/search-server/conf/custom.properties

These keys must be the same value for the search server to function as expected.

The apiKey in <APPIAN_HOME>/search-server/conf/custom.properties will be the newly generated one.

The apiKey in <APPIAN_HOME>/conf/custom.properties will be the old one.

This issue has been reported to the Appian Product Team. The reference number for this issue is AN-215019.

Action

Copy the search server API key from <APPIAN_HOME>/conf/custom.properties in the conf.data.search-server.restclient.apiKey section to <APPIAN_HOME>/search-server/conf/custom.properties in the conf.search-server.http.auth.apiKey section.
The content of the API key does not matter as long as the values are the same, so copying over the other way works too.

Affected Versions

This section includes any relevant version information for Appian or other third/party configurations. Some examples of valid affected versions are as follows:

This article applies to upgrading from all versions of Appian starting with 21.1

Tags: known issues, 401 unauthorized, search server, upgrade, open issues, apiKey