@itentialopensource/adapter-paloalto_prismacloud
Version:
This adapter integrates with system described as: paloalto prismacloud.
7,576 lines • 213 kB
YAML
openapi: 3.0.0
info:
title: Prisma Cloud
contact: {}
version: '1.0'
servers:
- url: http://example.com
variables: {}
- url: https://api.prismacloud.io/alert
variables: {}
paths:
/login:
post:
tags:
- Login
summary: LoginGenerateToken
description: Returns a JWT auth token for accessing the Prisma Cloud APIs. To generate a token, you must have an access key and include the following values in the request body parameter — access key ID as the username and your secret key as the password. Prisma Cloud requires this JWT in the request header to authorize API access.
operationId: LoginGenerateToken
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LoginGenerateTokenRequest'
- example:
username: '{{ACCESS_KEY}}'
password: '{{SECRET_KEY}}'
example:
username: '{{ACCESS_KEY}}'
password: '{{SECRET_KEY}}'
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/auth_token/extend:
get:
tags:
- Login
summary: RefreshToken
description: Extend a user's session. The JWT token returned is valid until the next session timeout occurs. This method requires a valid session token to be passed (token from a prior successful extend or login calls).
operationId: RefreshToken
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
put:
tags:
- User Profile
summary: UpdateSSOBypassAllowedUsers
description: 'Update the list of which users are allowed to bypass SSO and sign in to Prisma Cloud directly. '
operationId: UpdateSSOBypassAllowedUsers
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/check:
get:
tags:
- System
summary: HealthCheck
description: >-
Check's the current Prisma Cloud API status. You should receive a "hello from the other side" message.
Note this does NOT need a jwt-token to perform.
operationId: HealthCheck
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/me:
get:
tags:
- User Profile
summary: Profile
description: Returns the information about the current authenticated user/access-key.
operationId: Profile
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
put:
tags:
- User Profile
summary: UpdateProfile
description: 'Updates the current authenticated user/access-key account information. '
operationId: UpdateProfile
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateProfileRequest'
- example:
email: email_to_update
firstName: first
lastName: last
timeZone: America/New_York
roleId: ROLE_ID_HERE
accessKeysAllowed: true
onlyAllowCIAccess: true
onlyAllowComputeAccess: true
example:
email: email_to_update
firstName: first
lastName: last
timeZone: America/New_York
roleId: ROLE_ID_HERE
accessKeysAllowed: true
onlyAllowCIAccess: true
onlyAllowComputeAccess: true
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user:
get:
tags:
- User Profile
summary: ListUsers
description: 'List all users in the current Prisma Cloud tenant. '
operationId: ListUsers
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/v2/user:
post:
tags:
- User Profile
summary: AddNewUserProfilev2
description: 'Creates a new users profile. You need to query a valid ROLE_ID before executing here with a List User Roles GET call. '
operationId: AddNewUserProfilev2
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddNewUserProfilev2Request'
- example:
roleIds:
- ROLE_IDs_HERE
email: NEW_USER_EMAIL
firstName: FIRST_NAME
lastName: LAST_NAME
timeZone: GMT
accessKeysAllowed: true
defaultRoleId: DEFAULT_ROLE_ID
example:
roleIds:
- ROLE_IDs_HERE
email: NEW_USER_EMAIL
firstName: FIRST_NAME
lastName: LAST_NAME
timeZone: GMT
accessKeysAllowed: true
defaultRoleId: DEFAULT_ROLE_ID
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/name:
get:
tags:
- User Profile
summary: ListUsernames
description: 'List all usernames in the current Prisma Cloud tenant. '
operationId: ListUsernames
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/role/type:
get:
tags:
- User Profile
summary: ListUserRoleType
description: 'List user roles for the current Prisma Cloud tenant. '
operationId: ListUserRoleType
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/{email-id}:
get:
tags:
- User Profile
summary: GetUsersProfile(otherthanyourown)
description: 'Returns the information about a specific user/accounts information. '
operationId: GetUsersProfile(otherthanyourown)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
- name: email-id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- User Profile
summary: UpdateUserProfile(otherthanyourown)
description: 'Updates the information of a specific user/account. '
operationId: UpdateUserProfile(otherthanyourown)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
- name: email-id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/USER_ID_HERE:
delete:
tags:
- User Profile
summary: DeleteUserProfile
description: Extend a user's session. The JWT token returned is valid until the next session timeout occurs. This method requires a valid session token to be passed (token from a prior successful extend or login calls).
operationId: DeleteUserProfile
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/{email-id}/status/TRUE_FALSE:
patch:
tags:
- User Profile
summary: UpdateUserStatus
description: 'Enables or disables a specific users login status. '
operationId: UpdateUserStatus
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
- name: email-id
in: path
description: ''
required: true
style: simple
schema:
type: string
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/domain:
get:
tags:
- User Profile
summary: ListEmailDomains
description: 'List all domains any user accounts have within the current Prisma Cloud tenant. '
operationId: ListEmailDomains
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/saml/bypass:
get:
tags:
- User Profile
summary: ListSSOBypassAllowedUsers
description: 'List current user accounts that are allowed to bypass SSO and sign in to Prisma Cloud directly. '
operationId: ListSSOBypassAllowedUsers
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/role:
get:
tags:
- User Roles
summary: ListUserRoles
description: 'Lists all accounts and associated Roles in the current Prisma Cloud tenant. '
operationId: ListUserRoles
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- User Roles
summary: AddUserRole
description: "Adds a new User Role, much be combined with Account Group ID from \"List Account Groups\" GET. \nAlso needs to match a corresponding \"Permission Group\" from within Prisma Cloud. "
operationId: AddUserRole
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddUserRoleRequest'
- example:
accountGroupIds:
- ACCOUNT_GROUP_ID
name: ROLE_NAME
description: Role Description
roleType: PERMISSION_GROUP_NAME
restrictDismissalAccess: false
additionalAttributes:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
example:
accountGroupIds:
- ACCOUNT_GROUP_ID
name: ROLE_NAME
description: Role Description
roleType: PERMISSION_GROUP_NAME
restrictDismissalAccess: false
additionalAttributes:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/role/name:
get:
tags:
- User Roles
summary: ListUserRoleNames
description: Returns list of user role IDs and names.
operationId: ListUserRoleNames
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/user/role/ROLE_ID_HERE:
get:
tags:
- User Roles
summary: UserRoleInfo
description: Retrieve all information about an user role using its ID.
operationId: UserRoleInfo
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
put:
tags:
- User Roles
summary: UpdateUserRole
description: 'Updates a specific user role based upon ID. '
operationId: UpdateUserRole
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateUserRoleRequest'
- example:
name: ROLE_NAME
description: Role Description
roleType: PERMISSION_GROUP_NAME
accountGroupIds:
- ACCOUNT_GROUP_ID
resourceListIds:
- RESOURCE_LIST_IDS
associatedUsers:
- ASSOCIATED_USERS
restrictDismissalAccess: false
additionalAttributes:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
hasDefenderPermissions: false
onlyAllowReadAccess: false
example:
name: ROLE_NAME
description: Role Description
roleType: PERMISSION_GROUP_NAME
accountGroupIds:
- ACCOUNT_GROUP_ID
resourceListIds:
- RESOURCE_LIST_IDS
associatedUsers:
- ASSOCIATED_USERS
restrictDismissalAccess: false
additionalAttributes:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
hasDefenderPermissions: false
onlyAllowReadAccess: false
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
delete:
tags:
- User Roles
summary: DeleteUserRole
description: Delete a specific user Role.
operationId: DeleteUserRole
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/access_keys:
get:
tags:
- Access Keys
summary: ListAccessKeys
description: 'Lists all access keys within the current Prisma Cloud tenant. '
operationId: ListAccessKeys
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- Access Keys
summary: ListAccessKeysCopy
description: 'Creates access key with the current users permissions, and sets expiry in milliseconds. '
operationId: ListAccessKeysCopy
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ListAccessKeysCopyRequest'
- example:
name: ACCESS_KEY_ID
expiresOn: 9999999999
example:
name: ACCESS_KEY_ID
expiresOn: 9999999999
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/access_keys/ACCESS_KEY_ID:
get:
tags:
- Access Keys
summary: GetAccessKeybyID
description: 'Lists a specific access key related to ID. '
operationId: GetAccessKeybyID
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
put:
tags:
- Access Keys
summary: UpdateAccessKey
description: 'Updates a specific access key within the current Prisma Cloud tenant. '
operationId: UpdateAccessKey
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateAccessKeyRequest'
- example:
name: ACCESS_KEY_NAME
expiresOn: 999999999
example:
name: ACCESS_KEY_NAME
expiresOn: 999999999
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
delete:
tags:
- Access Keys
summary: DeleteAccessKey
description: 'Deletes a specific access key in the current Prisma Cloud tenant. '
operationId: DeleteAccessKey
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/access_keys/ACCESS_KEY_ID/status/TRUE_OR_FALSE:
patch:
tags:
- Access Keys
summary: UpdateAccessKeyStatus
description: 'Updates a specific access key based on ID, and set to active = true/false. '
operationId: UpdateAccessKeyStatus
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud:
get:
tags:
- Cloud Accounts
summary: ListCloudAccounts
description: 'Lists all accounts groups and cloud accounts in the current Prisma Cloud tenant. '
operationId: ListCloudAccounts
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/name:
get:
tags:
- Cloud Accounts
summary: ListCloudAccountNames
description: 'Lists all Cloud Account names within the current Prisma Cloud tenant. '
operationId: ListCloudAccountNames
parameters:
- name: onlyActive
in: query
description: Can be true or false
required: true
style: form
explode: true
schema:
type: boolean
example: true
- name: accountGroupIds
in: query
description: ID of the account group
required: true
style: form
explode: true
schema:
type: string
example: ACCOUNT_GROUP_ID
- name: cloudType
in: query
description: aws, azure, gcp, or alibaba_cloud
required: true
style: form
explode: true
schema:
type: string
example: CLOUD_TYPE
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/CLOUD_TYPE/CLOUD_ACCOUNT_ID/project:
get:
tags:
- Cloud Accounts
summary: ListCloudOrgAccounts
description: List all cloud accounts onboarded as children of an Org account.
operationId: ListCloudOrgAccounts
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/type:
get:
tags:
- Cloud Accounts
summary: ListCloudTypes
description: 'List all current cloud types. '
operationId: ListCloudTypes
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/aws:
post:
tags:
- Cloud Accounts
summary: AddCloudAccount(AWS)
description: Adds a new AWS Cloud Account from the body parameters
operationId: AddCloudAccount(AWS)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddCloudAccountAWSRequest'
- example:
accountId: AWS_ACCOUNT_ID
enabled: true
externalId: AWS_EXTERNAL_ID
groupIds: []
name: FRIENDLY_NAME
roleArn: AWS_ROLE_ARN
example:
accountId: AWS_ACCOUNT_ID
enabled: true
externalId: AWS_EXTERNAL_ID
groupIds: []
name: FRIENDLY_NAME
roleArn: AWS_ROLE_ARN
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/azure:
post:
tags:
- Cloud Accounts
summary: AddCloudAccount(Azure)
description: Adds a new Azure Cloud Account from the body parameters
operationId: AddCloudAccount(Azure)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddCloudAccountAzureRequest'
- example:
cloudAccount:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId: APPLICATION_ID
key: APPLICATION_SECRET
monitorFlowLogs: true
tenantId: AZURE_AD_ID
servicePrincipalId: ENTERPRISE_APP_OBJECT_ID
example:
cloudAccount:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId: APPLICATION_ID
key: APPLICATION_SECRET
monitorFlowLogs: true
tenantId: AZURE_AD_ID
servicePrincipalId: ENTERPRISE_APP_OBJECT_ID
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/gcp:
post:
tags:
- Cloud Accounts
summary: AddCloudAccount(GCP)
description: >-
Adds a new GCP Cloud Account from the body parameters.
"Credentials" section is the entire JSON file from the service account key creation.
operationId: AddCloudAccount(GCP)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddCloudAccountGCPRequest'
- example:
cloudAccount:
accountId: GCP_PROJECT_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled: false
dataflowEnabledProject: ''
flowLogStorageBucket: ''
credentials:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
example:
cloudAccount:
accountId: GCP_PROJECT_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled: false
dataflowEnabledProject: ''
flowLogStorageBucket: ''
credentials:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/alibaba_cloud:
post:
tags:
- Cloud Accounts
summary: AddCloudAccount(AliCloud)
description: Adds a new Alibaba Cloud Account from the body parameters
operationId: AddCloudAccount(AliCloud)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddCloudAccountAliCloudRequest'
- example:
accountId: ALIBABA_ACCOUNT_ID
groupIds: []
name: FRIENDLY_NAME
ramArn: ALIBABA_RAM_RESOURCE
example:
accountId: ALIBABA_ACCOUNT_ID
groupIds: []
name: FRIENDLY_NAME
ramArn: ALIBABA_RAM_RESOURCE
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/CLOUD_TYPE/CLOUD_ID:
get:
tags:
- Cloud Accounts
summary: CloudAccountInfo
description: 'Get information about a specific cloud account. '
operationId: CloudAccountInfo
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
put:
tags:
- Cloud Accounts
summary: UpdateCloudAccount(AWS)
description: Updates an existing AWS Cloud Account from the body parameters
operationId: UpdateCloudAccount(AWS)
parameters:
- name: skipStatusChecks
in: query
description: ''
required: true
style: form
explode: true
schema:
type: boolean
example: true
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateCloudAccountAWSRequest'
- example:
name: CLOUD_ACCOUNT_NAME
cloudType: aws
accountType: account
enabled: true
lastModifiedTs: 1607368494285
lastModifiedBy: email
storageScanEnabled: true
storageUUID: GUID
protectionMode: MONITOR_AND_PROTECT
ingestionMode: 7
groupIds:
- 207697d0-b35c-41dc-ae37-b5aab4a45ccc
externalId: b09b59d4-26b4-44aa-8aa9-b57d0adda748
roleArn: arn:aws:iam::CLOUD_ACCOUNT_ID:role/PrismaCloudReadWriteRoleWithDLP
canonicalId: dd02d7e04eeb0b8e70f08756cffd062a34d7defcca7c121373df79d9006f51ea
storageScanConfig:
scanOption: Custom
buckets:
backward:
- ''
forward:
- ''
snsTopicArn: arn:aws:sns:us-east-1:CLOUD_ACCOUNT_ID:PrismaCloudSNS
cloudAccountStatus:
accountId: CLOUD_ACCOUNT_ID
lastUpdated: 1607389350494
lastFullSnapshot: 1607119740164
ingestionEndTime: 0
cloudType: aws
assumeRoleAccount: REDLOCK
accountId: CLOUD_ACCOUNT_ID
addedOn: 1607119031817
example:
name: CLOUD_ACCOUNT_NAME
cloudType: aws
accountType: account
enabled: true
lastModifiedTs: 1607368494285
lastModifiedBy: email
storageScanEnabled: true
storageUUID: GUID
protectionMode: MONITOR_AND_PROTECT
ingestionMode: 7
groupIds:
- 207697d0-b35c-41dc-ae37-b5aab4a45ccc
externalId: b09b59d4-26b4-44aa-8aa9-b57d0adda748
roleArn: arn:aws:iam::CLOUD_ACCOUNT_ID:role/PrismaCloudReadWriteRoleWithDLP
canonicalId: dd02d7e04eeb0b8e70f08756cffd062a34d7defcca7c121373df79d9006f51ea
storageScanConfig:
scanOption: Custom
buckets:
backward:
- ''
forward:
- ''
snsTopicArn: arn:aws:sns:us-east-1:CLOUD_ACCOUNT_ID:PrismaCloudSNS
cloudAccountStatus:
accountId: CLOUD_ACCOUNT_ID
lastUpdated: 1607389350494
lastFullSnapshot: 1607119740164
ingestionEndTime: 0
cloudType: aws
assumeRoleAccount: REDLOCK
accountId: CLOUD_ACCOUNT_ID
addedOn: 1607119031817
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/azure/CLOUD_ACCOUNT_ID:
post:
tags:
- Cloud Accounts
summary: AddCloudAccount(Azure)1
description: Updates and existing Azure Cloud Account from the body parameters
operationId: AddCloudAccount(Azure)1
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddCloudAccountAzureRequest'
- example:
cloudAccount:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId: APPLICATION_ID
key: APPLICATION_SECRET
monitorFlowLogs: true
tenantId: AZURE_AD_ID
servicePrincipalId: ENTERPRISE_APP_OBJECT_ID
example:
cloudAccount:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId: APPLICATION_ID
key: APPLICATION_SECRET
monitorFlowLogs: true
tenantId: AZURE_AD_ID
servicePrincipalId: ENTERPRISE_APP_OBJECT_ID
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/gcp/CLOUD_ACCOUNT_ID:
put:
tags:
- Cloud Accounts
summary: AddCloudAccount(GCP)1
description: >-
Updates and existing GCP Cloud Account from the body parameters.
"Credentials" section is the entire JSON file from the service account key creation.
operationId: AddCloudAccount(GCP)1
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddCloudAccountGCPRequest'
- example:
cloudAccount:
accountId: GCP_PROJECT_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled: false
dataflowEnabledProject: ''
flowLogStorageBucket: ''
credentials:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
example:
cloudAccount:
accountId: GCP_PROJECT_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled: false
dataflowEnabledProject: ''
flowLogStorageBucket: ''
credentials:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
delete:
tags:
- Cloud Accounts
summary: CAUTION-DELETECloudAccount
description: "Deletes a specific cloud account from the Prisma Cloud tenant. \nThe account and associated data will be deleted in 24 hours. If you accidentally deleted the account, you can add it back within 24 hours and have all the associated data restored.\n\n** The \"x-redlock-auth\" has been disabled for this specific call, re-enable at your own risk**"
operationId: CAUTION-DELETECloudAccount
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: CAUTION, DISABLED AS TO NOT ACCIDENTALLY REMOVE CLOUD ACCOUNTS
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/alibaba_cloud/CLOUD_ACCOUNT_ID:
post:
tags:
- Cloud Accounts
summary: AddCloudAccount(AliCloud)1
description: Updates and existing Alibaba Cloud Account from the body parameters
operationId: AddCloudAccount(AliCloud)1
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AddCloudAccountAliCloudRequest'
- example:
accountId: ALIBABA_ACCOUNT_ID
groupIds: []
name: FRIENDLY_NAME
ramArn: ALIBABA_RAM_RESOURCE
example:
accountId: ALIBABA_ACCOUNT_ID
groupIds: []
name: FRIENDLY_NAME
ramArn: ALIBABA_RAM_RESOURCE
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/CLOUD_TYPE/CLOUD_ID:
patch:
tags:
- Cloud Accounts
summary: PatchCloudAccount
description: 'Enable or disable a cloud account (and children) or update Account Groups. '
operationId: PatchCloudAccount
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/PatchCloudAccountRequest'
- example:
groupIds:
- ACCOUNT_GROUP_IDS
enabled: true
updateChildrenStatus: true
example:
groupIds:
- ACCOUNT_GROUP_IDS
enabled: true
updateChildrenStatus: true
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/status/aws:
post:
tags:
- Cloud Accounts
summary: GetCloudAccountStatus(AWS)
description: Gets the current status of an onboarded AWS account
operationId: GetCloudAccountStatus(AWS)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GetCloudAccountStatusAWSRequest'
- example:
accountId: AWS_ACCOUNT_ID
enabled: true
externalId: AWS_EXTERNAL_ID
groupIds: []
name: FRIENDLY_NAME
roleArn: AWS_ROLE_ARN
example:
accountId: AWS_ACCOUNT_ID
enabled: true
externalId: AWS_EXTERNAL_ID
groupIds: []
name: FRIENDLY_NAME
roleArn: AWS_ROLE_ARN
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/status/azure:
post:
tags:
- Cloud Accounts
summary: GetCloudAccountStatus(Azure)
description: Gets the current status of an onboarded Azure account
operationId: GetCloudAccountStatus(Azure)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GetCloudAccountStatusAzureRequest'
- example:
cloudAccount:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId: APPLICATION_ID
key: APPLICATION_SECRET
monitorFlowLogs: true
tenantId: AZURE_AD_ID
servicePrincipalId: ENTERPRISE_APP_OBJECT_ID
example:
cloudAccount:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId: APPLICATION_ID
key: APPLICATION_SECRET
monitorFlowLogs: true
tenantId: AZURE_AD_ID
servicePrincipalId: ENTERPRISE_APP_OBJECT_ID
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/status/gcp:
post:
tags:
- Cloud Accounts
summary: GetCloudAccountStatus(GCP)
description: Gets the current status of an onboarded GCP account
operationId: GetCloudAccountStatus(GCP)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GetCloudAccountStatusGCPRequest'
- example:
cloudAccount:
accountId: GCP_PROJECT_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled: false
dataflowEnabledProject: ''
flowLogStorageBucket: ''
credentials:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
example:
cloudAccount:
accountId: GCP_PROJECT_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled: false
dataflowEnabledProject: ''
flowLogStorageBucket: ''
credentials:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/status/alibaba_cloud:
post:
tags:
- Cloud Accounts
summary: GetCloudAccountStatus(AliCloud)
description: Gets the current status of an onboarded Alibaba Cloud account
operationId: GetCloudAccountStatus(AliCloud)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/GetCloudAccountStatusAliCloudRequest'
- example:
accountId: ALIBABA_ACCOUNT_ID
groupIds: []
name: FRIENDLY_NAME
ramArn: ALIBABA_RAM_RESOURCE
example:
accountId: ALIBABA_ACCOUNT_ID
groupIds: []
name: FRIENDLY_NAME
ramArn: ALIBABA_RAM_RESOURCE
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/ACCOUNT_ID/status/TRUE_FALSE:
patch:
tags:
- Cloud Accounts
summary: UpdateCloudAccountStatus
description: 'Enable or disable a cloud account (and children) or update Account Groups. '
operationId: UpdateCloudAccountStatus
parameters:
- name: updateChildren
in: query
description: ''
required: true
style: form
explode: true
schema:
type: boolean
example: true
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateCloudAccountStatusRequest'
- example:
groupIds:
- ACCOUNT_GROUP_IDS
enabled: true
updateChildrenStatus: true
example:
groupIds:
- ACCOUNT_GROUP_IDS
enabled: true
updateChildrenStatus: true
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/group:
get:
tags:
- Account Groups
summary: ListAccountGroups
description: 'Lists all accounts groups and cloud accounts in the current Prisma Cloud tenant. '
operationId: ListAccountGroups
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- Account Groups
summary: AccountAccountGroup
description: 'Adds an Account group with corresponding Cloud Accounts from the body. '
operationId: AccountAccountGroup
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/AccountAccountGroupRequest'
- example:
accountIds:
- CLOUD_ACCOUNT_ID_1
- CLOUD_ACCOUNT_ID_2
name: ACCOUNT_GROUP_NAME
description: ACCOUNT_GROUP_DESCRIPTION
example:
accountIds:
- CLOUD_ACCOUNT_ID_1
- CLOUD_ACCOUNT_ID_2
name: ACCOUNT_GROUP_NAME
description: ACCOUNT_GROUP_DESCRIPTION
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/group/name:
get:
tags:
- Account Groups
summary: ListAccountGroupNames
description: 'Lists all accounts groups and their names within the current Prisma Cloud tenant. '
operationId: ListAccountGroupNames
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/group/name/CLOUD_TYPE:
get:
tags:
- Account Groups
summary: ListAccountGroupNamesbyCloudType
description: 'Lists all accounts groups by cloud type and their names within the current Prisma Cloud tenant. '
operationId: ListAccountGroupNamesbyCloudType
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/cloud/group/ACCOUNT_GROUP_ID:
get:
tags:
- Account Groups
summary: AccountGroupInfo
description: 'Gets a specific account groups information based on ID. '
operationId: AccountGroupInfo
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
put:
tags:
- Account Groups
summary: UpdateAccountGroup
description: 'Updates a specific Account group based on ID and Cloud Accounts in the body. '
operationId: UpdateAccountGroup
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateAccountGroupRequest'
- example:
accountIds:
- CLOUD_ACCOUNT_ID_1
- CLOUD_ACCOUNT_ID_2
name: ACCOUNT_GROUP_NAME
description: DESCRIPTION
example:
accountIds:
- CLOUD_ACCOUNT_ID_1
- CLOUD_ACCOUNT_ID_2
name: ACCOUNT_GROUP_NAME
description: DESCRIPTION
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
delete:
tags:
- Account Groups
summary: DeleteAccountGroup
description: 'Deletes a specific account group based on ID. '
operationId: DeleteAccountGroup
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/filter/policy/suggest:
get:
tags:
- Policy
summary: ListPolicyFilters
description: Returns an object whose keys are the supported policy filters and corresponding values are the default or recent options for that filter.
operationId: ListPolicyFilters
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- Policy
summary: ListPolicyFilterAutocompleteSuggestions
description: Returns available options for a policy filter key. Also supports fuzzy autocomplete search for easier filtering.
operationId: ListPolicyFilterAutocompleteSuggestions
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ListPolicyFilterAutocompleteSuggestionsRequest'
- example:
query: AUTO_COMPLETE_FILTER
filterName: FILTER_NAME
example:
query: AUTO_COMPLETE_FILTER
filterName: FILTER_NAME
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/policy:
get:
tags:
- Policy
summary: ListPolicies
description: Returns all available policies, both system default and custom. You can apply filters to narrow the returned policy list to a subset of policies or potentially to a specific policy. Response includes open alert counts, which can affect performance.
operationId: ListPolicies
parameters:
- name: policy.name
in: query
description: Policy name
required: true
style: form
explode: true
schema:
type: string
example: POLICY_NAME
- name: policy.severity
in: query
description: Policy severity
required: true
style: form
explode: true
schema:
type: string
example: high
- name: policy.label
in: query
description: Policy label
required: true
style: form
explode: true
schema:
type: string
example: POLICY_LABEL
- name: policy.type
in: query
description: config, network, or audit_event
required: true
style: form
explode: true
schema:
type: string
example: config
- name: policy.complianceStandard
in: query
description: Compliance Standard name
required: true
style: form
explode: true
schema:
type: string
example: C_STANDARD
- name: policy.complianceRequirement
in: query
description: Compliance requirement name
required: true
style: form
explode: true
schema:
type: string
example: C_REQUIREMENT
- name: policy.complianceSection
in: query
description: Compliance section name
required: true
style: form
explode: true
schema:
type: string
example: C_SECTION
- name: policy.enabled
in: query
description: true or false
required: true
style: form
explode: true
schema:
type: boolean
example: true
- name: policy.policyMode
in: query
description: custom or redlock_default
required: true
style: form
explode: true
schema:
type: string
example: custom
- name: policy.remediable
in: query
description: true or false
required: true
style: form
explode: true
schema:
type: boolean
example: true
- name: cloud.type
in: query
description: aws, azure, gcp, or alibaba_cloud
required: true
style: form
explode: true
schema:
type: string
example: aws
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- Policy
summary: (incomplete)COMPLEX-AddPolicy
description: "**Very complex**\n\nAdds a new policy. "
operationId: (incomplete)COMPLEX-AddPolicy
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/incompleteCOMPLEX-AddPolicyRequest'
- example:
rule:
parameters:
savedSearch: 'true'
name: RULE_NAME
criteria: SEARCH_ID
type: Config
complianceMetadata:
- standardName: standardName
standardDescription: standardDescription
requirementId: requirementId
requirementName: requirementName
requirementDescription: requirementDescription
sectionId: sectionId
sectionDescription: sectionDescription
policyId: policyId
complianceId: complianceId
sectionLabel: sectionLabel
customAssigned: true
remediation:
templateType: StaticTemplate
description: AUTO_REMEDIATION_DESCRIPTION
cliScriptTemplate: CLI_TEMPLATE
labels:
- POLICY_LABEL
name: POLICY_NAME
policyType: config
description: POLICY_DESCRIPTION
severity: medium
recommendation: RECOMMENDATION_ACTION
cloudType: aws
enabled: true
example:
rule:
parameters:
savedSearch: 'true'
name: RULE_NAME
criteria: SEARCH_ID
type: Config
complianceMetadata:
- standardName: standardName
standardDescription: standardDescription
requirementId: requirementId
requirementName: requirementName
requirementDescription: requirementDescription
sectionId: sectionId
sectionDescription: sectionDescription
policyId: policyId
complianceId: complianceId
sectionLabel: sectionLabel
customAssigned: true
remediation:
templateType: StaticTemplate
description: AUTO_REMEDIATION_DESCRIPTION
cliScriptTemplate: CLI_TEMPLATE
labels:
- POLICY_LABEL
name: POLICY_NAME
policyType: config
description: POLICY_DESCRIPTION
severity: medium
recommendation: RECOMMENDATION_ACTION
cloudType: aws
enabled: true
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
put:
tags:
- Policy
summary: (incomplete)COMPLEX-UpdatePolicy
description: "**Very complex**\n\nUpdates an existing policy. "
operationId: (incomplete)COMPLEX-UpdatePolicy
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/incompleteCOMPLEX-UpdatePolicyRequest'
- example:
rule:
parameters:
savedSearch: 'true'
name: RULE_NAME
criteria: SEARCH_ID
type: Config
complianceMetadata:
- standardName: standardName
standardDescription: standardDescription
requirementId: requirementId
requirementName: requirementName
requirementDescription: requirementDescription
sectionId: sectionId
sectionDescription: sectionDescription
policyId: policyId
complianceId: complianceId
sectionLabel: sectionLabel
customAssigned: true
remediation:
templateType: StaticTemplate
description: AUTO_REMEDIATION_DESCRIPTION
cliScriptTemplate: CLI_TEMPLATE
labels:
- POLICY_LABEL
name: POLICY_NAME
policyType: config
description: POLICY_DESCRIPTION
severity: medium
recommendation: RECOMMENDATION_ACTION
cloudType: aws
enabled: true
example:
rule:
parameters:
savedSearch: 'true'
name: RULE_NAME
criteria: SEARCH_ID
type: Config
complianceMetadata:
- standardName: standardName
standardDescription: standardDescription
requirementId: requirementId
requirementName: requirementName
requirementDescription: requirementDescription
sectionId: sectionId
sectionDescription: sectionDescription
policyId: policyId
complianceId: complianceId
sectionLabel: sectionLabel
customAssigned: true
remediation:
templateType: StaticTemplate
description: AUTO_REMEDIATION_DESCRIPTION
cliScriptTemplate: CLI_TEMPLATE
labels:
- POLICY_LABEL
name: POLICY_NAME
policyType: config
description: POLICY_DESCRIPTION
severity: medium
recommendation: RECOMMENDATION_ACTION
cloudType: aws
enabled: true
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/v2/policy:
get:
tags:
- Policy
summary: ListPoliciesV2
description: Returns all available policies, both system default and custom. You can apply filters to narrow the returned policy list to a subset of policies or potentially to a specific policy. Response includes open alert counts, which can affect performance.
operationId: ListPoliciesV2
parameters:
- name: policy.severity
in: query
description: Policy severity
required: true
style: form
explode: true
schema:
type: string
example: high
- name: policy.type
in: query
description: config, network, or audit_event
required: true
style: form
explode: true
schema:
type: string
example: config
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/policy/POLICY_ID:
get:
tags:
- Policy
summary: PolicyInfo
description: Get specific policy info based on ID.
operationId: PolicyInfo
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
delete:
tags:
- Policy
summary: DeletePolicy
description: Delete specific policy info based on ID.
operationId: DeletePolicy
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/policy/POLICY_ID/status/TRUE_FALSE:
patch:
tags:
- Policy
summary: UpdatePolicyStatus
description: 'Updates a specific policy status based on ID. '
operationId: UpdatePolicyStatus
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/policy/compliance:
get:
tags:
- Policy
summary: ListPolicyComplianceStandards
description: Returns a list of compliance standards that Prisma Cloud supports and for each compliance standard, lists the supported sections.
operationId: ListPolicyComplianceStandards
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/:
get:
tags:
- Time Range Model (Info Only)
summary: AbsoluteTime
description: "// Used when both start and end unix timestamps (in ms) are available\n// E.g. from 1504448933000 to 1504794533000\n\n// Inside request body (POST / PUT) \n{\n \"timeRange\": {\n \"type\": \"absolute\",\n \"value\": {\n \"startTime\": 1504448933000,\n \"endTime\": 1504794533000\n }\n }\n}\n\n// Inside query params (GET)\n&timeType=absolute&startTime=1504448933000&endTime=1504794533000"
operationId: AbsoluteTime
parameters: []
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/filter/alert/suggest:
get:
tags:
- Alerts (incomplete)
summary: ListAlertFilters
description: Returns an object whose keys are the available policy filters. The corresponding values are default or recently set filter options
operationId: ListAlertFilters
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
security: []
/alert/policy:
post:
tags:
- Alerts (incomplete)
summary: ListAlertFiltersCopy
description: Returns an object whose keys are the available policy filters. The corresponding values are default or recently set filter options
operationId: ListAlertFiltersCopy
parameters:
- name: detailed
in: query
description: ''
required: true
style: form
explode: true
schema:
type: boolean
example: false
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ListAlertFiltersCopyRequest'
- example:
timeRange:
value:
unit: hour
amount: 1
type: relative
filters:
- name: alert.status
value: open
operator: =
fields:
- policy.name
- alertCount
sortBy:
- :asc
limit: 2
example:
timeRange:
value:
unit: hour
amount: 1
type: relative
filters:
- name: alert.status
value: open
operator: =
fields:
- policy.name
- alertCount
sortBy:
- :asc
limit: 2
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
security: []
/v2/alert:
get:
tags:
- Alerts (incomplete)
summary: ListAlertsV2
description: >+
Returns a paginated list of alerts from the Prisma Cloud platform.
operationId: ListAlertsV2
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 7
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: detailed
in: query
description: ''
required: true
style: form
explode: true
schema:
type: boolean
example: false
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
security: []
/alert/P-117144:
get:
tags:
- Alerts (incomplete)
summary: AlertInfo
description: Returns information about an alert for the specified ID.
operationId: AlertInfo
parameters:
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
security: []
/remediation:
post:
tags:
- Alerts (incomplete)
summary: ListAlertRemediationCommands
description: Generates and returns a list of remediation commands for the specified alerts and policies. Data returned for a successful call include fully constructed commands for remediation.
operationId: ListAlertRemediationCommands
parameters:
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ListAlertRemediationCommandsRequest'
- example:
alerts:
- P-153248
filter:
timeRange:
type: to_now
value: epoch
example:
alerts:
- P-153248
filter:
timeRange:
type: to_now
value: epoch
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
security: []
/filter/v2/inventory/suggest:
get:
tags:
- Asset Inventory
summary: ListInventoryFiltersV2
description: Returns an object whose keys are supported asset inventory filters and values contain default recent options.
operationId: ListInventoryFiltersV2
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- Asset Inventory
summary: ListInventoryDashboardFilterAutocompleteSuggestionsV2
description: Returns filter autocomplete suggestions.
operationId: ListInventoryDashboardFilterAutocompleteSuggestionsV2
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/ListInventoryDashboardFilterAutocompleteSuggestionsV2Request'
- example:
query: QUERY
filterName: FILTER
example:
query: QUERY
filterName: FILTER
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/filter/inventory:
get:
tags:
- Asset Inventory
summary: ListSavedAssetInventoryFilters
description: Returns a list of all the saved asset inventory filters.
operationId: ListSavedAssetInventoryFilters
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/filter/inventory/SAVED_INVENTORY_NAME:
get:
tags:
- Asset Inventory
summary: ListSavedAssetInventoryFiltersCopy
description: Returns a list of all the saved asset inventory filters.
operationId: ListSavedAssetInventoryFiltersCopy
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/v2/inventory:
get:
tags:
- Asset Inventory
summary: AssetInventoryViewV2
description: Returns asset inventory pass/fail data for the specified time period.
operationId: AssetInventoryViewV2
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/v2/inventory/trend:
get:
tags:
- Asset Inventory
summary: AssetInventoryTrendViewV2
description: Returns asset inventory pass/fail trends for the specified time period.
operationId: AssetInventoryTrendViewV2
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/posture:
get:
tags:
- Compliance Posture
summary: GetComplianceStatisticsBreakdown
description: Returns a breakdown of the passed/failed statistics and associated policies for compliance standards, requirements, and sections. Also returns a summary for all compliance standards.
operationId: GetComplianceStatisticsBreakdown
parameters:
- name: to_now
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
- name: cloud.account
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: CLOUD_ACCOUNT_NAME
- name: cloud.type
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: aws
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/posture/fd9e3d3a-29a0-4ddc-b058-6f7eabd7d85a:
get:
tags:
- Compliance Posture
summary: GetComplianceStatisticsforComplianceStandardID
description: Returns a breakdown of the passed/failed statistics and associated policies for compliance standards, requirements, and sections for the given compliance standard ID.
operationId: GetComplianceStatisticsforComplianceStandardID
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/posture/fd9e3d3a-29a0-4ddc-b058-6f7eabd7d85a/a467eb11-b55b-4484-83ba-f55a7ef4358b:
get:
tags:
- Compliance Posture
summary: GetComplianceStatisticsforRequirementID
description: Returns a breakdown of the passed/failed statistics and associated policies for compliance sections for the specified compliance standard ID and compliance requirement ID.
operationId: GetComplianceStatisticsforRequirementID
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/posture/trend:
get:
tags:
- Compliance Posture
summary: GetComplianceStatisticsOverTime
description: Returns a compliance posture summary that describes the passed/failed statistics trend.
operationId: GetComplianceStatisticsOverTime
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/posture/trend/fd9e3d3a-29a0-4ddc-b058-6f7eabd7d85a:
get:
tags:
- Compliance Posture
summary: GetComplianceStatisticsOverTimeforComplianceStandardID
description: Returns a compliance posture summary that describes the passed/failed statistics trend for the specified compliance standard ID.
operationId: GetComplianceStatisticsOverTimeforComplianceStandardID
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/posture/trend/fd9e3d3a-29a0-4ddc-b058-6f7eabd7d85a/a467eb11-b55b-4484-83ba-f55a7ef4358b:
get:
tags:
- Compliance Posture
summary: GetComplianceStatisticsOverTimeforRequirementID
description: Returns the compliance posture summary that describes the passed/failed statistics trend for the given compliance standard ID and compliance requirement ID.
operationId: GetComplianceStatisticsOverTimeforRequirementID
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/filter/compliance/posture/suggest:
get:
tags:
- Compliance Posture
summary: GetComplianceOverviewFiltersandOptions
description: Returns an object whose key/value pairs identify filter options for compliance posture data. The keys are supported filters, and the corresponding values identify the available and saved filter options.
operationId: GetComplianceOverviewFiltersandOptions
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/dashboard:
get:
tags:
- Compliance Dashboard
summary: ComplianceResourceStatisticsBreakdown
description: Used to get a full breakdown of pass / failed statistics and associated policies for compliance standards, requirements, or sections (Deprecated).
operationId: ComplianceResourceStatisticsBreakdown
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/dashboard/history:
get:
tags:
- Compliance Dashboard
summary: OverallComplianceResourceStatisticsOverTime
description: 'Used to get the overall compliance centric resource count and pass / fail statistics over a given period of time '
operationId: OverallComplianceResourceStatisticsOverTime
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/filter/compliance/suggest:
get:
tags:
- Compliance Dashboard
summary: GetComplianceDashboardFilters
description: Returns an object with key/value pairs that identify filter options for Compliance Dashboard data. The keys are supported filters, and the corresponding values identify the available and saved filter options
operationId: GetComplianceDashboardFilters
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- Compliance Dashboard
summary: GetComplianceDashboardFiltersCopy
description: Returns an object with key/value pairs that identify filter options for Compliance Dashboard data. The keys are supported filters, and the corresponding values identify the available and saved filter options
operationId: GetComplianceDashboardFiltersCopy
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance:
get:
tags:
- Compliance Standards
summary: ListComplianceStandards
description: Returns all system supported and custom compliance standards
operationId: ListComplianceStandards
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/COMPLIANCE_ID_HERE:
get:
tags:
- Compliance Standards
summary: ListComplianceStandardsbyID
description: Returns a specific compliance standards based on ID
operationId: ListComplianceStandardsbyID
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/COMPLIANCE_ID_HERE/requirement:
get:
tags:
- Compliance Standards
summary: ListComplianceRequirementsbyID
description: Returns a list of all compliance requirements for the specified compliance standard ID.
operationId: ListComplianceRequirementsbyID
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/requirement/REQUIREMENT_ID_HERE:
get:
tags:
- Compliance Standards
summary: GetComplianceRequirementbyID
description: Returns compliance requirement data for the specified requirements ID.
operationId: GetComplianceRequirementbyID
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/compliance/REQUIREMENT_ID_HERE/section:
get:
tags:
- Compliance Standards
summary: ListComplianceRequirementSections
description: Returns a list of all compliance requirement sections for the specified compliance requirement ID.
operationId: ListComplianceRequirementSections
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/audit/redlock:
get:
tags:
- Audit Logs
summary: PrismaCloudAuditLogs
description: Allows a user to retrieve audit logs for events that took place on the Prisma Cloud platform.
operationId: PrismaCloudAuditLogs
parameters:
- name: timeType
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: relative
- name: timeAmount
in: query
description: ''
required: true
style: form
explode: true
schema:
type: integer
format: int32
example: 40
- name: timeUnit
in: query
description: ''
required: true
style: form
explode: true
schema:
type: string
example: hour
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/usage/compute/twistlock:
post:
tags:
- Licensing
summary: LicensingUsageCountforCompute
description: 'Gets the current Compute licensing usage until now. '
operationId: LicensingUsageCountforCompute
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/LicensingUsageCountforComputeRequest'
- example:
aggregate: true
timeRange:
type: to_now
value: epoch
example:
aggregate: true
timeRange:
type: to_now
value: epoch
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/search/config:
post:
tags:
- Search
summary: https://api.prismacloud.io/search/config
description: ''
operationId: https://api.prismacloud.io/search/config
parameters:
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; text/csv; charset=UTF-8
requestBody:
description: ''
content:
text/csv:
schema:
allOf:
- $ref: '#/components/schemas/httpsapi.prismacloud.iosearchconfigrequest'
- example:
query: "config where api.name = 'azure-network-nic-list' "
timeRange:
type: relative
value:
unit: hour
amount: 24
example:
query: "config where api.name = 'azure-network-nic-list' "
timeRange:
type: relative
value:
unit: hour
amount: 24
required: true
responses:
'415':
description: Unsupported Media Type
headers:
Date:
content:
text/plain:
schema:
type: string
example: Mon, 05 Oct 2020 18:26:03 GMT
example: Mon, 05 Oct 2020 18:26:03 GMT
Content-Length:
content:
text/plain:
schema:
type: string
example: '0'
example: '0'
Connection:
content:
text/plain:
schema:
type: string
example: keep-alive
example: keep-alive
Access-Control-Allow-Origin:
content:
text/plain:
schema:
type: string
example: '*'
example: '*'
Access-Control-Allow-Headers:
content:
text/plain:
schema:
type: string
example: x-redlock-request-id,x-redlock-auth,rl-json-rule,terraform-version,terraform-012-parameters,rl-variable-file-names,rl-parameters,Content-Type
example: x-redlock-request-id,x-redlock-auth,rl-json-rule,terraform-version,terraform-012-parameters,rl-variable-file-names,rl-parameters,Content-Type
Access-Control-Allow-Methods:
content:
text/plain:
schema:
type: string
example: POST, PUT, GET, OPTIONS, DELETE, PATCH
example: POST, PUT, GET, OPTIONS, DELETE, PATCH
Access-Control-Expose-Headers:
content:
text/plain:
schema:
type: string
example: x-redlock-auth,x-redlock-request-id,x-redlock-status, x-redlock-fileName
example: x-redlock-auth,x-redlock-request-id,x-redlock-status, x-redlock-fileName
Access-Control-Max-Age:
content:
text/plain:
schema:
type: string
example: '60'
example: '60'
Strict-Transport-Security:
content:
text/plain:
schema:
type: string
example: max-age=31536000; includeSubDomains
example: max-age=31536000; includeSubDomains
X-Content-Type-Options:
content:
text/plain:
schema:
type: string
example: nosniff
example: nosniff
X-Frame-Options:
content:
text/plain:
schema:
type: string
example: DENY
example: DENY
X-XSS-Protection:
content:
text/plain:
schema:
type: string
example: 1; mode=block
example: 1; mode=block
Content-Security-Policy:
content:
text/plain:
schema:
type: string
example: default-src 'self'
example: default-src 'self'
x-redlock-request-id:
content:
text/plain:
schema:
type: string
example: 85e71b7c274148e3b33167628e7e3621
example: 85e71b7c274148e3b33167628e7e3621
Accept:
content:
text/plain:
schema:
type: string
example: application/json;charset=UTF-8
example: application/json;charset=UTF-8
content: {}
deprecated: false
security: []
/v2/alert/rule:
get:
tags:
- Alert Rules
summary: ListAlertRulesV2
description: Returns all alert rules you have permission to see based on your role. The data returned does not include an open alerts count.
operationId: ListAlertRulesV2
parameters:
- name: Content-Type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
security: []
/integration/test:
post:
tags:
- Integrations (incomplete)
summary: TestIntegration(incomplete)
description: Runs a test of the integration for the specified data.
operationId: TestIntegration(incomplete)
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/TestIntegrationincompleteRequest'
- example:
name: INTEG_NAME
integrationType: SLACK
description: INTEG_DESC
enabled: true
status: GREEN
example:
name: INTEG_NAME
integrationType: SLACK
description: INTEG_DESC
enabled: true
status: GREEN
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/integration/name:
get:
tags:
- Integrations (incomplete)
summary: ListMetadataforAllIntegrations
description: >-
Returns the metadata for your integrations filtered by type:
"slack",
"splunk",
"amazon_sqs",
"webhook",
"microsoft_teams",
"jira",
"service_now",
"pager_duty",
"demisto",
"tenable",
"qualys",
"google_cscc",
"aws_security_hub"
operationId: ListMetadataforAllIntegrations
parameters:
- name: type
in: query
description: >-
"slack",
"splunk",
"amazon_sqs",
"webhook",
"microsoft_teams",
"jira",
"service_now",
"pager_duty",
"demisto",
"tenable",
"qualys",
"google_cscc",
"aws_security_hub"
required: true
style: form
explode: true
schema:
type: string
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/integration/type:
get:
tags:
- Integrations (incomplete)
summary: ListAllIntegrationTypes
description: Lists all integration types
operationId: ListAllIntegrationTypes
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/integration:
get:
tags:
- Integrations (incomplete)
summary: ListAllIntegrations
description: 'List all integrations. '
operationId: ListAllIntegrations
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/integration/INTEG_ID:
get:
tags:
- Integrations (incomplete)
summary: GetIntegrationsByID
description: Returns integration details for the specified ID.
operationId: GetIntegrationsByID
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- Integrations (incomplete)
summary: UpdateIntegration
description: Runs a test of the integration for the specified data.
operationId: UpdateIntegration
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/UpdateIntegrationRequest'
- example:
name: INTEG_NAME
integrationType: SLACK
description: INTEG_DESC
enabled: true
status: GREEN
example:
name: INTEG_NAME
integrationType: SLACK
description: INTEG_DESC
enabled: true
status: GREEN
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
delete:
tags:
- Integrations (incomplete)
summary: DeleteIntegration
description: Deletes a specific integration based on ID.
operationId: DeleteIntegration
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/settings/enterprise:
get:
tags:
- Settings
summary: EnterpriseSettings
description: 'Get Entperprise settings for the current Prisma Cloud tenant. '
operationId: EnterpriseSettings
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
post:
tags:
- Settings
summary: EnterpriseSettingsCopy
description: Updates enterprise settings based on body parameters.
operationId: EnterpriseSettingsCopy
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/EnterpriseSettingsCopyRequest'
- example:
defaultPoliciesEnabled:
low: true
medium: true
high: true
sessionTimeout: 999999
anomalyTrainingModelThreshold: High
anomalyAlertDisposition: High
userAttributionInNotification: true
requireAlertDismissalNote: true
applyDefaultPoliciesEnabled: true
example:
defaultPoliciesEnabled:
low: true
medium: true
high: true
sessionTimeout: 999999
anomalyTrainingModelThreshold: High
anomalyAlertDisposition: High
userAttributionInNotification: true
requireAlertDismissalNote: true
applyDefaultPoliciesEnabled: true
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/iac/v2/scans:
post:
tags:
- Infrastructure as Code
summary: AddScanAsset
description: "Create an IaC scan asset in Prisma Cloud.\n\nReturns a SCAN_ID (data.id) and a URL (data.links.url) for uploading the templates to be scanned. \n\nThe SCAN_ID is required by the Initiate Scan Job, Get Scan Job Status, and Get Scan Result Details endpoints."
operationId: AddScanAsset
parameters:
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/vnd.api+json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/vnd.api+json:
schema:
allOf:
- $ref: '#/components/schemas/AddScanAssetRequest'
- example:
data:
type: async-scan
attributes:
assetName: Asset name that will appear as the Resource name in the Prisma Cloud DevOps Inventory
assetType: IaC-API
failureCriteria:
high: 1
medium: 2
low: 3
operator: or
scanAttributes:
scanName: Example
scanVersion: '2.0'
tags:
org: Palo Alto Networks
team: Prisma Cloud SE
example:
data:
type: async-scan
attributes:
assetName: Asset name that will appear as the Resource name in the Prisma Cloud DevOps Inventory
assetType: IaC-API
failureCriteria:
high: 1
medium: 2
low: 3
operator: or
scanAttributes:
scanName: Example
scanVersion: '2.0'
tags:
org: Palo Alto Networks
team: Prisma Cloud SE
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/iac/v2/scans/SCAN_ID:
post:
tags:
- Infrastructure as Code
summary: InitiateScanJob
description: >-
Start a job to perform an asynchronous scan of the templates uploaded to the IaC scan asset.
Before using this endpoint, you must use the URL returned by the Add Scan Asset endpoint to upload the templates to be scanned.
operationId: InitiateScanJob
parameters:
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
requestBody:
description: ''
content:
application/vnd.api+json:
schema:
allOf:
- $ref: '#/components/schemas/InitiateScanJobRequest'
- example:
data:
attributes:
templateType: TF
templateVersion: '0.13'
id: SCAN_UUID
templateParameters:
variableFiles:
- RELATIVE/PATH/TO/VARIABLE/FILE
policyIdFilters:
- 1abcdef2-3gh4-5ij6-7kl8-9mnopqrstuv0
files:
- RELATIVE/PATH/TO/FILE
folders:
- RELATIVE/PATH/TO/FOLDER
example:
data:
attributes:
templateType: TF
templateVersion: '0.13'
id: SCAN_UUID
templateParameters:
variableFiles:
- RELATIVE/PATH/TO/VARIABLE/FILE
policyIdFilters:
- 1abcdef2-3gh4-5ij6-7kl8-9mnopqrstuv0
files:
- RELATIVE/PATH/TO/FILE
folders:
- RELATIVE/PATH/TO/FOLDER
required: true
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/iac/v2/scans/SCAN_ID/status:
get:
tags:
- Infrastructure as Code
summary: GetScanJobStatus
description: >-
Query scan job status.
Before using this endpoint, you must use the Initiate Scan Job endpoint to start the scan of the IaC scan asset.
operationId: GetScanJobStatus
parameters:
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/vnd.api+json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/iac/v2/scans/SCAN_ID/results:
get:
tags:
- Infrastructure as Code
summary: GetScanResultDetails
description: >-
Request IaC scan results.
Before using this endpoint, you must use the Get Scan Job Status endpoint to verify that the scan job is completed.
operationId: GetScanResultDetails
parameters:
- name: Accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/vnd.api+json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
/_support/customer:
get:
tags:
- Support App
summary: GetSupportAppCustomers
description: ''
operationId: GetSupportAppCustomers
parameters:
- name: accept
in: header
description: ''
required: true
style: simple
schema:
type: string
example: application/json; charset=UTF-8
- name: content-type
in: header
description: ''
required: true
style: simple
schema:
allOf:
- $ref: '#/components/schemas/content-type'
- example: application/json
- name: x-redlock-auth
in: header
description: ''
required: true
style: simple
schema:
type: string
example: '{{token}}'
responses:
'200':
description: ''
headers: {}
content: {}
deprecated: false
components:
schemas:
LoginGenerateTokenRequest:
title: LoginGenerateTokenRequest
required:
- username
- password
type: object
properties:
username:
type: string
password:
type: string
example:
username: '{{ACCESS_KEY}}'
password: '{{SECRET_KEY}}'
UpdateProfileRequest:
title: UpdateProfileRequest
required:
- email
- firstName
- lastName
- timeZone
- roleId
- accessKeysAllowed
- onlyAllowCIAccess
- onlyAllowComputeAccess
type: object
properties:
email:
type: string
firstName:
type: string
lastName:
type: string
timeZone:
type: string
roleId:
type: string
accessKeysAllowed:
type: boolean
onlyAllowCIAccess:
type: boolean
onlyAllowComputeAccess:
type: boolean
example:
email: email_to_update
firstName: first
lastName: last
timeZone: America/New_York
roleId: ROLE_ID_HERE
accessKeysAllowed: true
onlyAllowCIAccess: true
onlyAllowComputeAccess: true
AddNewUserProfilev2Request:
title: AddNewUserProfilev2Request
required:
- roleIds
- email
- firstName
- lastName
- timeZone
- accessKeysAllowed
- defaultRoleId
type: object
properties:
roleIds:
type: array
items:
type: string
description: ''
email:
type: string
firstName:
type: string
lastName:
type: string
timeZone:
type: string
accessKeysAllowed:
type: boolean
defaultRoleId:
type: string
example:
roleIds:
- ROLE_IDs_HERE
email: NEW_USER_EMAIL
firstName: FIRST_NAME
lastName: LAST_NAME
timeZone: GMT
accessKeysAllowed: true
defaultRoleId: DEFAULT_ROLE_ID
AddUserRoleRequest:
title: AddUserRoleRequest
required:
- accountGroupIds
- name
- description
- roleType
- restrictDismissalAccess
- additionalAttributes
type: object
properties:
accountGroupIds:
type: array
items:
type: string
description: ''
name:
type: string
description:
type: string
roleType:
type: string
restrictDismissalAccess:
type: boolean
additionalAttributes:
allOf:
- $ref: '#/components/schemas/AdditionalAttributes'
- example:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
example:
accountGroupIds:
- ACCOUNT_GROUP_ID
name: ROLE_NAME
description: Role Description
roleType: PERMISSION_GROUP_NAME
restrictDismissalAccess: false
additionalAttributes:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
AdditionalAttributes:
title: AdditionalAttributes
required:
- onlyAllowCIAccess
- onlyAllowComputeAccess
type: object
properties:
onlyAllowCIAccess:
type: boolean
onlyAllowComputeAccess:
type: boolean
example:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
UpdateUserRoleRequest:
title: UpdateUserRoleRequest
required:
- name
- description
- roleType
- accountGroupIds
- resourceListIds
- associatedUsers
- restrictDismissalAccess
- additionalAttributes
type: object
properties:
name:
type: string
description:
type: string
roleType:
type: string
accountGroupIds:
type: array
items:
type: string
description: ''
resourceListIds:
type: array
items:
type: string
description: ''
associatedUsers:
type: array
items:
type: string
description: ''
restrictDismissalAccess:
type: boolean
additionalAttributes:
allOf:
- $ref: '#/components/schemas/AdditionalAttributes1'
- example:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
hasDefenderPermissions: false
onlyAllowReadAccess: false
example:
name: ROLE_NAME
description: Role Description
roleType: PERMISSION_GROUP_NAME
accountGroupIds:
- ACCOUNT_GROUP_ID
resourceListIds:
- RESOURCE_LIST_IDS
associatedUsers:
- ASSOCIATED_USERS
restrictDismissalAccess: false
additionalAttributes:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
hasDefenderPermissions: false
onlyAllowReadAccess: false
AdditionalAttributes1:
title: AdditionalAttributes1
required:
- onlyAllowCIAccess
- onlyAllowComputeAccess
- hasDefenderPermissions
- onlyAllowReadAccess
type: object
properties:
onlyAllowCIAccess:
type: boolean
onlyAllowComputeAccess:
type: boolean
hasDefenderPermissions:
type: boolean
onlyAllowReadAccess:
type: boolean
example:
onlyAllowCIAccess: false
onlyAllowComputeAccess: false
hasDefenderPermissions: false
onlyAllowReadAccess: false
ListAccessKeysCopyRequest:
title: ListAccessKeysCopyRequest
required:
- name
- expiresOn
type: object
properties:
name:
type: string
expiresOn:
type: integer
format: int64
example:
name: ACCESS_KEY_ID
expiresOn: 9999999999
UpdateAccessKeyRequest:
title: UpdateAccessKeyRequest
required:
- name
- expiresOn
type: object
properties:
name:
type: string
expiresOn:
type: integer
format: int32
example:
name: ACCESS_KEY_NAME
expiresOn: 999999999
AddCloudAccountAWSRequest:
title: AddCloudAccountAWSRequest
required:
- accountId
- enabled
- externalId
- groupIds
- name
- roleArn
type: object
properties:
accountId:
type: string
enabled:
type: boolean
externalId:
type: string
groupIds:
type: array
items:
type: string
description: ''
name:
type: string
roleArn:
type: string
example:
accountId: AWS_ACCOUNT_ID
enabled: true
externalId: AWS_EXTERNAL_ID
groupIds: []
name: FRIENDLY_NAME
roleArn: AWS_ROLE_ARN
AddCloudAccountAzureRequest:
title: AddCloudAccountAzureRequest
required:
- cloudAccount
- clientId
- key
- monitorFlowLogs
- tenantId
- servicePrincipalId
type: object
properties:
cloudAccount:
allOf:
- $ref: '#/components/schemas/CloudAccount'
- example:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId:
type: string
key:
type: string
monitorFlowLogs:
type: boolean
tenantId:
type: string
servicePrincipalId:
type: string
example:
cloudAccount:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId: APPLICATION_ID
key: APPLICATION_SECRET
monitorFlowLogs: true
tenantId: AZURE_AD_ID
servicePrincipalId: ENTERPRISE_APP_OBJECT_ID
CloudAccount:
title: CloudAccount
required:
- accountId
- enabled
- groupIds
- name
type: object
properties:
accountId:
type: string
enabled:
type: boolean
groupIds:
type: array
items:
type: string
description: ''
name:
type: string
example:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
AddCloudAccountGCPRequest:
title: AddCloudAccountGCPRequest
required:
- cloudAccount
- compressionEnabled
- dataflowEnabledProject
- flowLogStorageBucket
- credentials
type: object
properties:
cloudAccount:
allOf:
- $ref: '#/components/schemas/CloudAccount'
- example:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled:
type: boolean
dataflowEnabledProject:
type: string
flowLogStorageBucket:
type: string
credentials:
allOf:
- $ref: '#/components/schemas/Credentials'
- example:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
example:
cloudAccount:
accountId: GCP_PROJECT_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled: false
dataflowEnabledProject: ''
flowLogStorageBucket: ''
credentials:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
Credentials:
title: Credentials
required:
- type
- project_id
- private_key_id
- private_key
- client_email
- client_id
- auth_uri
- token_uri
- auth_provider_x509_cert_url
- client_x509_cert_url
type: object
properties:
type:
type: string
project_id:
type: string
private_key_id:
type: string
private_key:
type: string
client_email:
type: string
client_id:
type: string
auth_uri:
type: string
token_uri:
type: string
auth_provider_x509_cert_url:
type: string
client_x509_cert_url:
type: string
example:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
AddCloudAccountAliCloudRequest:
title: AddCloudAccountAliCloudRequest
required:
- accountId
- groupIds
- name
- ramArn
type: object
properties:
accountId:
type: string
groupIds:
type: array
items:
type: string
description: ''
name:
type: string
ramArn:
type: string
example:
accountId: ALIBABA_ACCOUNT_ID
groupIds: []
name: FRIENDLY_NAME
ramArn: ALIBABA_RAM_RESOURCE
UpdateCloudAccountAWSRequest:
title: UpdateCloudAccountAWSRequest
required:
- name
- cloudType
- accountType
- enabled
- lastModifiedTs
- lastModifiedBy
- storageScanEnabled
- storageUUID
- protectionMode
- ingestionMode
- groupIds
- externalId
- roleArn
- canonicalId
- storageScanConfig
- cloudAccountStatus
- assumeRoleAccount
- accountId
- addedOn
type: object
properties:
name:
type: string
cloudType:
type: string
accountType:
type: string
enabled:
type: boolean
lastModifiedTs:
type: integer
format: int64
lastModifiedBy:
type: string
storageScanEnabled:
type: boolean
storageUUID:
type: string
protectionMode:
type: string
ingestionMode:
type: integer
format: int32
groupIds:
type: array
items:
type: string
description: ''
externalId:
type: string
roleArn:
type: string
canonicalId:
type: string
storageScanConfig:
allOf:
- $ref: '#/components/schemas/StorageScanConfig'
- example:
scanOption: Custom
buckets:
backward:
- ''
forward:
- ''
snsTopicArn: arn:aws:sns:us-east-1:CLOUD_ACCOUNT_ID:PrismaCloudSNS
cloudAccountStatus:
allOf:
- $ref: '#/components/schemas/CloudAccountStatus'
- example:
accountId: CLOUD_ACCOUNT_ID
lastUpdated: 1607389350494
lastFullSnapshot: 1607119740164
ingestionEndTime: 0
cloudType: aws
assumeRoleAccount:
type: string
accountId:
type: string
addedOn:
type: integer
format: int64
example:
name: CLOUD_ACCOUNT_NAME
cloudType: aws
accountType: account
enabled: true
lastModifiedTs: 1607368494285
lastModifiedBy: email
storageScanEnabled: true
storageUUID: GUID
protectionMode: MONITOR_AND_PROTECT
ingestionMode: 7
groupIds:
- 207697d0-b35c-41dc-ae37-b5aab4a45ccc
externalId: b09b59d4-26b4-44aa-8aa9-b57d0adda748
roleArn: arn:aws:iam::CLOUD_ACCOUNT_ID:role/PrismaCloudReadWriteRoleWithDLP
canonicalId: dd02d7e04eeb0b8e70f08756cffd062a34d7defcca7c121373df79d9006f51ea
storageScanConfig:
scanOption: Custom
buckets:
backward:
- ''
forward:
- ''
snsTopicArn: arn:aws:sns:us-east-1:CLOUD_ACCOUNT_ID:PrismaCloudSNS
cloudAccountStatus:
accountId: CLOUD_ACCOUNT_ID
lastUpdated: 1607389350494
lastFullSnapshot: 1607119740164
ingestionEndTime: 0
cloudType: aws
assumeRoleAccount: REDLOCK
accountId: CLOUD_ACCOUNT_ID
addedOn: 1607119031817
StorageScanConfig:
title: StorageScanConfig
required:
- scanOption
- buckets
- snsTopicArn
type: object
properties:
scanOption:
type: string
buckets:
allOf:
- $ref: '#/components/schemas/Buckets'
- example:
backward:
- ''
forward:
- ''
snsTopicArn:
type: string
example:
scanOption: Custom
buckets:
backward:
- ''
forward:
- ''
snsTopicArn: arn:aws:sns:us-east-1:CLOUD_ACCOUNT_ID:PrismaCloudSNS
Buckets:
title: Buckets
required:
- backward
- forward
type: object
properties:
backward:
type: array
items:
type: string
description: ''
forward:
type: array
items:
type: string
description: ''
example:
backward:
- ''
forward:
- ''
CloudAccountStatus:
title: CloudAccountStatus
required:
- accountId
- lastUpdated
- lastFullSnapshot
- ingestionEndTime
- cloudType
type: object
properties:
accountId:
type: string
lastUpdated:
type: integer
format: int64
lastFullSnapshot:
type: integer
format: int64
ingestionEndTime:
type: integer
format: int32
cloudType:
type: string
example:
accountId: CLOUD_ACCOUNT_ID
lastUpdated: 1607389350494
lastFullSnapshot: 1607119740164
ingestionEndTime: 0
cloudType: aws
PatchCloudAccountRequest:
title: PatchCloudAccountRequest
required:
- groupIds
- enabled
- updateChildrenStatus
type: object
properties:
groupIds:
type: array
items:
type: string
description: ''
enabled:
type: boolean
updateChildrenStatus:
type: boolean
example:
groupIds:
- ACCOUNT_GROUP_IDS
enabled: true
updateChildrenStatus: true
GetCloudAccountStatusAWSRequest:
title: GetCloudAccountStatusAWSRequest
required:
- accountId
- enabled
- externalId
- groupIds
- name
- roleArn
type: object
properties:
accountId:
type: string
enabled:
type: boolean
externalId:
type: string
groupIds:
type: array
items:
type: string
description: ''
name:
type: string
roleArn:
type: string
example:
accountId: AWS_ACCOUNT_ID
enabled: true
externalId: AWS_EXTERNAL_ID
groupIds: []
name: FRIENDLY_NAME
roleArn: AWS_ROLE_ARN
GetCloudAccountStatusAzureRequest:
title: GetCloudAccountStatusAzureRequest
required:
- cloudAccount
- clientId
- key
- monitorFlowLogs
- tenantId
- servicePrincipalId
type: object
properties:
cloudAccount:
allOf:
- $ref: '#/components/schemas/CloudAccount'
- example:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId:
type: string
key:
type: string
monitorFlowLogs:
type: boolean
tenantId:
type: string
servicePrincipalId:
type: string
example:
cloudAccount:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
clientId: APPLICATION_ID
key: APPLICATION_SECRET
monitorFlowLogs: true
tenantId: AZURE_AD_ID
servicePrincipalId: ENTERPRISE_APP_OBJECT_ID
GetCloudAccountStatusGCPRequest:
title: GetCloudAccountStatusGCPRequest
required:
- cloudAccount
- compressionEnabled
- dataflowEnabledProject
- flowLogStorageBucket
- credentials
type: object
properties:
cloudAccount:
allOf:
- $ref: '#/components/schemas/CloudAccount'
- example:
accountId: AZURE_SUBSCRIPTION_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled:
type: boolean
dataflowEnabledProject:
type: string
flowLogStorageBucket:
type: string
credentials:
allOf:
- $ref: '#/components/schemas/Credentials'
- example:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
example:
cloudAccount:
accountId: GCP_PROJECT_ID
enabled: true
groupIds: []
name: FRIENDLY_NAME
compressionEnabled: false
dataflowEnabledProject: ''
flowLogStorageBucket: ''
credentials:
type: ''
project_id: ''
private_key_id: ''
private_key: ''
client_email: ''
client_id: ''
auth_uri: ''
token_uri: ''
auth_provider_x509_cert_url: ''
client_x509_cert_url: ''
GetCloudAccountStatusAliCloudRequest:
title: GetCloudAccountStatusAliCloudRequest
required:
- accountId
- groupIds
- name
- ramArn
type: object
properties:
accountId:
type: string
groupIds:
type: array
items:
type: string
description: ''
name:
type: string
ramArn:
type: string
example:
accountId: ALIBABA_ACCOUNT_ID
groupIds: []
name: FRIENDLY_NAME
ramArn: ALIBABA_RAM_RESOURCE
UpdateCloudAccountStatusRequest:
title: UpdateCloudAccountStatusRequest
required:
- groupIds
- enabled
- updateChildrenStatus
type: object
properties:
groupIds:
type: array
items:
type: string
description: ''
enabled:
type: boolean
updateChildrenStatus:
type: boolean
example:
groupIds:
- ACCOUNT_GROUP_IDS
enabled: true
updateChildrenStatus: true
AccountAccountGroupRequest:
title: AccountAccountGroupRequest
required:
- accountIds
- name
- description
type: object
properties:
accountIds:
type: array
items:
type: string
description: ''
name:
type: string
description:
type: string
example:
accountIds:
- CLOUD_ACCOUNT_ID_1
- CLOUD_ACCOUNT_ID_2
name: ACCOUNT_GROUP_NAME
description: ACCOUNT_GROUP_DESCRIPTION
UpdateAccountGroupRequest:
title: UpdateAccountGroupRequest
required:
- accountIds
- name
- description
type: object
properties:
accountIds:
type: array
items:
type: string
description: ''
name:
type: string
description:
type: string
example:
accountIds:
- CLOUD_ACCOUNT_ID_1
- CLOUD_ACCOUNT_ID_2
name: ACCOUNT_GROUP_NAME
description: DESCRIPTION
ListPolicyFilterAutocompleteSuggestionsRequest:
title: ListPolicyFilterAutocompleteSuggestionsRequest
required:
- query
- filterName
type: object
properties:
query:
type: string
filterName:
type: string
example:
query: AUTO_COMPLETE_FILTER
filterName: FILTER_NAME
incompleteCOMPLEX-AddPolicyRequest:
title: incompleteCOMPLEX-AddPolicyRequest
required:
- rule
- complianceMetadata
- remediation
- labels
- name
- policyType
- description
- severity
- recommendation
- cloudType
- enabled
type: object
properties:
rule:
allOf:
- $ref: '#/components/schemas/Rule'
- example:
parameters:
savedSearch: 'true'
name: RULE_NAME
criteria: SEARCH_ID
type: Config
complianceMetadata:
type: array
items:
$ref: '#/components/schemas/ComplianceMetadatum'
description: ''
remediation:
allOf:
- $ref: '#/components/schemas/Remediation'
- example:
templateType: StaticTemplate
description: AUTO_REMEDIATION_DESCRIPTION
cliScriptTemplate: CLI_TEMPLATE
labels:
type: array
items:
type: string
description: ''
name:
type: string
policyType:
type: string
description:
type: string
severity:
type: string
recommendation:
type: string
cloudType:
type: string
enabled:
type: boolean
example:
rule:
parameters:
savedSearch: 'true'
name: RULE_NAME
criteria: SEARCH_ID
type: Config
complianceMetadata:
- standardName: standardName
standardDescription: standardDescription
requirementId: requirementId
requirementName: requirementName
requirementDescription: requirementDescription
sectionId: sectionId
sectionDescription: sectionDescription
policyId: policyId
complianceId: complianceId
sectionLabel: sectionLabel
customAssigned: true
remediation:
templateType: StaticTemplate
description: AUTO_REMEDIATION_DESCRIPTION
cliScriptTemplate: CLI_TEMPLATE
labels:
- POLICY_LABEL
name: POLICY_NAME
policyType: config
description: POLICY_DESCRIPTION
severity: medium
recommendation: RECOMMENDATION_ACTION
cloudType: aws
enabled: true
Rule:
title: Rule
required:
- parameters
- name
- criteria
- type
type: object
properties:
parameters:
allOf:
- $ref: '#/components/schemas/Parameters'
- example:
savedSearch: 'true'
name:
type: string
criteria:
type: string
type:
type: string
example:
parameters:
savedSearch: 'true'
name: RULE_NAME
criteria: SEARCH_ID
type: Config
Parameters:
title: Parameters
required:
- savedSearch
type: object
properties:
savedSearch:
type: string
example:
savedSearch: 'true'
ComplianceMetadatum:
title: ComplianceMetadatum
required:
- standardName
- standardDescription
- requirementId
- requirementName
- requirementDescription
- sectionId
- sectionDescription
- policyId
- complianceId
- sectionLabel
- customAssigned
type: object
properties:
standardName:
type: string
standardDescription:
type: string
requirementId:
type: string
requirementName:
type: string
requirementDescription:
type: string
sectionId:
type: string
sectionDescription:
type: string
policyId:
type: string
complianceId:
type: string
sectionLabel:
type: string
customAssigned:
type: boolean
example:
standardName: standardName
standardDescription: standardDescription
requirementId: requirementId
requirementName: requirementName
requirementDescription: requirementDescription
sectionId: sectionId
sectionDescription: sectionDescription
policyId: policyId
complianceId: complianceId
sectionLabel: sectionLabel
customAssigned: true
Remediation:
title: Remediation
required:
- templateType
- description
- cliScriptTemplate
type: object
properties:
templateType:
type: string
description:
type: string
cliScriptTemplate:
type: string
example:
templateType: StaticTemplate
description: AUTO_REMEDIATION_DESCRIPTION
cliScriptTemplate: CLI_TEMPLATE
incompleteCOMPLEX-UpdatePolicyRequest:
title: incompleteCOMPLEX-UpdatePolicyRequest
required:
- rule
- complianceMetadata
- remediation
- labels
- name
- policyType
- description
- severity
- recommendation
- cloudType
- enabled
type: object
properties:
rule:
allOf:
- $ref: '#/components/schemas/Rule'
- example:
parameters:
savedSearch: 'true'
name: RULE_NAME
criteria: SEARCH_ID
type: Config
complianceMetadata:
type: array
items:
$ref: '#/components/schemas/ComplianceMetadatum'
description: ''
remediation:
allOf:
- $ref: '#/components/schemas/Remediation'
- example:
templateType: StaticTemplate
description: AUTO_REMEDIATION_DESCRIPTION
cliScriptTemplate: CLI_TEMPLATE
labels:
type: array
items:
type: string
description: ''
name:
type: string
policyType:
type: string
description:
type: string
severity:
type: string
recommendation:
type: string
cloudType:
type: string
enabled:
type: boolean
example:
rule:
parameters:
savedSearch: 'true'
name: RULE_NAME
criteria: SEARCH_ID
type: Config
complianceMetadata:
- standardName: standardName
standardDescription: standardDescription
requirementId: requirementId
requirementName: requirementName
requirementDescription: requirementDescription
sectionId: sectionId
sectionDescription: sectionDescription
policyId: policyId
complianceId: complianceId
sectionLabel: sectionLabel
customAssigned: true
remediation:
templateType: StaticTemplate
description: AUTO_REMEDIATION_DESCRIPTION
cliScriptTemplate: CLI_TEMPLATE
labels:
- POLICY_LABEL
name: POLICY_NAME
policyType: config
description: POLICY_DESCRIPTION
severity: medium
recommendation: RECOMMENDATION_ACTION
cloudType: aws
enabled: true
ListAlertFiltersCopyRequest:
title: ListAlertFiltersCopyRequest
required:
- timeRange
- filters
- fields
- sortBy
- limit
type: object
properties:
timeRange:
allOf:
- $ref: '#/components/schemas/TimeRange'
- example:
value:
unit: hour
amount: 1
type: relative
filters:
type: array
items:
$ref: '#/components/schemas/Filter'
description: ''
fields:
type: array
items:
type: string
description: ''
sortBy:
type: array
items:
type: string
description: ''
limit:
type: integer
format: int32
example:
timeRange:
value:
unit: hour
amount: 1
type: relative
filters:
- name: alert.status
value: open
operator: =
fields:
- policy.name
- alertCount
sortBy:
- :asc
limit: 2
TimeRange:
title: TimeRange
required:
- value
- type
type: object
properties:
value:
allOf:
- $ref: '#/components/schemas/Value'
- example:
unit: hour
amount: 1
type:
type: string
example:
value:
unit: hour
amount: 1
type: relative
Value:
title: Value
required:
- unit
- amount
type: object
properties:
unit:
type: string
amount:
type: integer
format: int32
example:
unit: hour
amount: 1
Filter:
title: Filter
required:
- name
- value
- operator
type: object
properties:
name:
type: string
value:
type: string
operator:
type: string
example:
name: alert.status
value: open
operator: =
ListAlertRemediationCommandsRequest:
title: ListAlertRemediationCommandsRequest
required:
- alerts
- filter
type: object
properties:
alerts:
type: array
items:
type: string
description: ''
filter:
allOf:
- $ref: '#/components/schemas/Filter1'
- example:
timeRange:
type: to_now
value: epoch
example:
alerts:
- P-153248
filter:
timeRange:
type: to_now
value: epoch
Filter1:
title: Filter1
required:
- timeRange
type: object
properties:
timeRange:
allOf:
- $ref: '#/components/schemas/TimeRange1'
- example:
type: to_now
value: epoch
example:
timeRange:
type: to_now
value: epoch
TimeRange1:
title: TimeRange1
required:
- type
- value
type: object
properties:
type:
type: string
value:
type: string
example:
type: to_now
value: epoch
ListInventoryDashboardFilterAutocompleteSuggestionsV2Request:
title: ListInventoryDashboardFilterAutocompleteSuggestionsV2Request
required:
- query
- filterName
type: object
properties:
query:
type: string
filterName:
type: string
example:
query: QUERY
filterName: FILTER
LicensingUsageCountforComputeRequest:
title: LicensingUsageCountforComputeRequest
required:
- aggregate
- timeRange
type: object
properties:
aggregate:
type: boolean
timeRange:
allOf:
- $ref: '#/components/schemas/TimeRange1'
- example:
type: to_now
value: epoch
example:
aggregate: true
timeRange:
type: to_now
value: epoch
httpsapi.prismacloud.iosearchconfigrequest:
title: httpsapi.prismacloud.iosearchconfigrequest
required:
- query
- timeRange
type: object
properties:
query:
type: string
timeRange:
allOf:
- $ref: '#/components/schemas/TimeRange'
- example:
value:
unit: hour
amount: 1
type: relative
example:
query: "config where api.name = 'azure-network-nic-list' "
timeRange:
type: relative
value:
unit: hour
amount: 24
TestIntegrationincompleteRequest:
title: TestIntegrationincompleteRequest
required:
- name
- integrationType
- description
- enabled
- status
type: object
properties:
name:
type: string
integrationType:
type: string
description:
type: string
enabled:
type: boolean
status:
type: string
example:
name: INTEG_NAME
integrationType: SLACK
description: INTEG_DESC
enabled: true
status: GREEN
UpdateIntegrationRequest:
title: UpdateIntegrationRequest
required:
- name
- integrationType
- description
- enabled
- status
type: object
properties:
name:
type: string
integrationType:
type: string
description:
type: string
enabled:
type: boolean
status:
type: string
example:
name: INTEG_NAME
integrationType: SLACK
description: INTEG_DESC
enabled: true
status: GREEN
EnterpriseSettingsCopyRequest:
title: EnterpriseSettingsCopyRequest
required:
- defaultPoliciesEnabled
- sessionTimeout
- anomalyTrainingModelThreshold
- anomalyAlertDisposition
- userAttributionInNotification
- requireAlertDismissalNote
- applyDefaultPoliciesEnabled
type: object
properties:
defaultPoliciesEnabled:
allOf:
- $ref: '#/components/schemas/DefaultPoliciesEnabled'
- example:
low: true
medium: true
high: true
sessionTimeout:
type: integer
format: int32
anomalyTrainingModelThreshold:
type: string
anomalyAlertDisposition:
type: string
userAttributionInNotification:
type: boolean
requireAlertDismissalNote:
type: boolean
applyDefaultPoliciesEnabled:
type: boolean
example:
defaultPoliciesEnabled:
low: true
medium: true
high: true
sessionTimeout: 999999
anomalyTrainingModelThreshold: High
anomalyAlertDisposition: High
userAttributionInNotification: true
requireAlertDismissalNote: true
applyDefaultPoliciesEnabled: true
DefaultPoliciesEnabled:
title: DefaultPoliciesEnabled
required:
- low
- medium
- high
type: object
properties:
low:
type: boolean
medium:
type: boolean
high:
type: boolean
example:
low: true
medium: true
high: true
AddScanAssetRequest:
title: AddScanAssetRequest
required:
- data
type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/Data'
- example:
type: async-scan
attributes:
assetName: Asset name that will appear as the Resource name in the Prisma Cloud DevOps Inventory
assetType: IaC-API
failureCriteria:
high: 1
medium: 2
low: 3
operator: or
scanAttributes:
scanName: Example
scanVersion: '2.0'
tags:
org: Palo Alto Networks
team: Prisma Cloud SE
example:
data:
type: async-scan
attributes:
assetName: Asset name that will appear as the Resource name in the Prisma Cloud DevOps Inventory
assetType: IaC-API
failureCriteria:
high: 1
medium: 2
low: 3
operator: or
scanAttributes:
scanName: Example
scanVersion: '2.0'
tags:
org: Palo Alto Networks
team: Prisma Cloud SE
Data:
title: Data
required:
- type
- attributes
type: object
properties:
type:
type: string
attributes:
allOf:
- $ref: '#/components/schemas/Attributes'
- example:
assetName: Asset name that will appear as the Resource name in the Prisma Cloud DevOps Inventory
assetType: IaC-API
failureCriteria:
high: 1
medium: 2
low: 3
operator: or
scanAttributes:
scanName: Example
scanVersion: '2.0'
tags:
org: Palo Alto Networks
team: Prisma Cloud SE
example:
type: async-scan
attributes:
assetName: Asset name that will appear as the Resource name in the Prisma Cloud DevOps Inventory
assetType: IaC-API
failureCriteria:
high: 1
medium: 2
low: 3
operator: or
scanAttributes:
scanName: Example
scanVersion: '2.0'
tags:
org: Palo Alto Networks
team: Prisma Cloud SE
Attributes:
title: Attributes
required:
- assetName
- assetType
- failureCriteria
- scanAttributes
- tags
type: object
properties:
assetName:
type: string
assetType:
type: string
failureCriteria:
allOf:
- $ref: '#/components/schemas/FailureCriteria'
- example:
high: 1
medium: 2
low: 3
operator: or
scanAttributes:
allOf:
- $ref: '#/components/schemas/ScanAttributes'
- example:
scanName: Example
scanVersion: '2.0'
tags:
allOf:
- $ref: '#/components/schemas/Tags'
- example:
org: Palo Alto Networks
team: Prisma Cloud SE
example:
assetName: Asset name that will appear as the Resource name in the Prisma Cloud DevOps Inventory
assetType: IaC-API
failureCriteria:
high: 1
medium: 2
low: 3
operator: or
scanAttributes:
scanName: Example
scanVersion: '2.0'
tags:
org: Palo Alto Networks
team: Prisma Cloud SE
FailureCriteria:
title: FailureCriteria
required:
- high
- medium
- low
- operator
type: object
properties:
high:
type: integer
format: int32
medium:
type: integer
format: int32
low:
type: integer
format: int32
operator:
type: string
example:
high: 1
medium: 2
low: 3
operator: or
ScanAttributes:
title: ScanAttributes
required:
- scanName
- scanVersion
type: object
properties:
scanName:
type: string
scanVersion:
type: string
example:
scanName: Example
scanVersion: '2.0'
Tags:
title: Tags
required:
- org
- team
type: object
properties:
org:
type: string
team:
type: string
example:
org: Palo Alto Networks
team: Prisma Cloud SE
InitiateScanJobRequest:
title: InitiateScanJobRequest
required:
- data
type: object
properties:
data:
allOf:
- $ref: '#/components/schemas/Data1'
- example:
attributes:
templateType: TF
templateVersion: '0.13'
id: SCAN_UUID
templateParameters:
variableFiles:
- RELATIVE/PATH/TO/VARIABLE/FILE
policyIdFilters:
- 1abcdef2-3gh4-5ij6-7kl8-9mnopqrstuv0
files:
- RELATIVE/PATH/TO/FILE
folders:
- RELATIVE/PATH/TO/FOLDER
example:
data:
attributes:
templateType: TF
templateVersion: '0.13'
id: SCAN_UUID
templateParameters:
variableFiles:
- RELATIVE/PATH/TO/VARIABLE/FILE
policyIdFilters:
- 1abcdef2-3gh4-5ij6-7kl8-9mnopqrstuv0
files:
- RELATIVE/PATH/TO/FILE
folders:
- RELATIVE/PATH/TO/FOLDER
Data1:
title: Data1
required:
- attributes
- id
- templateParameters
type: object
properties:
attributes:
allOf:
- $ref: '#/components/schemas/Attributes1'
- example:
templateType: TF
templateVersion: '0.13'
id:
type: string
templateParameters:
allOf:
- $ref: '#/components/schemas/TemplateParameters'
- example:
variableFiles:
- RELATIVE/PATH/TO/VARIABLE/FILE
policyIdFilters:
- 1abcdef2-3gh4-5ij6-7kl8-9mnopqrstuv0
files:
- RELATIVE/PATH/TO/FILE
folders:
- RELATIVE/PATH/TO/FOLDER
example:
attributes:
templateType: TF
templateVersion: '0.13'
id: SCAN_UUID
templateParameters:
variableFiles:
- RELATIVE/PATH/TO/VARIABLE/FILE
policyIdFilters:
- 1abcdef2-3gh4-5ij6-7kl8-9mnopqrstuv0
files:
- RELATIVE/PATH/TO/FILE
folders:
- RELATIVE/PATH/TO/FOLDER
Attributes1:
title: Attributes1
required:
- templateType
- templateVersion
type: object
properties:
templateType:
type: string
templateVersion:
type: string
example:
templateType: TF
templateVersion: '0.13'
TemplateParameters:
title: TemplateParameters
required:
- variableFiles
- policyIdFilters
- files
- folders
type: object
properties:
variableFiles:
type: array
items:
type: string
description: ''
policyIdFilters:
type: array
items:
type: string
description: ''
files:
type: array
items:
type: string
description: ''
folders:
type: array
items:
type: string
description: ''
example:
variableFiles:
- RELATIVE/PATH/TO/VARIABLE/FILE
policyIdFilters:
- 1abcdef2-3gh4-5ij6-7kl8-9mnopqrstuv0
files:
- RELATIVE/PATH/TO/FILE
folders:
- RELATIVE/PATH/TO/FOLDER
content-type:
title: content-type
enum:
- application/json
type: string
example: application/json
tags:
- name: Login
- name: System
- name: User Profile
- name: User Roles
- name: Access Keys
- name: Cloud Accounts
- name: Account Groups
- name: Policy
- name: Time Range Model (Info Only)
- name: Alerts (incomplete)
- name: Asset Inventory
- name: Compliance Posture
- name: Compliance Dashboard
- name: Compliance Standards
- name: Audit Logs
- name: Licensing
- name: Search
- name: Alert Rules
- name: Integrations (incomplete)
- name: Settings
- name: Infrastructure as Code
- name: Support App