Skip to main content

Update the web services configuration

Contributors
PDFs

PATCH /cluster/web

Introduced In: 9.10

Updates the web services configuration.

  • system services web modify

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: 1

  • Max value: 120

  • Min value: 0

Request Body

Name Type Description

_links

_links

certificate

certificate

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

client_enabled

boolean

Indicates whether client authentication is enabled.

csrf

csrf

enabled

boolean

Indicates whether remote clients can connect to the web services.

http_enabled

boolean

Indicates whether HTTP is enabled.

http_port

integer

HTTP port for cluster-level web services.

https_port

integer

HTTPS port for cluster-level web services.

ocsp_enabled

boolean

Indicates whether online certificate status protocol verification is enabled.

per_address_limit

integer

The number of connections that can be processed concurrently from the same remote address.

state

string

State of the cluster-level web services.

wait_queue_capacity

integer

The maximum size of the wait queue for connections exceeding the per-address-limit.
Example request 
{
  "_links": {
    "self": {
      "href": "/api/resourcelink"
    }
  },
  "certificate": {
    "_links": {
      "self": {
        "href": "/api/resourcelink"
      }
    },
    "name": "cert1",
    "uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
  },
  "csrf": {
    "token": {
      "concurrent_limit": 120,
      "idle_timeout": 200,
      "max_timeout": 1200
    }
  },
  "per_address_limit": 42,
  "state": "string"
}

Response

Status: 200, Ok

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

9830406

Reconfiguration of the web services failed.

9830407

The web services failed to restart.

9830408

Reconfiguration and/or restart of the web services failed.

9830442

Client authentication cannot be enabled without a client ca certificate.

9830463

The cluster must be fully upgraded before modifying this resource.

9830464

HTTP cannot be enabled when FIPS is also enabled.

9830483

The CSRF token timeout is invalid.

9830484

The maximum concurrent CSRF token count cannot be lower than 100.

9830485

The CSRF idle timeout cannot be greater than the CSRF absolute timeout.

9830486

CSRF requires an effective cluster version of 9.7 or later.

9830487

The HTTP and HTTPS ports must not have the same value.

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.

Name Type Description

error

returned_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

self

href

certificate

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

Name Type Description

_links

_links

name

string

Certificate name

uuid

string

Certificate UUID

token

Name Type Description

concurrent_limit

integer

Maximum number of concurrent CSRF tokens.

idle_timeout

integer

Time for which an unused CSRF token is retained, in seconds.

max_timeout

integer

Time for which an unused CSRF token, regardless of usage is retained, in seconds.

csrf

Name Type Description

protection_enabled

boolean

Indicates whether CSRF protection is enabled.

token

token

web

Name Type Description

_links

_links

certificate

certificate

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

client_enabled

boolean

Indicates whether client authentication is enabled.

csrf

csrf

enabled

boolean

Indicates whether remote clients can connect to the web services.

http_enabled

boolean

Indicates whether HTTP is enabled.

http_port

integer

HTTP port for cluster-level web services.

https_port

integer

HTTPS port for cluster-level web services.

ocsp_enabled

boolean

Indicates whether online certificate status protocol verification is enabled.

per_address_limit

integer

The number of connections that can be processed concurrently from the same remote address.

state

string

State of the cluster-level web services.

wait_queue_capacity

integer

The maximum size of the wait queue for connections exceeding the per-address-limit.

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.