Palo Alto Networks Profiles API
{'$ref': 'desc/profiles/profiles.md'}
{'$ref': 'desc/profiles/profiles.md'}
openapi: 3.2.0
info:
title: Palo Alto Networks Profiles API
version: '1.0'
description: 'Operations tagged Profiles across 5 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, palo-alto-scm-config-adnsr-adnsr-apis-openapi.yaml. Each path carries the servers of the definition it was published in.'
servers:
- url: PATH_TO_CONSOLE
- description: Prod
url: https://api.strata.paloaltonetworks.com
tags:
- name: Profiles
description: Profiles. 7 operations in this definition.
x-description-source: desc/profiles/profiles.md
paths:
/api/v34.03/profiles/app-embedded:
get:
description: 'Get App-embedded Profiles. GET /api/v34.03/profiles/app-embedded on the Profiles API. Takes 10 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: 'IDs is the runtime profile id filter.
'
in: query
name: id
schema:
description: 'IDs is the runtime profile id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'AppIDs is the app embedded profile app IDs filter.
'
in: query
name: appID
schema:
description: 'AppIDs is the app embedded profile app IDs filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Containers is the app embedded container filter.
'
in: query
name: container
schema:
description: 'Containers is the app embedded container filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Images is the app embedded images filter.
'
in: query
name: image
schema:
description: 'Images is the app embedded images filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Clusters is the app embedded clusters filter.
'
in: query
name: cluster
schema:
description: 'Clusters is the app embedded clusters filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageIDs is the app embedded image IDs filter.
'
in: query
name: imageID
schema:
description: 'ImageIDs is the app embedded image IDs filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.AppEmbeddedRuntimeProfile'
description: ''
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeServerless
operationId: get-profiles-app-embedded
summary: Get App-embedded Profiles
x-description-source: desc/profiles/app-embedded_get.md
/api/v34.03/profiles/app-embedded/download:
get:
description: 'Download App-embedded Profiles. GET /api/v34.03/profiles/app-embedded/download on the Profiles API. Takes 10 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: 'IDs is the runtime profile id filter.
'
in: query
name: id
schema:
description: 'IDs is the runtime profile id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'AppIDs is the app embedded profile app IDs filter.
'
in: query
name: appID
schema:
description: 'AppIDs is the app embedded profile app IDs filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Containers is the app embedded container filter.
'
in: query
name: container
schema:
description: 'Containers is the app embedded container filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Images is the app embedded images filter.
'
in: query
name: image
schema:
description: 'Images is the app embedded images filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Clusters is the app embedded clusters filter.
'
in: query
name: cluster
schema:
description: 'Clusters is the app embedded clusters filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageIDs is the app embedded image IDs filter.
'
in: query
name: imageID
schema:
description: 'ImageIDs is the app embedded image IDs filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
description: OK
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeServerless
operationId: get-profiles-app-embedded-download
summary: Download App-embedded Profiles
x-description-source: desc/profiles/app-embedded_download_get.md
/api/v34.03/profiles/container:
get:
description: 'Get Runtime Container Profiles. GET /api/v34.03/profiles/container on the Profiles API. Takes 12 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: 'IDs is the runtime profile id filter.
'
in: query
name: id
schema:
description: 'IDs is the runtime profile id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'OS is the service runtime profile OS filter.
'
in: query
name: os
schema:
description: 'OS is the service runtime profile OS filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'States is the runtime profile state filter.
'
in: query
name: state
schema:
description: 'States is the runtime profile state filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageIDs is the runtime profile image id filter.
'
in: query
name: imageID
schema:
description: 'ImageIDs is the runtime profile image id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Images is the runtime profile image filter.
'
in: query
name: image
schema:
description: 'Images is the runtime profile image filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Hosts is the runtime profile hostname filter.
'
in: query
name: hostName
schema:
description: 'Hosts is the runtime profile hostname filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Namespaces is the runtime profile k8s namespace filter.
'
in: query
name: namespace
schema:
description: 'Namespaces is the runtime profile k8s namespace filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Clusters is the runtime profile k8s cluster filter.
'
in: query
name: cluster
schema:
description: 'Clusters is the runtime profile k8s cluster filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.ContainerRuntimeProfile'
description: ''
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeContainers
operationId: get-profiles-container
summary: Get Runtime Container Profiles
x-description-source: desc/profiles/container_get.md
/api/v34.03/profiles/container/download:
get:
description: 'Download Runtime Container Profiles. GET /api/v34.03/profiles/container/download on the Profiles API. Takes 12 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: 'IDs is the runtime profile id filter.
'
in: query
name: id
schema:
description: 'IDs is the runtime profile id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'OS is the service runtime profile OS filter.
'
in: query
name: os
schema:
description: 'OS is the service runtime profile OS filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'States is the runtime profile state filter.
'
in: query
name: state
schema:
description: 'States is the runtime profile state filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageIDs is the runtime profile image id filter.
'
in: query
name: imageID
schema:
description: 'ImageIDs is the runtime profile image id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Images is the runtime profile image filter.
'
in: query
name: image
schema:
description: 'Images is the runtime profile image filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Hosts is the runtime profile hostname filter.
'
in: query
name: hostName
schema:
description: 'Hosts is the runtime profile hostname filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Namespaces is the runtime profile k8s namespace filter.
'
in: query
name: namespace
schema:
description: 'Namespaces is the runtime profile k8s namespace filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Clusters is the runtime profile k8s cluster filter.
'
in: query
name: cluster
schema:
description: 'Clusters is the runtime profile k8s cluster filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
description: OK
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeContainers
operationId: get-profiles-container-download
summary: Download Runtime Container Profiles
x-description-source: desc/profiles/container_download_get.md
/api/v34.03/profiles/container/learn:
post:
description: 'Learn Runtime Container Profiles. POST /api/v34.03/profiles/container/learn on the Profiles API. Documented responses: 200.'
responses:
'200':
description: OK
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeContainers
operationId: post-profiles-container-learn
summary: Learn Runtime Container Profiles
x-description-source: desc/profiles/container_learn_post.md
/api/v34.03/profiles/host:
get:
description: 'Get Runtime Host Profiles. GET /api/v34.03/profiles/host on the Profiles API. Takes 12 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: 'IDs is the runtime profile id filter.
'
in: query
name: id
schema:
description: 'IDs is the runtime profile id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'OS is the service runtime profile OS filter.
'
in: query
name: os
schema:
description: 'OS is the service runtime profile OS filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'States is the runtime profile state filter.
'
in: query
name: state
schema:
description: 'States is the runtime profile state filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageIDs is the runtime profile image id filter.
'
in: query
name: imageID
schema:
description: 'ImageIDs is the runtime profile image id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Images is the runtime profile image filter.
'
in: query
name: image
schema:
description: 'Images is the runtime profile image filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Hosts is the runtime profile hostname filter.
'
in: query
name: hostName
schema:
description: 'Hosts is the runtime profile hostname filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Namespaces is the runtime profile k8s namespace filter.
'
in: query
name: namespace
schema:
description: 'Namespaces is the runtime profile k8s namespace filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Clusters is the runtime profile k8s cluster filter.
'
in: query
name: cluster
schema:
description: 'Clusters is the runtime profile k8s cluster filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_runtime.HostProfile'
description: ''
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeHosts
operationId: get-profiles-host
summary: Get Runtime Host Profiles
x-description-source: desc/profiles/host_get.md
/api/v34.03/profiles/host/download:
get:
description: 'Download Runtime Host Profiles. GET /api/v34.03/profiles/host/download on the Profiles API. Takes 12 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: 'IDs is the runtime profile id filter.
'
in: query
name: id
schema:
description: 'IDs is the runtime profile id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'OS is the service runtime profile OS filter.
'
in: query
name: os
schema:
description: 'OS is the service runtime profile OS filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'States is the runtime profile state filter.
'
in: query
name: state
schema:
description: 'States is the runtime profile state filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageIDs is the runtime profile image id filter.
'
in: query
name: imageID
schema:
description: 'ImageIDs is the runtime profile image id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Images is the runtime profile image filter.
'
in: query
name: image
schema:
description: 'Images is the runtime profile image filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Hosts is the runtime profile hostname filter.
'
in: query
name: hostName
schema:
description: 'Hosts is the runtime profile hostname filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Namespaces is the runtime profile k8s namespace filter.
'
in: query
name: namespace
schema:
description: 'Namespaces is the runtime profile k8s namespace filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Clusters is the runtime profile k8s cluster filter.
'
in: query
name: cluster
schema:
description: 'Clusters is the runtime profile k8s cluster filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
description: OK
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeHosts
operationId: get-profiles-host-download
summary: Download Runtime Host Profiles
x-description-source: desc/profiles/host_download_get.md
/api/v34.04/profiles/app-embedded:
get:
description: 'Get App-embedded Profiles. GET /api/v34.04/profiles/app-embedded on the Profiles API. Takes 10 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: 'IDs is the runtime profile id filter.
'
in: query
name: id
schema:
description: 'IDs is the runtime profile id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'AppIDs is the app embedded profile app IDs filter.
'
in: query
name: appID
schema:
description: 'AppIDs is the app embedded profile app IDs filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Containers is the app embedded container filter.
'
in: query
name: container
schema:
description: 'Containers is the app embedded container filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Images is the app embedded images filter.
'
in: query
name: image
schema:
description: 'Images is the app embedded images filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Clusters is the app embedded clusters filter.
'
in: query
name: cluster
schema:
description: 'Clusters is the app embedded clusters filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageIDs is the app embedded image IDs filter.
'
in: query
name: imageID
schema:
description: 'ImageIDs is the app embedded image IDs filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.AppEmbeddedRuntimeProfile'
description: ''
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeServerless
operationId: get-profiles-app-embedded
summary: Get App-embedded Profiles
x-description-source: desc/profiles/app-embedded_get.md
/api/v34.04/profiles/app-embedded/download:
get:
description: 'Download App-embedded Profiles. GET /api/v34.04/profiles/app-embedded/download on the Profiles API. Takes 10 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: 'IDs is the runtime profile id filter.
'
in: query
name: id
schema:
description: 'IDs is the runtime profile id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'AppIDs is the app embedded profile app IDs filter.
'
in: query
name: appID
schema:
description: 'AppIDs is the app embedded profile app IDs filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Containers is the app embedded container filter.
'
in: query
name: container
schema:
description: 'Containers is the app embedded container filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Images is the app embedded images filter.
'
in: query
name: image
schema:
description: 'Images is the app embedded images filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Clusters is the app embedded clusters filter.
'
in: query
name: cluster
schema:
description: 'Clusters is the app embedded clusters filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageIDs is the app embedded image IDs filter.
'
in: query
name: imageID
schema:
description: 'ImageIDs is the app embedded image IDs filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
description: OK
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeServerless
operationId: get-profiles-app-embedded-download
summary: Download App-embedded Profiles
x-description-source: desc/profiles/app-embedded_download_get.md
/api/v34.04/profiles/container:
get:
description: 'Get Runtime Container Profiles. GET /api/v34.04/profiles/container on the Profiles API. Takes 12 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: 'IDs is the runtime profile id filter.
'
in: query
name: id
schema:
description: 'IDs is the runtime profile id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'OS is the service runtime profile OS filter.
'
in: query
name: os
schema:
description: 'OS is the service runtime profile OS filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'States is the runtime profile state filter.
'
in: query
name: state
schema:
description: 'States is the runtime profile state filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'ImageIDs is the runtime profile image id filter.
'
in: query
name: imageID
schema:
description: 'ImageIDs is the runtime profile image id filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Images is the runtime profile image filter.
'
in: query
name: image
schema:
description: 'Images is the runtime profile image filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Hosts is the runtime profile hostname filter.
'
in: query
name: hostName
schema:
description: 'Hosts is the runtime profile hostname filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Namespaces is the runtime profile k8s namespace filter.
'
in: query
name: namespace
schema:
description: 'Namespaces is the runtime profile k8s namespace filter.
'
items:
$ref: '#/components/schemas/string'
type: array
- description: 'Clusters is the runtime profile k8s cluster filter.
'
in: query
name: cluster
schema:
description: 'Clusters is the runtime profile k8s cluster filter.
'
items:
$ref: '#/components/schemas/string'
type: array
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/-_shared.ContainerRuntimeProfile'
description: ''
default:
description: ''
tags:
- Profiles
x-prisma-cloud-target-env:
permission: monitorRuntimeContainers
operationId: get-profiles-container
summary: Get Runtime Container Profiles
x-description-source: desc/profiles/container_get.md
/api/v34.04/profiles/container/download:
get:
description: 'Download Runtime Container Profiles.
# --- truncated at 32 KB (104 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-profiles-api-openapi.yml