5.18.3 Retrieve Secret List

Description

Get a list of secrets that JP1/IM agent control base manages.

Execution permissions

JP1_Console_Admin

API version

v1

Format

Request line

POST /application/component/apiVersion/agents/secrets httpVersion

Request header

Follow the request header in 5.2.3 Request format.

Request message body

Message body of the request can be sent in JSON formats.

[
  "agenthost":"integrated-agent-host-name",
  "managerhost":"manager-host-name"
]

Response message body

Returns a list of secrets. In this case, value of obfuscated and secret is an empty string.

{
    "secrets": [
        {
            "key": "key1",
            "obfuscated": "",
            "secret": ""
        },
        {
            "key": "key2",
            "obfuscated": "",
            "secret": ""
        },
        {
            "key": "key3",
            "obfuscated": "",
            "secret": ""
        }
    ]
}

Parameters

Here are the parameters that you specify for message body of the request:

Parameter name	Data type	Optional	Description
agenthost	string	No	Specify the host name of integrated agent in the range of 1 to 255.
managerhost	string	No	Specify the manager host name in the range of 1 to 255.

Status codes

The following table describes the status codes that are returned as a response to the request:

Status code	Message	Description
200	--	API operation was successful.
400	KAJY68209-E	Request parameter is invalid.
400	KAJY68205-E	Integrated agent host name specified in the request or the configuration managed by the manager host name does not exist in JP1/IM - Manager Logged in as does not have read/manipulate permissions for integrated agent specified in the request
403	KAJY01000-E	The permission of the user used for authentication is insufficient.
500	KAJY00007-E	System error has occurred (out of disk, out of memory, etc.).
500	KAJY68203-E	Cannot connect to Intelligent Integrated Management Base of the manager for the specified integrated agent.
500	KAJY68207-E	JP1/IM agent base operation encountered an error.
500	KAJY68211-E	Intelligent Integrated Management Base operation encountered an error.
500	KAJY68212-E	Cannot connect to JP1/IM agent base.
500	KAJY68501-E	Unable to connect to the manager's unified agent host management DB.

Error message output

API response, including the content of the error message, is returned to the caller when an Execute of Error occurs. The caller displays Message at the caller, using the information of the received response.

Return values

None

Examples

Request:

POST http://immhost01:20703/im/api/v1/agents/secrets

Manager host name: immhost01

{
    "agenthost": "hostA",
    "managerhost": "hostB"
}

Response:

Omitted

To Page Top