Palo Alto Networks File Blocking Action API
The FileBlockingAction API from Palo Alto Networks — 2 operation(s) for fileblockingaction.
OpenAPI Specification
openapi: 3.2.0
info:
contact: {}
description: "Allows you to identify specific file types that you want to block. \n\n### Permission Policies\n\n| Action | Local Firewall Administrator | Local Rulestack Administrator | Global Rulestack Administrator|\n| ------------------------------- | :--------------------------: | :---------------------------: | :---------------------------: |\n| Create a File Blocking Action | ☐ | **☑** | **☑** | \n| Update a File Blocking Action | ☐ | **☑** | **☑** | \n| Delete a File Blocking Action | ☐ | **☑** | **☑** | \n| Describe a File Blocking Action | **☑** | **☑** | **☑** |\n"
title: Manage File Blocking Action API
version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: FileBlockingAction
paths:
/v1/config/rulestacks/{rulestackname}/fileblockingprofiles/custom/filetypes:
get:
description: 'Retrieve the metadata for the file blocking profile defined for a specified rulestack.
'
operationId: get-v1-config-rulestacks-rulestackname-fileblockingprofiles-custom-filetypes
parameters:
- description: 'The name of the rulestack.
'
in: path
name: rulestackname
required: true
schema:
type: string
- description: ''
in: query
name: nexttoken
required: false
schema:
title: Nexttoken
type: string
- description: ''
in: query
name: candidate
required: false
schema:
default: true
title: Candidate
type: boolean
- description: ''
in: query
name: running
required: false
schema:
default: false
title: Running
type: boolean
- description: ''
in: query
name: uncommitted
required: false
schema:
default: false
title: Uncommitted
type: boolean
- description: ''
in: query
name: maxresults
required: false
schema:
default: 1024
maximum: 1024
minimum: 1
title: Maxresults
type: integer
- description: ''
in: query
name: describe
required: false
schema:
default: false
title: Describe
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ListFileBlockingActionResponse'
description: OK
summary: Retrieve file blocking profile
tags:
- FileBlockingAction
/v1/config/rulestacks/{rulestackname}/fileblockingprofiles/custom/filetypes/{type}:
get:
description: 'Retrieve the data related to the file blocking profile attached to a specified rulestack.
'
operationId: get-v1-config-rulestacks-rulestackname-fileblockingprofiles-custom-filetypes-type
parameters:
- description: 'The name of the rulestack.
'
in: path
name: rulestackname
required: true
schema:
type: string
- description: 'The type of file blocking action.
'
in: path
name: type
required: true
schema:
type: string
- description: ''
in: query
name: running
required: false
schema:
default: false
title: Running
type: boolean
- description: ''
in: query
name: candidate
required: false
schema:
default: true
title: Candidate
type: boolean
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DescribeFileBlockingActionResponse'
description: OK
summary: Retrieve file blocking data
tags:
- FileBlockingAction
put:
description: 'Update the file blocking profile for a specified rulestack.
'
operationId: put-v1-config-rulestacks-rulestackname-fileblockingprofiles-custom-filetypes-type
parameters:
- description: 'The name of the rulestack.
'
in: path
name: rulestackname
required: true
schema:
type: string
- description: 'The type of file blocking action.
'
in: path
name: type
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFileBlockingActionRequest'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateFileBlockingActionResponse'
description: OK
summary: Update file blocking profile
tags:
- FileBlockingAction
components:
schemas:
UpdateFileBlockingActionResponse:
additionalProperties: false
properties:
Response:
$ref: '#/components/schemas/UpdateFileBlockingActionResponse.ResponseData'
ResponseStatus:
$ref: '#/components/schemas/UpdateFileBlockingActionResponse.Result'
title: UpdateFileBlockingActionResponse
type: object
DescribeFileBlockingActionResponse:
additionalProperties: false
properties:
Response:
$ref: '#/components/schemas/DescribeFileBlockingActionResponse.ResponseData'
ResponseStatus:
$ref: '#/components/schemas/DescribeFileBlockingActionResponse.Result'
title: DescribeFileBlockingActionResponse
type: object
DescribeFileBlockingActionResponse.ResponseData:
additionalProperties: false
properties:
FileBlockingCandidate:
$ref: '#/components/schemas/DescribeFileBlockingActionResponse.FileBlockingEntry'
FileBlockingRunning:
$ref: '#/components/schemas/DescribeFileBlockingActionResponse.FileBlockingEntry'
FileType:
title: Filetype
type: string
RuleStackName:
title: Rulestackname
type: string
title: ResponseData
type: object
ListFileBlockingActionResponse.ResponseData:
additionalProperties: false
properties:
FileBlockingCandidate:
items:
type: string
title: Fileblockingcandidate
type: array
FileBlockingRunning:
items:
type: string
title: Fileblockingrunning
type: array
FileBlockingUncommitted:
items:
$ref: '#/components/schemas/ListFileBlockingActionResponse.UncommittedFileBlocking'
title: Fileblockinguncommitted
type: array
NextToken:
title: Nexttoken
type: string
RuleStackName:
title: Rulestackname
type: string
title: ResponseData
type: object
UpdateFileBlockingActionRequest:
additionalProperties: false
properties:
Action:
enum:
- alert
- block
title: Action
type: string
AuditComment:
title: Auditcomment
type: string
Description:
maxLength: 255
title: Description
type: string
Direction:
enum:
- upload
- download
- both
title: Direction
type: string
UpdateToken:
title: Updatetoken
type: string
required:
- Direction
- Action
title: UpdateFileBlockingActionRequest
type: object
UpdateFileBlockingActionResponse.ResponseData:
additionalProperties: false
properties:
FileBlockingEntry:
$ref: '#/components/schemas/UpdateFileBlockingActionResponse.FileBlockingEntry'
FileType:
title: Filetype
type: string
RuleStackName:
title: Rulestackname
type: string
title: ResponseData
type: object
ListFileBlockingActionResponse.Result:
additionalProperties: false
properties:
ErrorCode:
default: 0
title: Errorcode
type: integer
Reason:
title: Reason
type: string
title: Result
type: object
UpdateFileBlockingActionResponse.FileBlockingEntry:
additionalProperties: false
properties:
Action:
default: alert
enum:
- alert
- block
- continue
title: Action
type: string
AuditComment:
title: Auditcomment
type: string
Description:
maxLength: 255
title: Description
type: string
Direction:
default: both
enum:
- upload
- download
- both
title: Direction
type: string
UpdateToken:
default: '1'
title: Updatetoken
type: string
title: FileBlockingEntry
type: object
UpdateFileBlockingActionResponse.Result:
additionalProperties: false
properties:
ErrorCode:
default: 0
title: Errorcode
type: integer
Reason:
title: Reason
type: string
title: Result
type: object
ListFileBlockingActionResponse.UncommittedFileBlocking:
additionalProperties: false
properties:
Name:
title: Name
type: string
Operation:
title: Operation
type: string
required:
- Name
- Operation
title: UncommittedFileBlocking
type: object
DescribeFileBlockingActionResponse.Result:
additionalProperties: false
properties:
ErrorCode:
default: 0
title: Errorcode
type: integer
Reason:
title: Reason
type: string
title: Result
type: object
DescribeFileBlockingActionResponse.FileBlockingEntry:
additionalProperties: false
properties:
Action:
default: alert
enum:
- alert
- block
- continue
title: Action
type: string
AuditComment:
title: Auditcomment
type: string
Description:
maxLength: 255
title: Description
type: string
Direction:
default: both
enum:
- upload
- download
- both
title: Direction
type: string
UpdateToken:
default: '1'
title: Updatetoken
type: string
title: FileBlockingEntry
type: object
ListFileBlockingActionResponse:
additionalProperties: false
properties:
Response:
$ref: '#/components/schemas/ListFileBlockingActionResponse.ResponseData'
ResponseStatus:
$ref: '#/components/schemas/ListFileBlockingActionResponse.Result'
title: ListFileBlockingActionResponse
type: object