Retrieve cluster network security certificate configuration
Accesses the cluster network security certificate configuration to review the current settings. This is useful when you need to verify or audit the certificate details for security compliance.
HTTP method and endpoint
GET /security/cluster-network/certificates
Introduced in
ONTAP 9.18
Usage notes
Retrieves the certificate configuration used for cluster network security.
Related ONTAP commands
-
'security cluster-network certificate show'
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
node.name |
string |
query |
False |
Filter by node.name |
node.uuid |
string |
query |
False |
Filter by node.uuid |
certificate.uuid |
string |
query |
False |
Filter by certificate.uuid |
certificate.name |
string |
query |
False |
Filter by certificate.name |
fields |
array[string] |
query |
False |
Specify the fields to return. |
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 |
Response
Status: 200, Ok
| Name | Type | Description |
|---|---|---|
_links |
||
num_records |
integer |
Number of records. |
records |
array[records] |
Example response
{
"_links": {
"next": {
"href": "/api/resourcelink"
},
"self": {
"href": "/api/resourcelink"
}
},
"num_records": 1,
"records": [
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"certificate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "string",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"node": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "node1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
}
}
]
}
Error
Status: Default, Error
| Name | Type | Description |
|---|---|---|
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 |
|---|---|---|
next |
||
self |
_links
| Name | Type | Description |
|---|---|---|
self |
security_certificate_reference
Security certificate object reference
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
Certificate name |
uuid |
string |
Certificate UUID |
node_reference
| Name | Type | Description |
|---|---|---|
_links |
||
name |
string |
|
uuid |
string |
records
Manages the cluster network security certificate configuration.
| Name | Type | Description |
|---|---|---|
_links |
||
certificate |
Security certificate object reference |
|
node |
error_arguments
| Name | Type | Description |
|---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
returned_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. |