Palo Alto Networks Alerts API

Prisma Cloud generates an alert when it detects a violation in a policy that is included in an active alert rule. You can use the API requests to manage alerts, including listing or viewing, snoozing or dismissing, reopening, or remediating alerts. When retrieving a list of alerts through an API request, you can set filters, time range parameters, or pagination parameters. ### Pagination You can limit the number of items in a response list from API resources that support pagination. Version 2 (V2) of the API requests to list alerts supports pagination and will accept the following request parameters. Request Parameter | Description -----------| ------- **limit** | Maximum number of items to return per page. Without pagination, maximum number of items to return in a response. **offset** | Number of items to skip before selecting items to return. Default is zero. **pageToken** | Set to the **nextPageToken** value from the previous response object to return the next page of data. ### Filters API requests that use POST methods to request a list of alerts have filter parameters that enable you to narrow your request to alerts that meet a certain criteria.The [List Alert Filters](/prisma-cloud/api/cspm/get-alert-filter-options) requests return the available filters.

OpenAPI Specification

palo-alto-networks-alerts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Palo Alto Networks Alerts API
  version: '1.0'
  description: 'Operations tagged Alerts across 6 of this provider''s published API definitions: palo-alto-cspm-alerts-openapi.json, palo-alto-cspm-alertsmicroservices-openapi.json, palo-alto-cspm-alertsnotificationmicroservice-openapi.json, palo-alto-cspm-consolidated-spec-cspm-spec-openapi.json, palo-alto-cspm-pia-openapi-openapi.json, palo-alto-dspm-dspm-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.prismacloud.io
- url: https://api2.prismacloud.io
- url: https://api3.prismacloud.io
- url: https://api4.prismacloud.io
- url: https://api.anz.prismacloud.io
- url: https://api.eu.prismacloud.io
- url: https://api2.eu.prismacloud.io
- url: https://api.gov.prismacloud.io
- url: https://api.prismacloud.cn
- url: https://api.ca.prismacloud.io
- url: https://api.sg.prismacloud.io
- url: https://api.uk.prismacloud.io
- url: https://api.ind.prismacloud.io
- url: https://api.jp.prismacloud.io
- url: https://api.fr.prismacloud.io
- url: https://api.dig.security
  description: Dig Security public API
- url: PATH_TO_CONSOLE
tags:
- description: "Prisma Cloud generates an alert when it detects a violation in a policy that is included in an active alert rule. \nYou can use the API requests to manage alerts, including listing or viewing, snoozing or dismissing, reopening, \nor remediating alerts.\n\nWhen retrieving a list of alerts through an API request, you can set filters, time range parameters, or pagination parameters.\n\n### Pagination\n\nYou can limit the number of items in a response list from API resources that support pagination. Version 2 (V2) of the API \nrequests to list alerts supports pagination and will accept the following request parameters.\n\nRequest Parameter  | Description  \n-----------| -------\n**limit** | Maximum number of items to return per page. Without pagination, maximum number of items to return in a response.\n**offset** | Number of items to skip before selecting items to return. Default is zero.\n**pageToken** | Set to the **nextPageToken** value from the previous response object to return the next page of data.\n\n### Filters\n\nAPI requests that use POST methods to request a list of alerts have filter parameters that enable you to narrow your request \nto alerts that meet a certain criteria.The [List Alert Filters](/prisma-cloud/api/cspm/get-alert-filter-options) \nrequests return the available filters.        \n"
  name: Alerts
paths:
  /filter/alert/suggest:
    get:
      description: Returns an object whose keys are the available policy filters. The corresponding values are default or recently set filter options
      operationId: get-alert-filter-and-options
      responses:
        '200':
          content:
            application/json; charset=UTF-8:
              schema:
                $ref: '#/components/schemas/AlertFilterSuggestion'
          description: success
      security:
      - x-redlock-auth: []
      summary: List Alert Filters
      tags:
      - Alerts
    post:
      description: Returns available options for an alert filter key. Supports fuzzy autocomplete search. If you specify a **query** value in the request body parameters, the response includes only items that contain the **query** string.
      operationId: get-alert-filter-options
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/FilterSuggestionModel'
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ParsedTableFilter'
          description: successful operation
      security:
      - x-redlock-auth: []
      summary: List Alert Filter Autocomplete Suggestions
      tags:
      - Alerts
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
    - url: https://api.anz.prismacloud.io
    - url: https://api.eu.prismacloud.io
    - url: https://api2.eu.prismacloud.io
    - url: https://api.gov.prismacloud.io
    - url: https://api.prismacloud.cn
    - url: https://api.ca.prismacloud.io
    - url: https://api.sg.prismacloud.io
    - url: https://api.uk.prismacloud.io
    - url: https://api.ind.prismacloud.io
    - url: https://api.jp.prismacloud.io
    - url: https://api.fr.prismacloud.io
  /alert:
    get:
      description: "Returns a list of alerts that match the constraints specified in the query parameters. Max 10k results. To get more, use **List Alerts V2 - GET**.  \n\nData in the response object does not include alert rules.\n\nAlso, in the response object:\n\n* Property **riskDetail** is deprecated.\n* Property **resource.cloudServiceName** is populated only for alerts whose resources belong to a cloud service.\n\nWhen `detailed` flag is set to **true**, following fields will be returned within the policy response object:\n\n- `complianceMetadata`\n- `name`\n- `description`\n- `labels`\n- `deleted`\n- `recommendation`\n- `lastModifiedBy`\n- `lastModifiedOn`\n- `severity`\n\n#### Rate Limits ####\n\nThe following rate limits apply:\n* Request rate limit: 2/sec \n* Burst limit: 10/sec        \n"
      operationId: get-alerts
      parameters:
      - description: Time Type
        in: query
        name: timeType
        required: true
        schema:
          enum:
          - relative
          type: string
      - description: Number of **timeUnits**
        in: query
        name: timeAmount
        required: true
        schema:
          type: string
      - description: Time Unit
        in: query
        name: timeUnit
        required: true
        schema:
          enum:
          - minute
          - hour
          - day
          - week
          - month
          - year
          type: string
      - description: true = Return detailed alert data.
        in: query
        name: detailed
        required: true
        schema:
          type: boolean
      - description: 'Comma-separated list of specific fields to retrieve. Allowed values: alert.id, alert.status, alert.time, cloud.accountId, cloud.account, cloud.region, resource.id, resource.name, policy.name, policy.type, policy.severity'
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: The maximum number of items that will be returned in one response. The maximum cannot exceed 10,000. The default is 10,000.
        in: query
        name: limit
        required: false
        schema:
          type: number
      - description: Alert ID
        in: query
        name: alert.id
        required: false
        schema:
          type: string
      - description: Alert status
        in: query
        name: alert.status
        required: false
        schema:
          enum:
          - open
          - dismissed
          - snoozed
          - resolved
          - pending_resolution
          type: string
      - description: Cloud account
        in: query
        name: cloud.account
        required: false
        schema:
          type: string
      - description: Cloud account Id
        in: query
        name: cloud.accountId
        required: false
        schema:
          type: string
      - description: Account group
        in: query
        name: account.group
        required: false
        schema:
          type: string
      - description: Cloud type
        in: query
        name: cloud.type
        required: false
        schema:
          type: string
      - description: Cloud region
        in: query
        name: cloud.region
        required: false
        schema:
          type: string
      - description: Cloud service
        in: query
        name: cloud.service
        required: false
        schema:
          type: string
      - description: Policy ID
        in: query
        name: policy.id
        required: false
        schema:
          type: string
      - description: Policy name
        in: query
        name: policy.name
        required: false
        schema:
          type: string
      - description: Policy severity
        in: query
        name: policy.severity
        required: false
        schema:
          enum:
          - critical
          - high
          - medium
          - low
          - informational
          type: string
      - description: Policy label
        in: query
        name: policy.label
        required: false
        schema:
          type: string
      - description: Policy type
        in: query
        name: policy.type
        required: false
        schema:
          enum:
          - config
          - network
          - audit_event
          type: string
      - description: Policy compliance standard name
        in: query
        name: policy.complianceStandard
        required: false
        schema:
          type: string
      - description: Policy compliance requirement name
        in: query
        name: policy.complianceRequirement
        required: false
        schema:
          type: string
      - description: Policy compliance section ID
        in: query
        name: policy.complianceSection
        required: false
        schema:
          type: string
      - description: Policy is remediable
        in: query
        name: policy.remediable
        required: false
        schema:
          enum:
          - 'true'
          - 'false'
          type: string
      - description: Alert rule name
        in: query
        name: alertRule.name
        required: false
        schema:
          type: string
      - description: Resource ID
        in: query
        name: resource.id
        required: false
        schema:
          type: string
      - description: Resource name
        in: query
        name: resource.name
        required: false
        schema:
          type: string
      - description: Resource TYPE
        in: query
        name: resource.type
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/AlertModel'
                type: array
          description: successful operation
        '400':
          description: internal_error
        '429':
          description: Too Many Requests
      security:
      - x-redlock-auth: []
      summary: List Alerts - GET
      tags:
      - Alerts
    post:
      description: "Returns a list of alerts that matches the constraints specified in the body parameters. Max 10k results. To get more, use **List Alerts V2 - POST**.  \n\nThe **fields** body parameter allows you to request specific fields from the alert payload. These fields\nare separate from the filters you specify. The following are valid **fields** items.\n\n* alert.id\n* alert.status\n* alert.time\n* cloud.account\n* cloud.accountId\n* cloud.region\n* resource.id\n* resource.name\n* policy.name\n* policy.type\n* policy.severity\n\nThe **filters** body parameter enables you to narrow your request for alerts. See \n[List Alert Filters](/prisma-cloud/api/cspm/get-alert-filter-and-options) \nfor an API request to list all the valid filters.\n\nData in the response object does not include alert rules.\n\nAlso, in the response object:\n\n* Property **riskDetail** is deprecated.\n* Property **resource.cloudServiceName** is populated only for alerts whose resources belong to a cloud service.\n\nWhen `detailed` flag is set to **true**, following fields will be returned within the policy response object:\n\n- `complianceMetadata`\n- `name`\n- `description`\n- `labels`\n- `deleted`\n- `recommendation`\n- `lastModifiedBy`\n- `lastModifiedOn`\n- `severity`\n\n#### Rate Limits ####\n\nThe following rate limits apply:\n* Request rate limit: 2/sec \n* Burst limit: 10/sec        \n"
      operationId: post-alerts
      parameters:
      - description: true = Return detailed alert data. Default is false. Overrides **detailed** in body param.
        in: query
        name: detailed
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/FilterModel'
      responses:
        '200':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/AlertModel'
                type: array
          description: successful operation
        '400':
          description: internal_error
        '429':
          description: Too Many Requests
      security:
      - x-redlock-auth: []
      summary: List Alerts - POST
      tags:
      - Alerts
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
    - url: https://api.anz.prismacloud.io
    - url: https://api.eu.prismacloud.io
    - url: https://api2.eu.prismacloud.io
    - url: https://api.gov.prismacloud.io
    - url: https://api.prismacloud.cn
    - url: https://api.ca.prismacloud.io
    - url: https://api.sg.prismacloud.io
    - url: https://api.uk.prismacloud.io
    - url: https://api.ind.prismacloud.io
    - url: https://api.jp.prismacloud.io
    - url: https://api.fr.prismacloud.io
  /v2/alert:
    get:
      description: "Returns a paginated list of alerts from the Prisma Cloud platform.  \n\nData in the response object does not include alert rules.\n\nAlso, in the response object:\n\n* Property **riskDetail** is deprecated.\n* Property **items[].resource.cloudServiceName** is populated only for alerts whose resources belong to a cloud service.\n\nWhen `detailed` flag is set to **true**, following fields will be returned within the policy response object:\n\n- `complianceMetadata`\n- `name`\n- `description`\n- `labels`\n- `deleted`\n- `recommendation`\n- `lastModifiedBy`\n- `lastModifiedOn`\n- `severity`\n\n#### Rate Limits ####\n\nThe following rate limits apply:\n* Request rate limit: 2/sec \n* Burst limit: 10/sec      \n"
      operationId: get-alerts-v2
      parameters:
      - description: Time Type
        in: query
        name: timeType
        required: true
        schema:
          enum:
          - relative
          type: string
      - description: Number of **timeUnits**
        in: query
        name: timeAmount
        required: true
        schema:
          type: string
      - description: Time Unit
        in: query
        name: timeUnit
        required: true
        schema:
          enum:
          - minute
          - hour
          - day
          - week
          - month
          - year
          type: string
      - description: true = Return detailed alert data.
        in: query
        name: detailed
        required: true
        schema:
          type: boolean
      - description: 'Array of specific fields to return. Allowed fields: alert.id, alert.status, alert.time, cloud.accountId, cloud.account, cloud.region, resource.id, resource.name, policy.name, policy.type, policy.severity'
        in: query
        name: fields
        required: false
        schema:
          type: string
      - description: 'Response object property by which to sort response list. The valid values are in the response object attribute **sortAllowedColumns**. The format is **property:asc** for ascending and **property:desc** for descending sort '
        example: sortBy=id:desc&sortBy=firstseen:asc,lastseen:desc
        in: query
        name: sortBy
        required: false
        schema:
          type: string
      - description: The maximum number of items that will be returned in one response. The maximum cannot exceed 10,000. The default is 10,000.
        in: query
        name: limit
        required: false
        schema:
          type: number
      - description: Token that identifies the required page of data. When there are multiple pages of data in the response, set **pageToken** to the **nextPageToken** value from the previous API response to retrieve the next page of data.
        in: query
        name: pageToken
        required: false
        schema:
          type: string
      - description: Alert ID
        in: query
        name: alert.id
        required: false
        schema:
          type: string
      - description: Alert status
        in: query
        name: alert.status
        required: false
        schema:
          enum:
          - open
          - dismissed
          - snoozed
          - resolved
          - pending_resolution
          type: string
      - description: Cloud account
        in: query
        name: cloud.account
        required: false
        schema:
          type: string
      - description: Cloud account Id
        in: query
        name: cloud.accountId
        required: false
        schema:
          type: string
      - description: Account group
        in: query
        name: account.group
        required: false
        schema:
          type: string
      - description: Cloud type
        in: query
        name: cloud.type
        required: false
        schema:
          type: string
      - description: Cloud region
        in: query
        name: cloud.region
        required: false
        schema:
          type: string
      - description: Cloud service
        in: query
        name: cloud.service
        required: false
        schema:
          type: string
      - description: Policy ID
        in: query
        name: policy.id
        required: false
        schema:
          type: string
      - description: Policy name
        in: query
        name: policy.name
        required: false
        schema:
          type: string
      - description: Policy severity
        in: query
        name: policy.severity
        required: false
        schema:
          enum:
          - critical
          - high
          - medium
          - low
          - informational
          type: string
      - description: Policy label
        in: query
        name: policy.label
        required: false
        schema:
          type: string
      - description: Policy type
        in: query
        name: policy.type
        required: false
        schema:
          enum:
          - config
          - network
          - audit_event
          type: string
      - description: Policy compliance standard name
        in: query
        name: policy.complianceStandard
        required: false
        schema:
          type: string
      - description: Policy compliance requirement name
        in: query
        name: policy.complianceRequirement
        required: false
        schema:
          type: string
      - description: Policy compliance section ID
        in: query
        name: policy.complianceSection
        required: false
        schema:
          type: string
      - description: Policy is remediable
        in: query
        name: policy.remediable
        required: false
        schema:
          enum:
          - 'true'
          - 'false'
          type: string
      - description: Alert rule name
        in: query
        name: alertRule.name
        required: false
        schema:
          type: string
      - description: Resource ID
        in: query
        name: resource.id
        required: false
        schema:
          type: string
      - description: Resource name
        in: query
        name: resource.name
        required: false
        schema:
          type: string
      - description: Resource TYPE
        in: query
        name: resource.type
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagedResultsAlertModel'
          description: successful operation
        '400':
          description: internal_error
        '429':
          description: Too Many Requests
      security:
      - x-redlock-auth: []
      summary: List Alerts V2 - GET
      tags:
      - Alerts
    post:
      description: "Returns a paginated list of alerts that matches the constraints specified in the body parameters.  \n\nThe **fields** request body parameter allows you to request specific fields from the alert payload. \nThese fields are separate from the filters you specify. The following are valid **fields** items.\n\n* alert.id\n* alert.status\n* alert.time\n* cloud.account\n* cloud.accountId\n* cloud.region\n* resource.id\n* resource.name\n* policy.name\n* policy.type\n* policy.severity\n\nThe **filters** request body parameter enables you to narrow your request for alerts. See \n[List Alert Filters](/prisma-cloud/api/cspm/get-alert-filter-and-options) \nfor an API request to list all the valid filters.\n\nYou can find the valid values for the **sortBy** request body parameter in the response \nobject attribute **sortAllowedColumns**.\n\nData in the response object does not include alert rules.\n\nAlso, in the response object:\n\n* Property **riskDetail** is deprecated.\n* Property **items[].resource.cloudServiceName** is populated only for alerts whose resources belong to a cloud service.\n\nWhen `detailed` flag is set to **true**, following fields will be returned within the policy response object:\n\n- `complianceMetadata`\n- `name`\n- `description`\n- `labels`\n- `deleted`\n- `recommendation`\n- `lastModifiedBy`\n- `lastModifiedOn`\n- `severity`\n\n#### Rate Limits ####\n\nThe following rate limits apply:\n* Request rate limit: 2/sec \n* Burst limit: 10/sec \n"
      operationId: post-alerts-v2
      parameters:
      - description: true = Return detailed alert data. Default is false. Overrides **detailed** in body param.
        in: query
        name: detailed
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/FilterModel'
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/PagedResultsAlertModel'
          description: successful operation
        '400':
          description: internal_error
        '429':
          description: Too Many Requests
      security:
      - x-redlock-auth: []
      summary: List Alerts V2 - POST
      tags:
      - Alerts
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
    - url: https://api.anz.prismacloud.io
    - url: https://api.eu.prismacloud.io
    - url: https://api2.eu.prismacloud.io
    - url: https://api.gov.prismacloud.io
    - url: https://api.prismacloud.cn
    - url: https://api.ca.prismacloud.io
    - url: https://api.sg.prismacloud.io
    - url: https://api.uk.prismacloud.io
    - url: https://api.ind.prismacloud.io
    - url: https://api.jp.prismacloud.io
    - url: https://api.fr.prismacloud.io
  /alert/policy:
    get:
      description: "Returns alert counts grouped by policy. You can use query parameters to narrow the response.  \n\nIn the response object:\n\n* Property **alertRules** is not populated.         \n* Property **riskDetail** is deprecated.\n* Property **resource.cloudServiceName** is not populated.\n\n#### Rate Limits ####\n\nThe following rate limits apply:\n* Request rate limit: 1/sec \n* Burst limit: 5/sec        \n"
      operationId: get-alerts-grouped
      parameters:
      - description: Alert ID
        in: query
        name: alert.id
        required: false
        schema:
          type: string
      - description: Alert status
        in: query
        name: alert.status
        required: false
        schema:
          enum:
          - open
          - dismissed
          - snoozed
          - resolved
          - pending_resolution
          type: string
      - description: Cloud account
        in: query
        name: cloud.account
        required: false
        schema:
          type: string
      - description: Cloud account Id
        in: query
        name: cloud.accountId
        required: false
        schema:
          type: string
      - description: Account group
        in: query
        name: account.group
        required: false
        schema:
          type: string
      - description: Cloud type
        in: query
        name: cloud.type
        required: false
        schema:
          type: string
      - description: Cloud region
        in: query
        name: cloud.region
        required: false
        schema:
          type: string
      - description: Cloud service
        in: query
        name: cloud.service
        required: false
        schema:
          type: string
      - description: Policy ID
        in: query
        name: policy.id
        required: false
        schema:
          type: string
      - description: Policy name
        in: query
        name: policy.name
        required: false
        schema:
          type: string
      - description: Policy severity
        in: query
        name: policy.severity
        required: false
        schema:
          enum:
          - critical
          - high
          - medium
          - low
          - informational
          type: string
      - description: Policy label
        in: query
        name: policy.label
        required: false
        schema:
          type: string
      - description: Policy type
        in: query
        name: policy.type
        required: false
        schema:
          enum:
          - config
          - network
          - audit_event
          type: string
      - description: Policy compliance standard name
        in: query
        name: policy.complianceStandard
        required: false
        schema:
          type: string
      - description: Policy compliance requirement name
        in: query
        name: policy.complianceRequirement
        required: false
        schema:
          type: string
      - description: Policy compliance section ID
        in: query
        name: policy.complianceSection
        required: false
        schema:
          type: string
      - description: Policy is remediable
        in: query
        name: policy.remediable
        required: false
        schema:
          enum:
          - 'true'
          - 'false'
          type: string
      - description: Alert rule name
        in: query
        name: alertRule.name
        required: false
        schema:
          type: string
      - description: Resource ID
        in: query
        name: resource.id
        required: false
        schema:
          type: string
      - description: Resource name
        in: query
        name: resource.name
        required: false
        schema:
          type: string
      - description: Resource TYPE
        in: query
        name: resource.type
        required: false
        schema:
          type: string
      responses:
        '200':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/AlertModel'
                type: array
          description: successful operation
        '400':
          description: internal_error
        '429':
          description: Too Many Requests
      security:
      - x-redlock-auth: []
      summary: List Alert Counts By Policy - GET
      tags:
      - Alerts
    post:
      description: "Returns alert counts grouped by policy. You can use body parameters to narrow the response.  \n\nIn the response object:\n\n* Property **alertRules** is not populated.       \n* Property **riskDetail** is deprecated.\n* Property **resource.cloudServiceName** is not populated.\n\n#### Rate Limits ####\n\nThe following rate limits apply:\n* Request rate limit: 1/sec \n* Burst limit: 5/sec        \n"
      operationId: post-alerts-grouped
      parameters:
      - description: true = Return detailed alert data. Default is false. Overrides **detailed** in body param.
        in: query
        name: detailed
        required: false
        schema:
          type: boolean
      requestBody:
        content:
          application/json; charset=UTF-8:
            schema:
              $ref: '#/components/schemas/FilterModel'
        description: Model for Filter
        required: true
      responses:
        '200':
          content:
            '*/*':
              schema:
                items:
                  $ref: '#/components/schemas/AlertModel'
                type: array
          description: successful operation
        '400':
          description: internal_error
        '429':
          description: Too Many Requests
      security:
      - x-redlock-auth: []
      summary: List Alert Counts By Policy - POST
      tags:
      - Alerts
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
    - url: https://api.anz.prismacloud.io
    - url: https://api.eu.prismacloud.io
    - url: https://api2.eu.prismacloud.io
    - url: https://api.gov.prismacloud.io
    - url: https://api.prismacloud.cn
    - url: https://api.ca.prismacloud.io
    - url: https://api.sg.prismacloud.io
    - url: https://api.uk.prismacloud.io
    - url: https://api.ind.prismacloud.io
    - url: https://api.jp.prismacloud.io
    - url: https://api.fr.prismacloud.io
  /alert/{id}:
    get:
      description: "Returns information about an alert for the specified ID.  \n\nIn the response object, field **riskDetail** is deprecated.\n\nWhen `detailed` flag is set to **true**, following fields will be returned within the policy and response object:\n\n- `complianceMetadata`\n- `name`\n- `description`\n- `labels`\n- `deleted`\n- `recommendation`\n- `lastModifiedBy`\n- `lastModifiedOn`\n- `severity`\n\nThe `resource` response object will include `cloudAccountGroups` field when `detailed` is set to **true**\n\n#### Rate Limits ####\n\nThe following rate limits apply:\n* Request rate limit: 5/sec \n* Burst limit: 10/sec        \n"
      operationId: get-alert
      parameters:
      - description: Alert ID
        in: path
        name: id
        required: true
        schema:
          type: string
      - description: true = Return detailed alert data. Default is false.
        in: query
        name: detailed
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AlertModel'
          description: successful operation
        '400':
          description: internal_error/invalid_alert_id
        '404':
          description: not_found
        '429':
          description: Too Many Requests
      security:
      - x-redlock-auth: []
      summary: Alert Info
      tags:
      - Alerts
    servers:
    - url: https://api.prismacloud.io
    - url: https://api2.prismacloud.io
    - url: https://api3.prismacloud.io
    - url: https://api4.prismacloud.io
    - url: https://api.anz.prismacloud.io
    - url: https://api.eu.prismacloud.io
    - url: https://api2.eu.prismacloud.io
    - url: https://api.gov.prismacloud.io
    - url: https://api.prismacloud.cn
    - url: https://api.ca.prismacloud.io
    - url: https://api.sg.prismacloud.io
    - url: https://api.uk.prismacloud.io
    - url: https://api.ind.prismacloud.io
    - url: https://api.jp.prismacloud.io
    - url: https://api.fr.prismacloud.io
  /alert/dismiss:
    post:
      description: Dismisses one or more alerts on the Prisma Cloud platform. If the caller specifies a dismissal time range, then alerts will snooze for that time period rather than be dismissed.
      operationId: dismiss-alerts
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AlertStatusChangeRequestModel'
        description: Model for Alert Status Change Request
        required: true
      responses:
        '200':
          description: successful operation
        '400':
          description: missing_required_parameter / invalid_parameter_value / internal_error / violates_minimum_alert_dismiss_duration_time
        '403':
          description: permission_error
        '404':
          description: alert_no_longer_in_expected_state
      security:
      - x-redlock-auth: []
      summary: Dism

# --- truncated at 32 KB (169 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/palo-alto-networks/refs/heads/main/openapi/palo-alto-networks-alerts-api-openapi.yml