Skip to main content

security-ssl

Contributors
Suggest changes

security-ssl-get

GET /api/security/certificates/{uuid}

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

certificate-authority

ca

Certificate authority.

certificate-serial-number

serial_number

Serial number of certificate.

client-authentication-enabled

No REST Equivalent

See "client_enabled" in /api/cluster/web and /api/svm/svms/\{svm.uuid\}/web.

common-name

common_name

FQDN or custom common name.

ocsp-default-responder

No REST Equivalent

ocsp-enabled

No REST Equivalent

See "ocsp_enabled" in /api/cluster/web and /api/svm/svms/\{svm.uuid\}/web.

ocsp-max-response-age

No REST Equivalent

ocsp-max-response-time-skew

No REST Equivalent

ocsp-override-responder

No REST Equivalent

ocsp-responder-timeout

No REST Equivalent

ocsp-use-request-nonce

No REST Equivalent

server-authentication-enabled

No REST Equivalent

vserver

svm.name

The name of the SVM.

security-ssl-get-iter

GET /api/security/certificates

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

certificate-authority

ca

Certificate authority.

certificate-serial-number

serial_number

Serial number of certificate.

client-authentication-enabled

No REST Equivalent

See "client_enabled" in /api/cluster/web and /api/svm/svms/\{svm.uuid\}/web.

common-name

common_name

FQDN or custom common name.

ocsp-default-responder

No REST Equivalent

ocsp-enabled

No REST Equivalent

See "ocsp_enabled" in /api/cluster/web and /api/svm/svms/\{svm.uuid\}/web.

ocsp-max-response-age

No REST Equivalent

ocsp-max-response-time-skew

No REST Equivalent

ocsp-override-responder

No REST Equivalent

ocsp-responder-timeout

No REST Equivalent

ocsp-use-request-nonce

No REST Equivalent

server-authentication-enabled

No REST Equivalent

vserver

svm.name

The name of the SVM.

max-records

max_records

Specifies the maximum number of records to return before paging.

security-ssl-modify

PATCH /api/svm/svms/{svm.uuid}/web

Note: The certificate's UUID is used to identify the certificate to use for the SVM. To update the certificate of the admin SVM, use PATCH /api/cluster/web.
Example:
curl -XPATCH "https://{mgmt-ip}/api/svm/svms/1cd8a442-86d1-11e0-ae1c-123478563412/web" -d '{"certificate": { "uuid": "abc8a442-86d1-11e0-ae1c-123478563333" } }'

Usage: This ONTAPI call can be issued against Storage VM (SVM) management LIFs.

ONTAPI attribute REST attribute Comment

certificate-authority

No REST Equivalent

The certificate authority associated with the certificate.

certificate-serial-number

No REST Equivalent

The serial number for the certificate.

client-authentication-enabled

client_enabled

Indicates whether client authentication is enabled.

common-name

No REST Equivalent

FQDN or custom common name for the certificate.

ocsp-default-responder

No REST Equivalent

ocsp-enabled

ocsp_enabled

Indicates whether online certificate status protocol verification is enabled.

ocsp-max-response-age

No REST Equivalent

ocsp-max-response-time-skew

No REST Equivalent

ocsp-override-responder

No REST Equivalent

ocsp-responder-timeout

No REST Equivalent

ocsp-use-request-nonce

No REST Equivalent

server-authentication-enabled

No REST Equivalent

SSL server authentication. To disable this field, delete the certificate using DELETE /api/security/certificates/{uuid}.

vserver

name

The name of the SVM.