Skip to main content

Describe a FQDNList

GET 
/v1/config/rulestacks/:rulestackname/fqdnlists/:name

Return the information the FDQN list associated with a rulestack.

Request​

Path Parameters

    rulestackname stringrequired

    The name of the rulestack.

    name stringrequired

    The name of the FQDN list.

Body

    Candidate Candidate (boolean)

    Default value: true

    Rulestack candidate.

    Running Running (boolean)

    Rulestacks in run state.

Responses​

OK

Schema
    Response object

    The API call response.

    FqdnListCandidate object

    The FQDN list candidate.

    AuditComment Auditcomment (string)

    Audit remarks.

    Description Description (string)

    The FQDN list description.

    FqdnList string[]required

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

    The FQDN list.

    FqdnListRunning object

    The FQDN lists on run state.

    AuditComment Auditcomment (string)

    Audit remarks.

    Description Description (string)

    The FQDN list description.

    FqdnList string[]required

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

    The FQDN list.

    Name Name (string)

    Name of the FQDN list entry.

    RuleStackName Rulestackname (string)

    Name of the rulestack.

    ResponseStatus object

    The API call response status.

    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.
    • AccessDeniedException—You do not have sufficient access to perform this action.

    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.

Loading...