Removing the configuration of a pre-shared key

Purpose

Use the Eclipse Amlen REST API POST method to remove the configuration of a pre-shared key file by setting the value to null. Setting the value to null, removes configuration and the file from the filesystem.

A pre-shared key (PSK) is a secret key that can be shared between two devices (for example, a client and a server) that are connected by a secured channel. The PSK is used by the server to authenticate the client.

URI

To remove a specified pre-shared key file configuration, use the Eclipse Amlen REST API POST method with the following Eclipse Amlen URI:

http://<admin-endpoint-IP:Port>/ima/v1/configuration

Object configuration data

Provide object configuration data in the payload of the POST method by using the following schema:

{
  "PreSharedKey":null
}
  

Usage NotesĀ®

  • Capitalization and double quotation marks must be used as shown.

Related REST Administration APIs

Example

Removes the pre-shared key file configuration and the .csv file from the filesystem by using cURL:

curl -X POST http://127.0.0.1:9089/ima/v1/configuration -d '{"PreSharedKey":null}'
example response to the POST method:

{        
  "Version": "v1",
  "Code": "CWLNA6011",
  "Message": "The requested configuration change has completed successfully."
}