Palo Alto Networks Document Types API
The Document Types API from Palo Alto Networks — 2 operation(s) for document types.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/palo-alto-networks-document-types-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
contact: {}
description: "Manage document type classifications for enhanced document scanning and categorization. Define custom \ndocument types to improve detection accuracy and enable type-specific DLP policies.\n"
license:
name: MIT
url: https://opensource.org/license/mit
title: v2 Document Types API
version: 1.0.0
servers:
- url: https://api.dlp.paloaltonetworks.com
tags:
- name: Document Types
paths:
/v2/api/document-types:
get:
description: Returns a paginated list of document types for the authenticated tenant.
operationId: get-v2-api-document-types
parameters:
- description: Zero-based page index (0..N)
in: query
name: page
required: false
schema:
default: 0
minimum: 0
type: integer
- description: The size of the page to be returned
in: query
name: size
required: false
schema:
default: 20
minimum: 1
type: integer
- description: 'Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.'
in: query
name: sort
required: false
schema:
items:
type: string
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/PageDocumentTypeResponse'
description: Paginated list of document types
'401':
description: Unauthorized
'403':
description: Forbidden - insufficient privileges
security:
- Bearer: []
summary: List Document Types
tags:
- Document Types
post:
description: Creates a document type by uploading training files (multipart/form-data).
operationId: post-v2-api-document-types
requestBody:
content:
multipart/form-data:
schema:
properties:
file:
format: binary
type: string
json:
$ref: '#/components/schemas/DocumentTypeRequest'
negative:
format: binary
type: string
positive:
format: binary
type: string
required:
- json
type: object
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentTypeResponse'
description: Document type created
'400':
description: Invalid request payload or missing required files
'401':
description: Unauthorized
'403':
description: Forbidden - insufficient privileges
security:
- Bearer: []
summary: Create Document Type
tags:
- Document Types
/v2/api/document-types/{resourceId}:
delete:
description: Deletes a document type by its ID.
operationId: delete-v2-api-document-types-resourceid
parameters:
- in: path
name: resourceId
required: true
schema:
type: string
responses:
'204':
description: Document type deleted
'401':
description: Unauthorized
'403':
description: Forbidden - insufficient privileges
'404':
description: Document type not found
security:
- Bearer: []
summary: Delete Document Type
tags:
- Document Types
get:
description: Retrieves a single document type by its ID.
operationId: get-v2-api-document-types-resourceid
parameters:
- in: path
name: resourceId
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentTypeResponse'
description: Document type found
'401':
description: Unauthorized
'403':
description: Forbidden - insufficient privileges
'404':
description: Document type not found
security:
- Bearer: []
summary: Get Document Type
tags:
- Document Types
patch:
description: Partially updates an existing document type using JSON Merge Patch semantics.
operationId: patch-v2-api-document-types-resourceid
parameters:
- in: path
name: resourceId
required: true
schema:
type: string
requestBody:
content:
application/merge-patch+json:
schema:
$ref: '#/components/schemas/DocumentTypePatchRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentTypeResponse'
description: Document type updated
'400':
description: Invalid patch payload
'401':
description: Unauthorized
'403':
description: Forbidden - insufficient privileges
'404':
description: Document type not found
security:
- Bearer: []
summary: Patch Document Type
tags:
- Document Types
put:
description: Fully replaces an existing document type with the provided payload.
operationId: put-v2-api-document-types-resourceid
parameters:
- in: path
name: resourceId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentTypeRequest'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/DocumentTypeResponse'
description: Document type updated
'400':
description: Invalid request payload
'401':
description: Unauthorized
'403':
description: Forbidden - insufficient privileges
'404':
description: Document type not found
security:
- Bearer: []
summary: Update Document Type
tags:
- Document Types
components:
schemas:
PageDocumentTypeResponse:
properties:
content:
items:
$ref: '#/components/schemas/DocumentTypeResponse'
type: array
empty:
type: boolean
first:
type: boolean
last:
type: boolean
number:
format: int32
type: integer
numberOfElements:
format: int32
type: integer
pageable:
$ref: '#/components/schemas/PageableObject'
size:
format: int32
type: integer
sort:
$ref: '#/components/schemas/SortObject'
totalElements:
format: int64
type: integer
totalPages:
format: int32
type: integer
type: object
DocumentTypeResponse:
description: Document type resource returned by the API
properties:
audit_metadata:
$ref: '#/components/schemas/AuditResponse'
category:
description: Category for grouping
type: string
description:
description: Optional human-readable description
type: string
detection_sub_technique:
description: Detection sub-technique
enum:
- dnn
- gamma
- ml_gateway
- encoding
- password_protected
- encryption
- compression
- threshold
type: string
detection_technique:
description: Detection technique used
enum:
- edm
- document_fingerprint
- trainable_classifier
- ml_document
- regex
- weighted_regex
- ml
- titus_tag
- wildfire
- file_property
- dictionary
- pab
- document_classifier
type: string
id:
description: Unique identifier of the document type
type: string
license_type:
description: License type associated with this document type
enum:
- standard
- enterprise
- essentials
type: string
metadata:
$ref: '#/components/schemas/DocMetadataDTO'
name:
description: Display name of the document type
type: string
status:
description: Configuration and training status
enum:
- completed
- failed
- inProgress
- available
type: string
supported_confidence_levels:
description: List of confidence levels supported
items:
description: List of confidence levels supported
enum:
- low
- medium
- high
type: string
type: array
type:
description: Document type classification
enum:
- custom
- predefined
type: string
version:
description: Version number, incremented on each update
format: int32
type: integer
type: object
JsonNullableString:
description: New description (set to null to clear)
properties:
present:
type: boolean
undefined:
type: boolean
type: object
SortObject:
properties:
empty:
type: boolean
sorted:
type: boolean
unsorted:
type: boolean
type: object
PageableObject:
properties:
offset:
format: int64
type: integer
pageNumber:
format: int32
type: integer
pageSize:
format: int32
type: integer
paged:
type: boolean
sort:
$ref: '#/components/schemas/SortObject'
unpaged:
type: boolean
type: object
JsonNullableInteger:
description: New priority order
properties:
present:
type: boolean
undefined:
type: boolean
type: object
DocumentTypePatchRequest:
description: Request payload for partially updating a document type (JSON Merge Patch)
properties:
category:
$ref: '#/components/schemas/JsonNullableString'
description:
$ref: '#/components/schemas/JsonNullableString'
detection_technique:
$ref: '#/components/schemas/JsonNullableDetectionTechnique'
l1_category_id:
$ref: '#/components/schemas/JsonNullableInteger'
l2_category_id:
$ref: '#/components/schemas/JsonNullableInteger'
name:
$ref: '#/components/schemas/JsonNullableString'
original_file_name:
$ref: '#/components/schemas/JsonNullableString'
required:
- category
- detection_technique
- name
- original_file_name
type: object
JsonNullableDetectionTechnique:
description: New detection technique
properties:
present:
type: boolean
undefined:
type: boolean
type: object
AuditResponse:
description: Audit metadata tracking creation and last-update information
properties:
created_at:
description: Timestamp when the resource was created
format: date-time
type: string
created_by:
description: Username or service that created the resource
type: string
updated_at:
description: Timestamp when the resource was last updated
format: date-time
type: string
updated_by:
description: Username or service that last updated the resource
type: string
type: object
DocumentTypeRequest:
description: Request payload for creating or updating a document type (use as the 'json' part in multipart/form-data)
properties:
category:
description: Category for grouping
enum:
- Academic
- Confidential
- Employment
- Financial
- Government
- Healthcare
- Legal
- Marketing
- Source Code
type: string
description:
description: Optional human-readable description
type: string
detection_technique:
description: 'Detection technique: document_fingerprint or trainable_classifier'
enum:
- edm
- document_fingerprint
- trainable_classifier
- ml_document
- regex
- weighted_regex
- ml
- titus_tag
- wildfire
- file_property
- dictionary
- pab
- document_classifier
type: string
l1_category_id:
description: L1 category ID for hierarchical classification
format: int32
type: integer
l2_category_id:
description: L2 category ID for hierarchical classification
format: int32
type: integer
name:
description: Display name of the document type
type: string
original_file_name:
description: Original file name of the uploaded training file
type: string
required:
- category
- detection_technique
- name
- original_file_name
type: object
DocMetadataDTO:
description: Technique-specific metadata (fingerprint or classifier details)
type: object
securitySchemes:
Bearer:
scheme: bearer
type: http