security-certificate
Suggest changes
PDFs
security-certificate-ca-issued-get
GET /api/security/certificates
Note: Two GET requests are used here. The first GET request filters on "root-ca" for the "type" attribute. The second GET request sets the "type" filter to "server|client" and adds a separate filter on the "ca" attribute using the set of values returned for "ca" by the first GET request.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ca-serial-number |
serial_number |
The value from the first GET response applies here. |
certificate-authority |
ca |
The value is the same in both GET responses. |
common-name |
common_name |
The value from the second GET reponse applies here. |
country |
No REST Equivalent |
|
email-addr |
No REST Equivalent |
|
expiration-date |
expiry_time |
The value from the second GET response applies here. |
locality |
No REST Equivalent |
|
organization |
No REST Equivalent |
|
organization-unit |
No REST Equivalent |
|
revocation-date |
No REST Equivalent |
|
serial-number |
serial_number |
The value from the second GET response applies here. |
state |
No REST Equivalent |
|
status |
No REST Equivalent |
|
vserver |
svm.name |
The value is the same in both GET responses. |
security-certificate-ca-issued-get-iter
GET /api/security/certificates
Note: Two GET requests are used here. The first GET request filters on "root-ca" for the "type" attribute. The second GET request sets the "type" filter to "server|client" and adds a separate filter on the "ca" attribute using the set of values returned for "ca" by the first GET request.
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ca-serial-number |
serial_number |
The value from the first GET response applies here. |
certificate-authority |
ca |
The value is the same in both GET responses. |
common-name |
common_name |
The value from the second GET reponse applies here. |
country |
No REST Equivalent |
|
email-addr |
No REST Equivalent |
|
expiration-date |
expiry_time |
The value from the second GET response applies here. |
locality |
No REST Equivalent |
|
organization |
No REST Equivalent |
|
organization-unit |
No REST Equivalent |
|
revocation-date |
No REST Equivalent |
|
serial-number |
serial_number |
The value from the second GET response applies here. |
state |
No REST Equivalent |
|
status |
No REST Equivalent |
|
vserver |
svm.name |
The value is the same in both GET responses. |
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
security-certificate-create
POST /api/security/certificates
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cert-name |
name |
|
common-name |
common_name |
|
country |
No REST Equivalent |
|
email-address |
No REST Equivalent |
|
expire-days |
expiry_time |
|
hash-function |
hash_function |
|
is-system-internal-certificate |
No REST Equivalent |
|
locality |
No REST Equivalent |
|
organization |
No REST Equivalent |
|
organization-unit |
No REST Equivalent |
|
size |
key_size |
|
state |
No REST Equivalent |
|
type |
type |
|
vserver |
svm.name |
security-certificate-delete
DELETE /api/security/certificates/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cert-name |
name |
|
certificate-authority |
ca |
|
common-name |
common_name |
|
is-system-internal-certificate |
No REST Equivalent |
|
serial-number |
serial_number |
|
subtype |
No REST Equivalent |
This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available. |
type |
type |
|
vserver |
svm.name |
security-certificate-delete-iter
DELETE /api/security/certificates
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
continue-on-failure |
No REST Equivalent |
|
max-failure-count |
No REST Equivalent |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
cert-name |
name |
|
certificate-authority |
ca |
|
common-name |
common_name |
|
country |
No REST Equivalent |
|
email-address |
No REST Equivalent |
|
expiration-date |
expiry_time |
|
expire-days |
No REST Equivalent |
|
hash-function |
hash_function |
|
is-default |
No REST Equivalent |
|
is-root |
No REST Equivalent |
|
is-system-generated |
No REST Equivalent |
|
locality |
No REST Equivalent |
|
organization |
No REST Equivalent |
|
organization-unit |
No REST Equivalent |
|
protocol |
No REST Equivalent |
|
public-certificate |
public_certificate |
|
self-signed |
No REST Equivalent |
|
serial-number |
serial_number |
|
size |
key_size |
|
start-date |
No REST Equivalent |
|
state |
No REST Equivalent |
|
subtype |
No REST Equivalent |
This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available. |
type |
type |
|
vserver |
svm.name |
|
return-failure-list |
No REST Equivalent |
|
return-success-list |
No REST Equivalent |
security-certificate-file-get-iter
This ONTAPI call does not have an equivalent REST API call.
security-certificate-generate-csr
POST /api/security/certificate-signing-request
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
common-name |
subject_name |
All subject names, including common name, are supported through this field. |
country |
No REST Equivalent |
|
email-address |
No REST Equivalent |
|
hash-function |
hash_function |
|
locality |
No REST Equivalent |
|
organization |
No REST Equivalent |
|
organization-unit |
No REST Equivalent |
|
size |
security_strength |
Security strength in bits as opposed to "size" which is RSA-key bits. |
state |
No REST Equivalent |
security-certificate-get
GET /api/security/certificates/{uuid}
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cert-name |
name |
|
certificate-authority |
ca |
|
common-name |
common_name |
|
country |
No REST Equivalent |
|
email-address |
No REST Equivalent |
|
expiration-date |
expiry_time |
|
expire-days |
No REST Equivalent |
|
hash-function |
hash_function |
|
is-default |
No REST Equivalent |
|
is-root |
No REST Equivalent |
|
is-system-generated |
No REST Equivalent |
|
locality |
No REST Equivalent |
|
organization |
No REST Equivalent |
|
organization-unit |
No REST Equivalent |
|
protocol |
No REST Equivalent |
|
public-certificate |
public_certificate |
|
self-signed |
No REST Equivalent |
|
serial-number |
serial_number |
|
size |
key_size |
|
start-date |
No REST Equivalent |
|
state |
No REST Equivalent |
|
subtype |
No REST Equivalent |
This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available. |
type |
type |
|
vserver |
svm.name |
security-certificate-get-iter
GET /api/security/certificates
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cert-name |
name |
|
certificate-authority |
ca |
|
common-name |
common_name |
|
country |
No REST Equivalent |
|
email-address |
No REST Equivalent |
|
expiration-date |
expiry_time |
|
expire-days |
No REST Equivalent |
|
hash-function |
hash_function |
|
is-default |
No REST Equivalent |
|
is-root |
No REST Equivalent |
|
is-system-generated |
No REST Equivalent |
|
locality |
No REST Equivalent |
|
organization |
No REST Equivalent |
|
organization-unit |
No REST Equivalent |
|
protocol |
No REST Equivalent |
|
public-certificate |
public_certificate |
|
self-signed |
No REST Equivalent |
|
serial-number |
serial_number |
|
size |
key_size |
|
start-date |
No REST Equivalent |
|
state |
No REST Equivalent |
|
subtype |
No REST Equivalent |
This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available. |
type |
type |
|
vserver |
svm.name |
|
max-records |
max_records |
Specifies the maximum number of records to return before paging. |
security-certificate-install
POST /api/security/certificates
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
cert-name |
name |
|
certificate |
public_certificate |
|
common-name |
common_name |
|
intermediate-cert-list |
intermediate_certificates |
|
is-system-internal-certificate |
No REST Equivalent |
|
private-key |
private_key |
|
subtype |
No REST Equivalent |
This ONTAPI attribute is deprecated as of ONTAP 9.6. No equivalent REST API is available. |
type |
type |
|
vserver |
svm.name |
security-certificate-remove-precluster-cert
Note: The entity to which this ZAPI refers is not externally visible after cluster setup and is no longer in use by system. It is automatically deleted 24 hours after creation of the first data SVM. If a need arises to explicitly delete it, use the diagnostic "security certificate remove-precluster-cert" command.
This ONTAPI call does not have an equivalent REST API call.
security-certificate-rename
This ONTAPI call does not have an equivalent REST API call.
security-certificate-revoke
This ONTAPI call does not have an equivalent REST API call.
security-certificate-sign
POST /api/security/certificates/{ca.uuid}/sign
Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.
| ONTAPI attribute | REST attribute | Comment |
|---|---|---|
ca-serial-number |
No REST Equivalent |
|
certificate-authority |
No REST Equivalent |
|
csr |
signing_request |
|
destination |
No REST Equivalent |
|
expire-days |
expiry_time |
|
filepassword |
No REST Equivalent |
|
format |
No REST Equivalent |
|
hash-function |
hash_function |
|
password |
No REST Equivalent |
|
private-key |
No REST Equivalent |
|
username |
No REST Equivalent |
|
vserver |
No REST Equivalent |
Not required. With the REST API, you can determine vserver by the ca.uuid resource. |
security-certificate-truststore-clear
This ONTAPI call does not have an equivalent REST API call.
security-certificate-truststore-load
This ONTAPI call does not have an equivalent REST API call.