ShieldSecurity API documentation

Set any single option

POST /options/{key}

Sets the value of any single option

Path parameters

key string Required

the option key from from within the plugin

Query parameters

value string | integer | array Required

the new value for the option

application/json

Body

value string | integer | array Required

One of:
string-1 string integer-2 integer array-3 array

New value for option

New value for option

New value for option

Responses

• 200

updated option reflecting new value
Hide response attributes Show response attributes array[object]
- key string Required
  
  Format should match the following pattern: ^[a-z_]$.
- value string | null | integer | array Required
  
  One of:
  string-1 string | null integer-2 integer | null array-3 null | array
  
  the value of the option. Use 'null' to reset to default
  
  the value of the option. Use 'null' to reset to default
  
  the value of the option. Use 'null' to reset to default
- module string
  
  Format should match the following pattern: ^[a-z_]$.
• 400

invalid input, object invalid

POST /options/{key}

curl \
 -X POST https://virtserver.swaggerhub.com/Fernleaf-Systems/ShieldSecurity/1.0.0/options/{key}?value=string \
 -H "Content-Type: application/json" \
 -d '{"value":"Y"}'

Request example

{
  "value": "Y"
}

Response examples (200)

[
  {
    "key": "enable_tracking",
    "value": "Y",
    "module": "hack_guard"
  }
]