Get public key or generate new key pair

Description

Retrieves the public key, or generates a new key pair (public and private key).

URL

Copy code
Retrieve the public key
/Admin/rest/v1/configuration/getPublicKey
Copy code
Generate a new key pair
/Admin/rest/v1/configuration/generateKeyPair

Remarks

The host pool data can be passed as XML containing the equivalent data.

HTTP Method

GET: Retrieves the public key.

POST: Generates a new key pair (public and private key).

Request

Headers:

Content-Type: application/xml

Accept: application/xml

Cookies:

Versions 2023 and later

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Versions 2022 - 2022 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

Versions 2021 - 2021 R2

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

ASP.NET_SessionId_Adm={ASP.NET_SessionId_Adm_COOKIE_VALUE};

Versions 2020 - 2020 SP3

ADM_LWSSO={ADM_LWSSO_COOKIE_VALUE};

Versions earlier than 2020

LWSSO_COOKIE_KEY={LWSSO_COOKIE_KEY_COOKIE_VALUE};

QCSession={QC_SESSION_COOKIE_VALUE};

Request Body:

GET: No request body.

Copy code
GET http://<LRE_Server>/Admin/rest/v1/configuration/getPublicKey
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};
Copy code
PATCH http://<LRE_Server>/Admin/rest/v1/configuration/generateKeyPair
Content-Type: application/xml
Accept: application/xml
Cookie: ADM_LWSSO={AdmLwssoCookie};

Response

Headers:

Content-Type: application/xml

Cookies:

None

HTML Return Code:

One of the HTTP Return Codes

Upon successful public key retrieval or creation, returns HTTP status 200 (OK).

HTML Body:

GET: Retrieves the public key.

POST: Returns XML of the key pair.

See Also

Manage Cloud Hosts