Create a RuleStack

POST 
/v1/config/rulestacks

Create a global or local rulestack. Global role affects only Global rulestacks and Local role affects only local rulestacks.

Request

application/json

Body

RuleStackEntry object

Describe whether the rulestack is local or global.

AccountId Accountid (string)

Possible values: <= 12 characters, Value must match regular expression ^$|^[0-9]+$

The unique ID of the account.

Description Description (string)

Possible values: <= 512 characters

Description of the rulestack.

Profiles object

Rulestack profile.

AntiSpywareProfile Antispywareprofile (string)

Possible values: [custom, BestPractice]

Default value: BestPractice

Anti-spyware security profile.

AntiVirusProfile Antivirusprofile (string)

Possible values: [custom, BestPractice]

Default value: BestPractice

Anti-virus security profile.

FileBlockingProfile Fileblockingprofile (string)

Possible values: [custom, BestPractice]

Default value: BestPractice

File blocking security profile.

OutboundTrustCertificate Outboundtrustcertificate (string)

Outbound trust certificate profile.

OutboundUnTrustCertificate Outbounduntrustcertificate (string)

Outbound untrust certificate profile.

URLFilteringProfile Urlfilteringprofile (string)

Possible values: [custom, BestPractice, None]

Default value: None

URL filtering security profile.

VulnerabilityProfile Vulnerabilityprofile (string)

Possible values: [custom, BestPractice]

Default value: BestPractice

Vulnerability security profile.

Scope Scope (string)

Possible values: [Global, Local]

The scope of the rulestack.

RuleStackName Rulestackname (string)required

Possible values: non-empty and <= 128 characters, Value must match regular expression ^[a-zA-Z0-9-]+$

Name of the rulestack.

Responses

200

OK

application/json

Schema

Schema

Response object

RuleStackEntry object

Describe whether the rulestack is local or global.

AccountId Accountid (string)

Possible values: <= 12 characters, Value must match regular expression ^$|^[0-9]+$

The unique ID of the account.

Description Description (string)

Possible values: <= 512 characters

Description of the rulestack.

Profiles object

Rulestack profile.

AntiSpywareProfile Antispywareprofile (string)

Possible values: [custom, BestPractice]

Default value: BestPractice

Anti-spyware security profile.

AntiVirusProfile Antivirusprofile (string)

Possible values: [custom, BestPractice]

Default value: BestPractice

Anti-virus security profile.

FileBlockingProfile Fileblockingprofile (string)

Possible values: [custom, BestPractice]

Default value: BestPractice

File blocking security profile.

OutboundTrustCertificate Outboundtrustcertificate (string)

Outbound trust certificate profile.

OutboundUnTrustCertificate Outbounduntrustcertificate (string)

Outbound untrust certificate profile.

URLFilteringProfile Urlfilteringprofile (string)

Possible values: [custom, BestPractice, None]

Default value: None

URL filtering security profile.

VulnerabilityProfile Vulnerabilityprofile (string)

Possible values: [custom, BestPractice]

Default value: BestPractice

Vulnerability security profile.

Scope Scope (string)

Possible values: [Global, Local]

The scope of the rulestack.

UpdateToken Updatetoken (string)

RuleStackName Rulestackname (string)

Name of the rulestack.

ResponseStatus object

ErrorCode Errorcode (integer)

Default value: 0

Default value of a successful response is 0. Any other number indicates an error code.

400—HTTP bad request

• InvalidOperationException—Operation failed because it is not valid. For example, when you delete an NGFW or rulestack in use.
• InvalidRequestException—Operation failed due to invalid request. For example, unsupported parameter name or value in the request.
• LimitExceededException—Operation failed due to violation in limit settings.
• ThrottlingException—Operation failed due to throttling limitations.

500—Bad request

• InternalServerError—Your request is valid but Cloud NGFW could not perform the operation due to a system issue.
• InsufficientCapacityException—AWS currently does not have enough capacity to fulfill your request.

Reason Reason (string)

The error description.

Example (from schema)

{
  "Response": {
    "RuleStackEntry": {
      "AccountId": "string",
      "Description": "string",
      "Profiles": {
        "AntiSpywareProfile": "BestPractice",
        "AntiVirusProfile": "BestPractice",
        "FileBlockingProfile": "BestPractice",
        "OutboundTrustCertificate": "string",
        "OutboundUnTrustCertificate": "string",
        "URLFilteringProfile": "None",
        "VulnerabilityProfile": "BestPractice"
      },
      "Scope": "Global",
      "UpdateToken": "string"
    },
    "RuleStackName": "string"
  },
  "ResponseStatus": {
    "ErrorCode": 0,
    "Reason": "string"
  }
}

Loading...