Skip to main content
REST API reference
A newer release of this product is available.

Retrieve information about security configured on the cluster

PDFs

GET /security

Retrieves information about the security configured on the cluster.

Learn more

Parameters

Name Type In Required Description

max_records

integer

query

False

Limit the number of records returned.

return_records

boolean

query

False

The default is true for GET calls. When set to false, only the number of records is returned.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When iterating over a collection, the default is 15 seconds. ONTAP returns earlier if either max records or the end of the collection is reached.

order_by

array[string]

query

False

Order results by specified fields and optional [asc

desc] direction. Default direction is 'asc' for ascending.

fields

array[string]

query

False

Response

Status: 200, Ok
Name Type Description

_links

_links

onboard_key_manager_configurable_status

onboard_key_manager_configurable_status

Indicates whether the Onboard Key Manager can be configured in the cluster.
Example response 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "onboard_key_manager_configurable_status": {
    "code": 65537300,
    "message": "No platform support for volume encryption in following nodes - node1, node2."
  }
}

Error

Status: Default, Error
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": [
      {
        "code": "string",
        "message": "string"
      }
    ],
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

href

Name Type Description

href

string

_links

Name Type Description

self

href

onboard_key_manager_configurable_status

Indicates whether the Onboard Key Manager can be configured in the cluster.

Name Type Description

code

integer

Code corresponding to the status message. Returns a 0 if the Onboard Key Manager can be configured in the cluster.

message

string

Reason that Onboard Key Manager cannot be configured in the cluster.

supported

boolean

Set to true if the Onboard Key Manager can be configured in the cluster.

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.