List Console API Features

Edit online

The List Console API Features operation returns information about the API features available on the console. This operation is supported on the Support Element using the BCPii interface.

HTTP method and URI

GET /api/console/operations/list-features

Response body contents

On successful completion, the response body is a JSON array of String values, each of which identifies an available API feature. The order in which these strings are returned is unspecified. The possible feature names are listed in API features.

Description

This operation lists the API features available on the console. Beginning with API version 4.10, API clients must use this operation and the List CPC API Features operation to determine if specific new or changed API functionality is available.

If the name query parameter is specified, the returned list is limited to those API features that have a name field matching the specified filter pattern. If the name parameter is omitted, no such filtering is performed

Authorization requirements

This operation has no explicit authorization requirements; however, the request must contain the session ID of a fully-authenticated API session.

HTTP status and reason codes

On success, HTTP status code 200 (OK) is returned, and the response body is provided as described in Response body contents.

The following HTTP status codes are returned for the indicated errors, and the response body is a standard error response body providing the reason code indicated and associated error message.

HTTP error status code	Reason code	Description
400 (Bad Request)	Various	Errors were detected during common request validation. See Common request validation reason codes for a list of the possible reason codes.

Additional standard status and reason codes can be returned, as described in Invoking API operations.

Example HTTP interaction

Figure 1. List Console API Features: Request

GET /api/console/operations/list-features HTTP/1.1
x-api-session: 5nihezq2ojefbh3umb5tkdl91gonu6dyrjezv8trwqrwwgr0ti

Figure 2. List Console API Features: Response

200 OK
Server: Hardware management console API web server / 2.0
Cache-control: no-cache
Date: Tue, 31 Jan 2023 13:51:47 GMT
Content-Type: application/json
Content-Length: 188
[
   "environmental-metrics",
   "cpc-install-and-activate",
   "pmg-child-management-permission",
   "secure-boot-with-certificates",
   "report-a-problem",
   "dpm-smcd-partition-link-management",
   "oem-hmc-ids"
]