Palo Alto Networks Vms API
{'$ref': 'desc/vms/vms.md'}
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-vms-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:
title: Palo Alto Networks Vms API
x-description-source: desc/intro.md
version: '1.0'
description: 'Operations tagged Vms across 4 of this provider''s published API definitions: palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json, palo-alto-compute-openapi-34-04-145-sh-openapi.json, palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json, palo-alto-cwpp-openapi-34-04-145-saas-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: PATH_TO_CONSOLE
tags:
- name: Vms
description: Vms. 6 operations in this definition.
x-description-source: desc/vms/vms.md
paths:
/api/v34.03/vms:
get:
description: 'Get VM Image Scan Results. GET /api/v34.03/vms on the Vms API. Takes 14 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Filters the result based on VM IDs.
'
in: query
name: id
schema:
description: 'Filters the result based on VM IDs.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on image names.
'
in: query
name: name
schema:
description: 'Filters the result based on image names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud credentials.
'
in: query
name: credential
schema:
description: 'Filters the result based on cloud credentials.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on release versions.
'
in: query
name: release
schema:
description: 'Filters the result based on release versions.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
in: query
name: imageType
schema:
description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on compliance IDs.
'
items:
$ref: '#/components/schemas/int'
type: array
- description: 'Filters the result based on applied compliance rule name.
'
in: query
name: complianceRuleName
schema:
type: string
- description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.
Default is false.
'
in: query
name: normalizedSeverity
schema:
type: boolean
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.ImageScanResult'
description: ''
default:
description: ''
tags:
- Vms
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-vms
summary: Get VM Image Scan Results
x-description-source: desc/vms/get.md
/api/v34.03/vms/download:
get:
description: 'Download VM Image Scan Results. GET /api/v34.03/vms/download on the Vms API. Takes 14 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Filters the result based on VM IDs.
'
in: query
name: id
schema:
description: 'Filters the result based on VM IDs.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on image names.
'
in: query
name: name
schema:
description: 'Filters the result based on image names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud credentials.
'
in: query
name: credential
schema:
description: 'Filters the result based on cloud credentials.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on release versions.
'
in: query
name: release
schema:
description: 'Filters the result based on release versions.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
in: query
name: imageType
schema:
description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on compliance IDs.
'
items:
$ref: '#/components/schemas/int'
type: array
- description: 'Filters the result based on applied compliance rule name.
'
in: query
name: complianceRuleName
schema:
type: string
- description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.
Default is false.
'
in: query
name: normalizedSeverity
schema:
type: boolean
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
description: OK
default:
description: ''
tags:
- Vms
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-vms-download
summary: Download VM Image Scan Results
x-description-source: desc/vms/download_get.md
/api/v34.03/vms/labels:
get:
description: 'Get VM Image Tags. GET /api/v34.03/vms/labels on the Vms API. Takes 14 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Filters the result based on VM IDs.
'
in: query
name: id
schema:
description: 'Filters the result based on VM IDs.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on image names.
'
in: query
name: name
schema:
description: 'Filters the result based on image names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud credentials.
'
in: query
name: credential
schema:
description: 'Filters the result based on cloud credentials.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on release versions.
'
in: query
name: release
schema:
description: 'Filters the result based on release versions.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
in: query
name: imageType
schema:
description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on compliance IDs.
'
items:
$ref: '#/components/schemas/int'
type: array
- description: 'Filters the result based on applied compliance rule name.
'
in: query
name: complianceRuleName
schema:
type: string
- description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.
Default is false.
'
in: query
name: normalizedSeverity
schema:
type: boolean
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_string'
description: ''
default:
description: ''
tags:
- Vms
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-vms-labels
summary: Get VM Image Tags
x-description-source: desc/vms/labels_get.md
/api/v34.03/vms/names:
get:
description: 'Get VM Image Names. GET /api/v34.03/vms/names on the Vms API. Takes 14 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Filters the result based on VM IDs.
'
in: query
name: id
schema:
description: 'Filters the result based on VM IDs.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on image names.
'
in: query
name: name
schema:
description: 'Filters the result based on image names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud credentials.
'
in: query
name: credential
schema:
description: 'Filters the result based on cloud credentials.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on release versions.
'
in: query
name: release
schema:
description: 'Filters the result based on release versions.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
in: query
name: imageType
schema:
description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on compliance IDs.
'
items:
$ref: '#/components/schemas/int'
type: array
- description: 'Filters the result based on applied compliance rule name.
'
in: query
name: complianceRuleName
schema:
type: string
- description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.
Default is false.
'
in: query
name: normalizedSeverity
schema:
type: boolean
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_string'
description: ''
default:
description: ''
tags:
- Vms
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-vms-names
summary: Get VM Image Names
x-description-source: desc/vms/names_get.md
/api/v34.03/vms/scan:
post:
description: 'Start VM Image Scan. POST /api/v34.03/vms/scan on the Vms API. Documented responses: 200.'
responses:
'200':
description: OK
default:
description: ''
tags:
- Vms
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: post-vms-scan
summary: Start VM Image Scan
x-description-source: desc/vms/scan_post.md
/api/v34.03/vms/stop:
post:
description: 'Stop VM Image Scan. POST /api/v34.03/vms/stop on the Vms API. Documented responses: 200.'
responses:
'200':
description: OK
default:
description: ''
tags:
- Vms
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: post-vms-stop
summary: Stop VM Image Scan
x-description-source: desc/vms/stop_post.md
/api/v34.04/vms:
get:
description: 'Get VM Image Scan Results. GET /api/v34.04/vms on the Vms API. Takes 14 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Filters the result based on VM IDs.
'
in: query
name: id
schema:
description: 'Filters the result based on VM IDs.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on image names.
'
in: query
name: name
schema:
description: 'Filters the result based on image names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud credentials.
'
in: query
name: credential
schema:
description: 'Filters the result based on cloud credentials.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on release versions.
'
in: query
name: release
schema:
description: 'Filters the result based on release versions.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
in: query
name: imageType
schema:
description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on compliance IDs.
'
items:
$ref: '#/components/schemas/int'
type: array
- description: 'Filters the result based on applied compliance rule name.
'
in: query
name: complianceRuleName
schema:
type: string
- description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.
Default is false.
'
in: query
name: normalizedSeverity
schema:
type: boolean
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.ImageScanResult'
description: ''
default:
description: ''
tags:
- Vms
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-vms
summary: Get VM Image Scan Results
x-description-source: desc/vms/get.md
/api/v34.04/vms/download:
get:
description: 'Download VM Image Scan Results. GET /api/v34.04/vms/download on the Vms API. Takes 14 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Filters the result based on VM IDs.
'
in: query
name: id
schema:
description: 'Filters the result based on VM IDs.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on image names.
'
in: query
name: name
schema:
description: 'Filters the result based on image names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud credentials.
'
in: query
name: credential
schema:
description: 'Filters the result based on cloud credentials.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on release versions.
'
in: query
name: release
schema:
description: 'Filters the result based on release versions.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
in: query
name: imageType
schema:
description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on compliance IDs.
'
items:
$ref: '#/components/schemas/int'
type: array
- description: 'Filters the result based on applied compliance rule name.
'
in: query
name: complianceRuleName
schema:
type: string
- description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.
Default is false.
'
in: query
name: normalizedSeverity
schema:
type: boolean
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
description: OK
default:
description: ''
tags:
- Vms
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-vms-download
summary: Download VM Image Scan Results
x-description-source: desc/vms/download_get.md
/api/v34.04/vms/labels:
get:
description: 'Get VM Image Tags. GET /api/v34.04/vms/labels on the Vms API. Takes 14 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Filters the result based on VM IDs.
'
in: query
name: id
schema:
description: 'Filters the result based on VM IDs.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on image names.
'
in: query
name: name
schema:
description: 'Filters the result based on image names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud credentials.
'
in: query
name: credential
schema:
description: 'Filters the result based on cloud credentials.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on OS distribution names.
'
in: query
name: distro
schema:
description: 'Filters the result based on OS distribution names.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on release versions.
'
in: query
name: release
schema:
description: 'Filters the result based on release versions.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
in: query
name: imageType
schema:
description: 'Filters the result based on cloud image types. Example: Use marketplace, managed, or gallery for Microsoft Azure.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on compliance IDs.
'
in: query
name: complianceIDs
schema:
description: 'Filters the result based on compliance IDs.
'
items:
$ref: '#/components/schemas/int'
type: array
- description: 'Filters the result based on applied compliance rule name.
'
in: query
name: complianceRuleName
schema:
type: string
- description: 'Retrieves the result in the normalized form of low, medium, high, and critical based on vulnerability''s severity level.
Default is false.
'
in: query
name: normalizedSeverity
schema:
type: boolean
- description: 'Filters results by issue type.
'
in: query
name: issueType
schema:
description: IssueType is used to filter scan results by issue type
enum:
- - vulnerabilities
- compliance
- ''
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_string'
description: ''
default:
description: ''
tags:
- Vms
x-prisma-cloud-target-env:
permission: monitorHosts
operationId: get-vms-labels
summary: Get VM Image Tags
x-description-source: desc/vms/labels_get.md
/api/v34.04/vms/names:
get:
description: 'Get VM Image Names. GET /api/v34.04/vms/names on the Vms API. Takes 14 query parameters. Documented responses: 200.'
parameters:
- description: 'Offsets the result to a specific report count. Offset starts from 0.
'
in: query
name: offset
schema:
type: integer
- description: 'Limit is the amount to fix.
'
in: query
name: limit
schema:
type: integer
- description: 'Sorts the result using a key.
'
in: query
name: sort
schema:
type: string
- description: 'Sorts the result in reverse order.
'
in: query
name: reverse
schema:
type: boolean
- description: 'Filters the result based on VM IDs.
'
in: query
name: id
schema:
description: 'Filters the result based on VM IDs.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Filters the result based on image names.
'
in: query
name: name
schema:
description: 'Filters the result based on image names.
'
items:
$ref: '#/components/schemas/string'
type: arr
# --- truncated at 32 KB (147 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-vms-api-openapi.yml