AppProtection Control Controller

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/controlTypes

GET Gets the AppProtection control types for the specified customer.

Parameters

Name

Description

Model

string

Responses

Response content type:

Code

200

Description

OK

Example Value

string

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom

GET Gets all custom controls for a customer and sorts by control number for the specified customer.

Parameters

Name

Description

Model - PageListOfInspectionCustomControl

list

The total list of AppProtection custom controls.

totalCount

integer($int64)

The total count of resources per the search feature.

totalPages

integer($int32)

The total number of pages per the pagination attribute.

Responses

Response content type:

Code

200

Description

OK

Example Value

{
  "list": [
    {
      "action": "PASS",
      "actionValue": "string",
      "associatedInspectionProfileNames": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "controlNumber": 0,
      "controlRuleJson": "string",
      "controlType": "WEBSOCKET_PREDEFINED",
      "creationTime": 0,
      "defaultAction": "PASS",
      "defaultActionValue": "string",
      "description": "string",
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "paranoiaLevel": 0,
      "protocolType": "HTTP",
      "rules": [
        {
          "conditions": [
            {
              "lhs": "SIZE",
              "op": "RX",
              "rhs": "string"
            }
          ],
          "names": [
            "string"
          ],
          "type": "REQUEST_HEADERS"
        }
      ],
      "severity": "CRITICAL",
      "type": "REQUEST",
      "version": "string"
    }
  ],
  "totalCount": 0,
  "totalPages": 0
}

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom

POST Add a new custom control for the specified customer.

Parameters

Name

Description

customerId *required
integer($int64)
(path)

The unique identifier of the ZPA tenant.

inputControl *required
object
(body)

The object of the AppProtection control.

{
  "action": "PASS",
  "actionValue": "string",
  "associatedInspectionProfileNames": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "controlNumber": 0,
  "controlRuleJson": "string",
  "controlType": "WEBSOCKET_PREDEFINED",
  "creationTime": 0,
  "defaultAction": "PASS",
  "defaultActionValue": "string",
  "description": "string",
  "id": 0,
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "paranoiaLevel": 0,
  "protocolType": "HTTP",
  "rules": [
    {
      "conditions": [
        {
          "lhs": "SIZE",
          "op": "RX",
          "rhs": "string"
        }
      ],
      "names": [
        "string"
      ],
      "type": "REQUEST_HEADERS"
    }
  ],
  "severity": "CRITICAL",
  "type": "REQUEST",
  "version": "string"
}

Model - InspectionCustomControl

action

string

The action of the custom control.

Enum:

[

...

]

3 items

actionValue

string

Denotes the action. Supports any string.

associatedInspectionProfileNames

The names of the AppProtection profile.

controlNumber

integer($int32)

The AppProtection control number.

controlRuleJson

string

The AppProtection control rule.

controlType

string

The control type of the custom control.

Enum:

[

...

]

5 items

creationTime

integer($int32)

The time the custom control is created.

defaultAction

string

The performed action.

Enum:

[

...

]

3 items

defaultActionValue

string

Used to provide the redirect URL if the default action is set to REDIRECT.

description

string

The description of the custom control.

id

integer($int64)

The unique identifier of the custom control.

modifiedBy

integer($int64)

The unique identifier of the tenant who modified the custom control.

modifiedTime

integer($int32)

The time the custom control is modified.

name*

string

The name of the custom control.

paranoiaLevel

integer($int32)

The OWASP Predefined Paranoia Level. To learn more, see Configuring AppProtection Profiles.

protocolType

string

The protocol type of the custom control.

Enum:

[

...

]

7 items

rules

The rules of the custom controls applied as conditions.

severity

string

The severity of the AppProtection control number. To learn more, see About AppProtection Controls.

Enum:

[

...

]

4 items

type

string

The rules to be applied to the request or response type.

Enum:

[

...

]

2 items

version

string

The predefined control version.

Parameters content type:

Model - InspectionCustomControl

action

string

The action of the custom control.

Enum:

[

...

]

3 items

actionValue

string

Denotes the action. Supports any string.

associatedInspectionProfileNames

The names of the AppProtection profile.

controlNumber

integer($int32)

The AppProtection control number.

controlRuleJson

string

The AppProtection control rule.

controlType

string

The control type of the custom control.

Enum:

[

...

]

5 items

creationTime

integer($int32)

The time the custom control is created.

defaultAction

string

The performed action.

Enum:

[

...

]

3 items

defaultActionValue

string

Used to provide the redirect URL if the default action is set to REDIRECT.

description

string

The description of the custom control.

id

integer($int64)

The unique identifier of the custom control.

modifiedBy

integer($int64)

The unique identifier of the tenant who modified the custom control.

modifiedTime

integer($int32)

The time the custom control is modified.

name*

string

The name of the custom control.

paranoiaLevel

integer($int32)

The OWASP Predefined Paranoia Level. To learn more, see Configuring AppProtection Profiles.

protocolType

string

The protocol type of the custom control.

Enum:

[

...

]

7 items

rules

The rules of the custom controls applied as conditions.

severity

string

The severity of the AppProtection control number. To learn more, see About AppProtection Controls.

Enum:

[

...

]

4 items

type

string

The rules to be applied to the request or response type.

Enum:

[

...

]

2 items

version

string

The predefined control version.

Responses

Response content type:

Code

201

Description

Created

Example Value

{
  "action": "PASS",
  "actionValue": "string",
  "associatedInspectionProfileNames": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "controlNumber": 0,
  "controlRuleJson": "string",
  "controlType": "WEBSOCKET_PREDEFINED",
  "creationTime": 0,
  "defaultAction": "PASS",
  "defaultActionValue": "string",
  "description": "string",
  "id": 0,
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "paranoiaLevel": 0,
  "protocolType": "HTTP",
  "rules": [
    {
      "conditions": [
        {
          "lhs": "SIZE",
          "op": "RX",
          "rhs": "string"
        }
      ],
      "names": [
        "string"
      ],
      "type": "REQUEST_HEADERS"
    }
  ],
  "severity": "CRITICAL",
  "type": "REQUEST",
  "version": "string"
}

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/inspectionControls/customControlTypes

GET Gets the AppProtection custom control types.

Parameters

No parameters

Responses

Response content type:

Code

200

Description

OK

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}/profiles

GET Gets the AppProtection profile name for the specified ID.

Parameters

Name

Description

Model - NameIdDto

id

integer($int64)

The list of unique identifiers for the entity type.

name

string

The list of names for the entity type.

Responses

Response content type:

Code

200

Description

OK

Example Value

{
  "id": 0,
  "name": "string"
}

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/httpMethods

GET Gets the supported HTTP methods in custom controls for the specified customer.

Parameters

Name

Description

Model

string

Responses

Response content type:

Code

200

Description

OK

Example Value

string

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/severityTypes

GET Gets the AppProtection control severity types for the specified customer.

Parameters

Name

Description

Model

string

Responses

Response content type:

Code

200

Description

OK

Example Value

string

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}

GET Gets the custom control for the specified ID.

Parameters

Name

Description

Model - InspectionCustomControl

action

string

The action of the custom control.

Enum:

[

...

]

3 items

actionValue

string

Denotes the action. Supports any string.

associatedInspectionProfileNames

The names of the AppProtection profile.

controlNumber

integer($int32)

The AppProtection control number.

controlRuleJson

string

The AppProtection control rule.

controlType

string

The control type of the custom control.

Enum:

[

...

]

5 items

creationTime

integer($int32)

The time the custom control is created.

defaultAction

string

The performed action.

Enum:

[

...

]

3 items

defaultActionValue

string

Used to provide the redirect URL if the default action is set to REDIRECT.

description

string

The description of the custom control.

id

integer($int64)

The unique identifier of the custom control.

modifiedBy

integer($int64)

The unique identifier of the tenant who modified the custom control.

modifiedTime

integer($int32)

The time the custom control is modified.

name*

string

The name of the custom control.

paranoiaLevel

integer($int32)

The OWASP Predefined Paranoia Level. To learn more, see Configuring AppProtection Profiles.

protocolType

string

The protocol type of the custom control.

Enum:

[

...

]

7 items

rules

The rules of the custom controls applied as conditions.

severity

string

The severity of the AppProtection control number. To learn more, see About AppProtection Controls.

Enum:

[

...

]

4 items

type

string

The rules to be applied to the request or response type.

Enum:

[

...

]

2 items

version

string

The predefined control version.

Responses

Response content type:

Code

200

Description

OK

Example Value

{
  "action": "PASS",
  "actionValue": "string",
  "associatedInspectionProfileNames": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "controlNumber": 0,
  "controlRuleJson": "string",
  "controlType": "WEBSOCKET_PREDEFINED",
  "creationTime": 0,
  "defaultAction": "PASS",
  "defaultActionValue": "string",
  "description": "string",
  "id": 0,
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "paranoiaLevel": 0,
  "protocolType": "HTTP",
  "rules": [
    {
      "conditions": [
        {
          "lhs": "SIZE",
          "op": "RX",
          "rhs": "string"
        }
      ],
      "names": [
        "string"
      ],
      "type": "REQUEST_HEADERS"
    }
  ],
  "severity": "CRITICAL",
  "type": "REQUEST",
  "version": "string"
}

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}

PUT Updates the existing custom control for the specified ID.

Parameters

Name

Description

customerId *required
integer($int64)
(path)

The unique identifier of the ZPA tenant.

id *required
integer($int64)
(path)

The unique identifier of the AppProtection control.

inputControl *required
object
(body)

The object of the inspection control.

{
  "action": "PASS",
  "actionValue": "string",
  "associatedInspectionProfileNames": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "controlNumber": 0,
  "controlRuleJson": "string",
  "controlType": "WEBSOCKET_PREDEFINED",
  "creationTime": 0,
  "defaultAction": "PASS",
  "defaultActionValue": "string",
  "description": "string",
  "id": 0,
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "paranoiaLevel": 0,
  "protocolType": "HTTP",
  "rules": [
    {
      "conditions": [
        {
          "lhs": "SIZE",
          "op": "RX",
          "rhs": "string"
        }
      ],
      "names": [
        "string"
      ],
      "type": "REQUEST_HEADERS"
    }
  ],
  "severity": "CRITICAL",
  "type": "REQUEST",
  "version": "string"
}

Model - InspectionCustomControl

action

string

The action of the custom control.

Enum:

[

...

]

3 items

actionValue

string

Denotes the action. Supports any string.

associatedInspectionProfileNames

The names of the AppProtection profile.

controlNumber

integer($int32)

The AppProtection control number.

controlRuleJson

string

The AppProtection control rule.

controlType

string

The control type of the custom control.

Enum:

[

...

]

5 items

creationTime

integer($int32)

The time the custom control is created.

defaultAction

string

The performed action.

Enum:

[

...

]

3 items

defaultActionValue

string

Used to provide the redirect URL if the default action is set to REDIRECT.

description

string

The description of the custom control.

id

integer($int64)

The unique identifier of the custom control.

modifiedBy

integer($int64)

The unique identifier of the tenant who modified the custom control.

modifiedTime

integer($int32)

The time the custom control is modified.

name*

string

The name of the custom control.

paranoiaLevel

integer($int32)

The OWASP Predefined Paranoia Level. To learn more, see Configuring AppProtection Profiles.

protocolType

string

The protocol type of the custom control.

Enum:

[

...

]

7 items

rules

The rules of the custom controls applied as conditions.

severity

string

The severity of the AppProtection control number. To learn more, see About AppProtection Controls.

Enum:

[

...

]

4 items

type

string

The rules to be applied to the request or response type.

Enum:

[

...

]

2 items

version

string

The predefined control version.

Parameters content type:

Responses

Response content type:

Code

201

Description

Created

Code

204

Description

No Content

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}

DELETE Deletes the custom control for the specified ID.

Parameters

Name

Description

Responses

Response content type:

Code

204

Description

No Content

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/predefined/versions

GET Get all versions of the predefined AppProtection controls for the specified customer.

Parameters

Name

Description

Model

string

Responses

Response content type:

Code

200

Description

OK

Example Value

string

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/actionTypes

GET Gets the AppProtection control action types for the specified customer.

Parameters

Name

Description

Model

string

Responses

Response content type:

Code

200

Description

OK

Example Value

string

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/predefined/{id}

GET Gets the predefined AppProtection controls for the specified ID.

Parameters

Name

Description

Model - InspectionPredefinedControl

action

string

The action of the predefined control.

Enum:

[

...

]

3 items

actionValue

string

The value for the predefined controls action. This field is only required if the action is set to REDIRECT.

associatedInspectionProfileNames

The names of the AppProtection profile.

attachment

string

The control attachment.

controlGroup

string

The control group.

controlNumber

integer($int32)

The control number of the predefined control.

controlType

string

The control type of the custom control.

Enum:

[

...

]

5 items

creationTime

integer($int32)

The time the custom control is created.

defaultAction

string

The performed action.

Enum:

[

...

]

3 items

defaultActionValue

string

Used to provide the redirect URL if the default action is set to REDIRECT.

description

string

The description of the predefined control.

id

integer($int64)

The unique identifier of the predefined control.

modifiedBy

integer($int64)

The unique identifier of the tenant who modified the predefined control.

modifiedTime

integer($int32)

The time the predefined control is modified.

name*

string

The name of the application.

paranoiaLevel

integer($int32)

The OWASP Predefined Paranoia Level. To learn more, see Configuring AppProtection Profiles.

protocolType

string

The protocol type of the predefined control.

Enum:

[

...

]

7 items

severity

string

The severity of the AppProtection control number. To learn more, see About AppProtection Controls.

Enum:

[

...

]

4 items

version

string

The predefined control version.

Responses

Response content type:

Code

200

Description

OK

Example Value

{
  "action": "PASS",
  "actionValue": "string",
  "associatedInspectionProfileNames": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "attachment": "string",
  "controlGroup": "string",
  "controlNumber": 0,
  "controlType": "WEBSOCKET_PREDEFINED",
  "creationTime": 0,
  "defaultAction": "PASS",
  "defaultActionValue": "string",
  "description": "string",
  "id": 0,
  "modifiedBy": 0,
  "modifiedTime": 0,
  "name": "string",
  "paranoiaLevel": 0,
  "protocolType": "HTTP",
  "severity": "CRITICAL",
  "version": "string"
}

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/predefined

GET Gets all predefined AppProtection controls for the specified customer.

Parameters

Name

Description

Model - InspectionPredefinedControlResource

controlGroup

string

The control group.

defaultGroup

boolean

Indicates whether or not the controlGroup is a part of the mandatory controls group. This is only used by the ZPA Admin Portal.

predefinedInspectionControls

The list predefined controls.

Responses

Response content type:

Code

200

Description

OK

Example Value

{
  "controlGroup": "string",
  "defaultGroup": true,
  "predefinedInspectionControls": [
    {
      "action": "PASS",
      "actionValue": "string",
      "associatedInspectionProfileNames": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "attachment": "string",
      "controlGroup": "string",
      "controlNumber": 0,
      "controlType": "WEBSOCKET_PREDEFINED",
      "creationTime": 0,
      "defaultAction": "PASS",
      "defaultActionValue": "string",
      "description": "string",
      "id": 0,
      "modifiedBy": 0,
      "modifiedTime": 0,
      "name": "string",
      "paranoiaLevel": 0,
      "protocolType": "HTTP",
      "severity": "CRITICAL",
      "version": "string"
    }
  ]
}

Code

401

Description

Unauthorized

Code

403

Description

Forbidden

Code

404

Description

Not Found

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/controlTypes

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom

/mgmtconfig/v1/admin/inspectionControls/customControlTypes

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}/profiles

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/httpMethods

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/severityTypes

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/custom/{id}

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/predefined/versions

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/actionTypes

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/predefined/{id}

/mgmtconfig/v1/admin/customers/{customerId}/inspectionControls/predefined

Was this article helpful? Click an icon below to submit feedback.