ShieldSecurity

Retrieve a single option

GET /options/{key}

Retrieve the full definition of any single plugin option and its current value.

Path parameters

  • key string Required

    the option key from from within the plugin

Responses

  • 200

    all configuration options & values

    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

    bad input parameter

GET /options/{key} 
curl \
 -X GET https://virtserver.swaggerhub.com/Fernleaf-Systems/ShieldSecurity/1.0.0/options/{key}
Response examples (200) 
[
  {
    "key": "enable_tracking",
    "value": "Y",
    "module": "hack_guard"
  }
]
Response examples (200) 
[
  {
    "key": "enable_tracking",
    "value": "Y",
    "module": "hack_guard"
  }
]