Skip to main content

List File Blocking Actions

GET 
/v1/config/rulestacks/:rulestackname/fileblockingprofiles/custom/filetypes

Retrieves the metadata for the file blocking profile defined for a specified rulestack.

Request​

Path Parameters

    rulestackname stringrequired

    The name of the rulestack.

Query Parameters

    nexttoken Nexttoken

    If the number of file blocking actions available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of file blocking actions, use this token in your next request.

    candidate Candidate

    Default value: true

    File blocking action candidate.

    running Running

    File blocking actions in run state.

    uncommitted Uncommitted

    Uncommitted file blocking actions.

    maxresults Maxresults

    Possible values: >= 1 and <= 1024

    Default value: 1024

    The maximum number of file blocking actions that you want NGFW to return for this request.

    describe Describe

    Retrieve file blocking action information.

Responses​

OK

Schema
    Response object

    The API call response.

    FileBlockingCandidate string[]

    File blocking action candidate.

    FileBlockingRunning string[]

    File blocking action on run state.

    FileBlockingUncommitted object[]

    Uncommitted file blocking actions.

  • Array [
    • Name Name (string)required

    Name of the file blocking action.

    Operation Operation (string)required

    File blocking action operation.

  • ]
    • NextToken Nexttoken (string)

    If the number of file blocking actions available for retrieval exceeds the maximum you requested, NGFW returns a NextToken value in response. To retrieve the next batch of file blocking actions, use this token in your next request.

    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.
    • ResourceNotFoundException—Unable to locate a resource using the parameters you provided.
    • 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.

Loading...