Skip to main content
REST API reference

Update the web services security configuration

PDFs

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

Introduced In: 9.10

Updates the web services security configuration.

Parameters

Name Type In Required Description

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 0

  • Max value: 120

  • Min value: 0

svm.uuid

string

path

True

UUID of the SVM to which this object belongs.

Request Body

Name Type Description

certificate

certificate

Certificate used by cluster and node management interfaces for TLS connection requests.

client_enabled

boolean

Indicates whether client authentication is enabled.

ocsp_enabled

boolean

Indicates whether online certificate status protocol verification is enabled.

svm

svm

SVM, applies only to SVM-scoped objects.
Example request 
{
  "certificate": {
    "name": "cert1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "svm": {
    "name": "svm1",
    "uuid": "02c9e252-41be-11e9-81d5-00a0986138f7"
  }
}

Response

Status: 200, Ok

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

9830442

Client authentication cannot be enabled without a client ca certificate.

9830488

The certificate is not a "server" certificate.

9830489

The certificate does not exist for the given SVM.

Also see the table of common errors in the Response body overview section of this documentation.

Definitions

See Definitions

href

Name Type Description

href

string

_links

certificate

Certificate used by cluster and node management interfaces for TLS connection requests.

Name Type Description

name

string

Certificate name

uuid

string

Certificate UUID

svm

SVM, applies only to SVM-scoped objects.

Name Type Description

name

string

The name of the SVM. This field cannot be specified in a PATCH method.

uuid

string

The unique identifier of the SVM. This field cannot be specified in a PATCH method.

web_svm

Name Type Description

certificate

certificate

Certificate used by cluster and node management interfaces for TLS connection requests.

client_enabled

boolean

Indicates whether client authentication is enabled.

ocsp_enabled

boolean

Indicates whether online certificate status protocol verification is enabled.

svm

svm

SVM, applies only to SVM-scoped objects.

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.