security-certificate
Suggest changes
PDFs
security-certificate-ca-issued-get
This ONTAPI call does not have an equivalent REST API call.
security-certificate-ca-issued-get-iter
This ONTAPI call does not have an equivalent REST API call.
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 |
No REST Equivalent |
|
expire-days |
expiry_time |
|
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 |
No REST Equivalent |
|
expire-days |
expiry_time |
|
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 |
No REST Equivalent |
|
expire-days |
expiry_time |
|
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
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.