Describe a RuleStack

GET 
/v1/config/rulestacks/:rulestackname

Returns the data of the specific rulestack.

Request

Path Parameters

rulestackname stringrequired

The name of the rulestack.

application/json

Body

Candidate Candidate (boolean)

Default value: true

Rulestack candidate.

MaxResults Maxresults (integer)

Possible values: > 0 and < 101

The maximum number of rulestacks that you want NGFW to return for this request.

Running Running (boolean)

Rulestacks in run state.

Responses

200

OK

application/json

Schema

Schema

Response object
RuleStackCandidate object
Rulestack candidate.
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)
Refresh token
RuleStackName Rulestackname (string)
Name of the rulestack.
RuleStackRunning object
Rulestacks in run state.
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)
Refresh token
RuleStackState Rulestackstate (string)
State of rulestack.
Tags object[]
The tags associated with the rulestack.
Array [
Key Key (string)required
Possible values: non-empty and <= 128 characters, Value must match regular expression ^.*$
A unique identifier in the key-value pair. The constant that defines the data set. .
Value Value (string)required
Possible values: non-empty and <= 256 characters, Value must match regular expression ^.*$
The variable that belongs to the data set.
]
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

• 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.

Reason Reason (string)

The error description.

Example (from schema)

{
  "Response": {
    "RuleStackCandidate": {
      "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",
    "RuleStackRunning": {
      "AccountId": "string",
      "Description": "string",
      "Profiles": {
        "AntiSpywareProfile": "BestPractice",
        "AntiVirusProfile": "BestPractice",
        "FileBlockingProfile": "BestPractice",
        "OutboundTrustCertificate": "string",
        "OutboundUnTrustCertificate": "string",
        "URLFilteringProfile": "None",
        "VulnerabilityProfile": "BestPractice"
      },
      "Scope": "Global",
      "UpdateToken": "string"
    },
    "RuleStackState": "string",
    "Tags": [
      {
        "Key": "string",
        "Value": "string"
      }
    ]
  },
  "ResponseStatus": {
    "ErrorCode": 0,
    "Reason": "string"
  }
}

Loading...