Page History

Include Page

	LIB:_WHMAPI1Menu
	LIB:_WHMAPI1Menu

Description

Excerpt
This function sets a global ModSecurity™ configuration directive.

Multiexcerpt include

SpaceWithExcerpt	com.atlassian.confluence.content.render.xhtml.model.resource.identifiers.SpaceResourceIdentifier@12665
MultiExcerptName	APIDisabledWebServerRole
PageWithExcerpt	LIB:_ServerRoleDisabledAPI

Panel

bgColor	#F2F2F2
borderStyle	none

Examples

Panel

bgColor	#FFFFFF
borderStyle	none

Expand

title	JSON API

Code Block

language	xml

https://hostname.example.com:2087/cpsess##########/json-api/modsec_set_setting?api.version=1&setting_id=8&state=2000

Expand

title	XML API

Code Block

language	xml

https://hostname.example.com:2087/cpsess##########/xml-api/modsec_set_setting?api.version=1&setting_id=8&state=2000

Expand

title	Command Line

Code Block

language	bash

whmapi1 modsec_set_setting setting_id=8 state=2000

Include Page

	LIB:_WHMAPI1CLINote
	LIB:_WHMAPI1CLINote

Expand

title	Output (JSON)

Code Block

language	text
linenumbers	true

{
    "data": {
        "setting_id": 8,
        "name": "Perl Compatible Regular Expressions Library Match Limit",
        "default": 1500,
        "validation": [
            "positiveInteger"
        ],
        "description": "Define the match limit of the Perl Compatible Regular Expressions library.",
        "state": "2000",
        "url": "https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit",
        "directive": "SecPcreMatchLimit",
        "type": "number"
    },
    "metadata": {
        "version": 1,
        "reason": "OK",
        "result": 1,
        "command": "modsec_set_setting"
    }
}

Expand

title	Output (XML)

Code Block

language	text
linenumbers	true

<result>
  <data>
    <name>Perl Compatible Regular Expressions Library Match Limit</name>
    <default>1500</default>
    <description>Define the match limit of the Perl Compatible Regular Expressions library.</description>
    <directive>SecPcreMatchLimit</directive>
    <setting_id>8</setting_id>
    <state>2000</state>
    <type>number</type>
    <url>https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit</url>
    <validation>positiveInteger</validation>
  </data>
  <metadata>
    <command>modsec_set_setting</command>
    <reason>OK</reason>
    <result>1</result>
    <version>1</version>
  </metadata>
</result>

Include Page

	LIB:_WHMAPIShellNote
	LIB:_WHMAPIShellNote

Parameters

Parameter Type Description Possible values Example

setting_id

integer

Required

The setting's ID.

A non-negative integer.

Note

title	Note:

The WHM API 1 modsec_get_settings function returns this value.

state

string

Required

The setting's new state. The function uses this string as a valid argument for the directive.

A valid string.

Note

title	Note:

For more information, read our ModSecurity documentation.

2000

Returns

Return Type Description Possible values Example

default

string

The setting's default value.

A valid string

description

string

The setting's description.

A valid string.

Expand

title	Click to view...

This setting allows you to define the match limit of the PCRE library.

directive

string

The setting's Apache directive.

A valid directive name.

SecPcreMatchLimit

name

string

The setting's name.

A valid string.

PCRE library match limit

radio_options

array of hashes

An array of hashes of the options that the client should display, as buttons, for this setting in a user interface.

Note

title	Note:

The function only returns this array of hashes when you set the type parameter's value to radio.

Read the Radio options section below for a list of possible values.

setting_id

integer

The setting's ID.

A valid non-negative integer.

state

integer

The setting's new state.

The argument to the directive.

type

string

The type of UI control that the client should use to represent the setting.

text — WHM users modify this setting via a text box.
radio — WHM users modify this setting via a radio button.
Note
title Note:
If the type parameter's value is radio, the function also returns the radio_options array of hashes.
number — WHM users modify this setting via a text box that only allows numeric values.

text

url

string

The URL for the setting's documentation.

A valid URL.

Expand

title	Click to view...

https://github.com/SpiderLabs/ModSecurity/wiki/Reference-Manual#secpcrematchlimit

validation

array

An array of validators to apply.

Read the Validators section below for a list of possible values.

Anchor
Radio
Radio
Radio options

Expand

title	Click to view...

Include Page

	LIB:_Modsec_radio_options
	LIB:_Modsec_radio_options

Anchor
Validators
Validators
Validators

Expand

title	Click to view...

Include Page

	LIB:_Modsec_Validators
	LIB:_Modsec_Validators

Panel

bgColor	#F2F2F2
borderStyle	none

Function information

Panel

bgColor	#FFFFFF
borderStyle	none

Section

Column

width	40%

API Version:

Column
WHM API 1

Section

Column

width	40%

Available in:

Column
WHM 11.46+

Section

Column

width	40%

Methods:

Column
GET, POST

Section

Column

width	40%

Required Parameters:

Column
`setting_id`, `state`

Section

Column

width	40%

Return Formats:

Column

JSON, XML

Multiexcerpt include

MultiExcerptName	Short Macro
PageWithExcerpt	LIB:_XMLDeprecated

About WHM API 1

Include Page

	LIB:_WHMAPI1About
	LIB:_WHMAPI1About

Find a function

Livesearch

additional	page excerpt
placeholder	Search...
labels	whmapi1

Related functions

Content by Label

showLabels	false
max	5
showSpace	false
sort	modified
excerpt	true
excerptType	simple
operator	AND
cql	label = "modsecurity" and label = "whmapi1"
labels	whmapi1,modsecurity

Child pages

Versions Compared

Old Version 5

New Version Current

Key

Description

Examples

Parameters

Returns

Anchor
Radio
Radio
Radio options

Anchor
Validators
Validators
Validators

Function information

About WHM API 1

Find a function

Related functions

Child pages

Page History

Versions Compared

Old Version 5

New Version Current

Key

Description

Examples

Parameters

Returns

AnchorRadioRadioRadio options

AnchorValidatorsValidatorsValidators

Function information

About WHM API 1

Find a function

Related functions

Anchor
Radio
Radio
Radio options

Anchor
Validators
Validators
Validators