Retrieve the web services configuration
- PDF of this doc site
Collection of separate PDF docs
Creating your file...
GET /cluster/web
Introduced In: 9.10
Retrieves the web services configuration.
Parameters
Name | Type | In | Required | Description |
---|---|---|---|---|
fields |
array[string] |
query |
False |
Specify the fields to return. |
Response
Status: 200, Ok
Name | Type | Description |
---|---|---|
_links |
||
certificate |
Certificate used by cluster and node management interfaces for TLS connection requests. |
|
client_enabled |
boolean |
Indicates whether client authentication is enabled. |
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 response
{
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"certificate": {
"_links": {
"self": {
"href": "/api/resourcelink"
}
},
"name": "cert1",
"uuid": "1cd8a442-86d1-11e0-ae1c-123478563412"
},
"csrf": {
"token": {
"concurrent_limit": 120
}
},
"per_address_limit": 42,
"state": "string"
}
Error
Status: Default, Error
Name | Type | Description |
---|---|---|
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 |
certificate
Certificate used by cluster and node management interfaces for TLS connection requests.
Name | Type | Description |
---|---|---|
_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 |
error_arguments
Name | Type | Description |
---|---|---|
code |
string |
Argument code |
message |
string |
Message argument |
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. |