Palo Alto Networks Notification Templates API

Notification templates allow you to configure notifications about the Prisma Cloud alerts to: * Email * ServiceNow * Jira

Operations 6

GET /api/v1/tenant/{prismaId}/template List Templates #
POST /api/v1/tenant/{prismaId}/template Add Template #
GET /api/v1/tenant/{prismaId}/template/{id} Get Template by ID #
PATCH /api/v1/tenant/{prismaId}/template/{id} Update Template #
DELETE /api/v1/tenant/{prismaId}/template/{id} Delete Template #
POST /api/v1/tenant/{prismaId}/template/test Test Template #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/palo-alto-networks-notification-templates-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

palo-alto-networks-notification-templates-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  contact: {}
  description: 'Access Keys are a secure way to enable programmatic access to the Prisma Cloud API. By default, only

    the System Admin has API access and can enable API access for other administrators. If you have API access,

    you can create up to two access keys. Create an access key for a limited time period and regenerate your API

    keys periodically to minimize exposure and follow security best practices.'
  title: Prisma Cloud Access Keys API Overview Notification…
  version: Latest
servers:
- url: https://api.prismacloud.io
- url: https://api2.prismacloud.io
- url: https://api3.prismacloud.io
- url: https://api4.prismacloud.io
tags:
- description: 'Notification templates allow you to configure notifications about the Prisma Cloud alerts to:


    * Email

    * ServiceNow

    * Jira'
  name: Notification Templates
paths:
  /api/v1/tenant/{prismaId}/template:
    get:
      description: 'Returns a list of notification templates.


        The caller must have one of the following Prisma Cloud roles:


        * System Admin

        * Account Group Admin

        * Account and Cloud Provisioning Admin

        * Account Group Read Only'
      operationId: get-all-templates-v1
      parameters:
      - description: "Prisma ID. Your Prisma ID is available either from the response object of your \n[API request to log in](/prisma-cloud/api/cspm/app-login) or \nfrom the licensing information in the Prisma Cloud console.\n"
        in: path
        name: prismaId
        required: true
        schema:
          type: string
      - description: Comma-separated list of Template IDs
        in: query
        name: id
        required: false
        schema:
          items:
            type: string
          type: array
      - description: "Comma-separated list of integration types that support notification templates. \nValid values: \n\n* email\n* jira\n* service_now\n"
        in: query
        name: type
        required: false
        schema:
          items:
            type: string
          type: array
      - in: query
        description: true = Enabled
        name: enabled
        required: false
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/EventsNotificationTemplate'
                type: array
          description: OK
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsApiError'
          description: default response
      security:
      - x-redlock-auth: []
      summary: List Templates
      tags:
      - Notification Templates
    post:
      description: 'Creates a notification template.

        The caller must have one of the following Prisma Cloud roles:


        * System Admin

        * Account and Cloud Provisioning Admin'
      operationId: create-template-v1
      parameters:
      - description: "Prisma ID. Your Prisma ID is available either from the response object of your \n[API request to log in](/prisma-cloud/api/cspm/app-login) or \nfrom the licensing information in the Prisma Cloud console.\n"
        in: path
        name: prismaId
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventsCreateTemplateRequest'
        required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsNotificationTemplate'
          description: OK
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsApiError'
          description: default response
      security:
      - x-redlock-auth: []
      summary: Add Template
      tags:
      - Notification Templates
  /api/v1/tenant/{prismaId}/template/{id}:
    get:
      description: 'Returns the notification template with the specified ID.


        The caller must have one of the following Prisma Cloud roles:


        * System Admin

        * Account Group Admin

        * Account and Cloud Provisioning Admin

        * Account Group Read Only'
      operationId: get-template-v1
      parameters:
      - description: "Prisma ID. Your Prisma ID is available either from the response object of your \n[API request to log in](/prisma-cloud/api/cspm/app-login) or \nfrom the licensing information in the Prisma Cloud console.\n"
        in: path
        name: prismaId
        required: true
        schema:
          type: string
      - description: Template Id
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsNotificationTemplate'
          description: OK
        '429':
          description: Too many requests
        '500':
          description: Internal server error
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsApiError'
          description: default response
      security:
      - x-redlock-auth: []
      summary: Get Template by ID
      tags:
      - Notification Templates
    patch:
      description: 'Updates the template with the specified ID.

        The caller must have one of the following Prisma Cloud roles:


        * System Admin

        * Account and Cloud Provisioning Admin'
      operationId: update-template-v1
      parameters:
      - description: "Prisma ID. Your Prisma ID is available either from the response object of your \n[API request to log in](/prisma-cloud/api/cspm/app-login) or \nfrom the licensing information in the Prisma Cloud console.\n"
        in: path
        name: prismaId
        required: true
        schema:
          type: string
      - description: Template ID
        in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventsNotificationTemplate'
        required: true
      responses:
        '200':
          description: OK
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsApiError'
          description: default response
      security:
      - x-redlock-auth: []
      summary: Update Template
      tags:
      - Notification Templates
    delete:
      description: 'Deletes a template with the specified ID.


        The caller must have one of the following Prisma Cloud roles:


        * System Admin

        * Account and Cloud Provisioning Admin'
      operationId: delete-template-v1
      parameters:
      - description: "Prisma ID. Your Prisma ID is available either from the response object of your \n[API request to log in](/prisma-cloud/api/cspm/app-login) or \nfrom the licensing information in the Prisma Cloud console.\n"
        in: path
        name: prismaId
        required: true
        schema:
          type: string
      - description: Template Id
        in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsApiError'
          description: default response
      security:
      - x-redlock-auth: []
      summary: Delete Template
      tags:
      - Notification Templates
  /api/v1/tenant/{prismaId}/template/test:
    post:
      description: 'Runs a test of the notification template for the specified data.


        The caller must have one of the following Prisma Cloud roles:


        * System Admin

        * Account and Cloud Provisioning Admin'
      operationId: test-template-v1
      parameters:
      - description: "Prisma ID. Your Prisma ID is available either from the response object of your \n[API request to log in](/prisma-cloud/api/cspm/app-login) or \nfrom the licensing information in the Prisma Cloud console.\n"
        in: path
        name: prismaId
        required: true
        schema:
          type: string
      - description: Template ID
        in: query
        name: id
        required: false
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EventsTestTemplateRequest'
        required: true
      responses:
        '200':
          description: OK
        '429':
          description: Too Many Requests
        '500':
          description: Internal Server Error
        4XX:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EventsApiError'
          description: default response
      security:
      - x-redlock-auth: []
      summary: Test Template
      tags:
      - Notification Templates
components:
  schemas:
    EventsNotificationFieldsConfig:
      properties:
        aliasField:
          description: Alias field
          type: string
        displayName:
          description: Display name
          type: string
        fieldName:
          description: Field name
          type: string
        maxLength:
          description: Maximum length
          format: int32
          type: integer
        options:
          items:
            $ref: '#/components/schemas/EventsFieldConfigOption'
          type: array
        redlockMapping:
          description: true = Prisma Cloud will provide the field value for notification
          type: boolean
        required:
          description: true = Required
          type: boolean
        type:
          description: Type of field
          enum:
          - list
          - text
          - array
          - bool
          - integer
          type: string
        typeaheadUri:
          description: URL used to query suggestions for field value
          type: string
        value:
          description: Field value
          type: string
      type: object
    EventsTestTemplateRequest:
      properties:
        integrationId:
          description: Integration ID
          type: string
        integrationType:
          description: Integration type
          enum:
          - email
          - jira
          - service_now
          type: string
        name:
          description: Template name
          type: string
        templateConfig:
          additionalProperties:
            description: Template Config
            items:
              $ref: '#/components/schemas/EventsNotificationFieldsConfig'
            type: array
          description: Template Config
          type: object
      required:
      - integrationId
      - integrationType
      - name
      - templateConfig
      type: object
    EventsNotificationTemplate:
      properties:
        createdBy:
          description: User who created the notification template
          type: string
        createdTs:
          description: Creation Unix timestamp in milliseconds
          format: int64
          type: integer
        enabled:
          description: true = Enabled
          type: boolean
        id:
          description: Notification template ID
          type: string
        integrationId:
          description: Integration ID
          type: string
        integrationType:
          description: Integration type
          enum:
          - email
          - jira
          - service_now
          type: string
        lastModifiedBy:
          description: User who modified template last
          type: string
        lastModifiedTs:
          description: Modification Unix timestamp in milliseconds
          format: int64
          type: integer
        name:
          description: 'Name. Cannot include special characters (''<'', ''>'', ''!'', ''='', ''\n'', ''\r''). Maximum length is 99.

            '
          type: string
        templateConfig:
          additionalProperties:
            items:
              $ref: '#/components/schemas/EventsNotificationFieldsConfig'
            type: array
          type: object
      required:
      - customerId
      - integrationType
      - name
      type: object
    EventsApiError:
      properties:
        debugMessage:
          type: string
        message:
          type: string
        status:
          enum:
          - 100 CONTINUE
          - 101 SWITCHING_PROTOCOLS
          - 102 PROCESSING
          - 103 CHECKPOINT
          - 200 OK
          - 201 CREATED
          - 202 ACCEPTED
          - 203 NON_AUTHORITATIVE_INFORMATION
          - 204 NO_CONTENT
          - 205 RESET_CONTENT
          - 206 PARTIAL_CONTENT
          - 207 MULTI_STATUS
          - 208 ALREADY_REPORTED
          - 226 IM_USED
          - 300 MULTIPLE_CHOICES
          - 301 MOVED_PERMANENTLY
          - 302 FOUND
          - 302 MOVED_TEMPORARILY
          - 303 SEE_OTHER
          - 304 NOT_MODIFIED
          - 305 USE_PROXY
          - 307 TEMPORARY_REDIRECT
          - 308 PERMANENT_REDIRECT
          - 400 BAD_REQUEST
          - 401 UNAUTHORIZED
          - 402 PAYMENT_REQUIRED
          - 403 FORBIDDEN
          - 404 NOT_FOUND
          - 405 METHOD_NOT_ALLOWED
          - 406 NOT_ACCEPTABLE
          - 407 PROXY_AUTHENTICATION_REQUIRED
          - 408 REQUEST_TIMEOUT
          - 409 CONFLICT
          - 410 GONE
          - 411 LENGTH_REQUIRED
          - 412 PRECONDITION_FAILED
          - 413 PAYLOAD_TOO_LARGE
          - 413 REQUEST_ENTITY_TOO_LARGE
          - 414 URI_TOO_LONG
          - 414 REQUEST_URI_TOO_LONG
          - 415 UNSUPPORTED_MEDIA_TYPE
          - 416 REQUESTED_RANGE_NOT_SATISFIABLE
          - 417 EXPECTATION_FAILED
          - 418 I_AM_A_TEAPOT
          - 419 INSUFFICIENT_SPACE_ON_RESOURCE
          - 420 METHOD_FAILURE
          - 421 DESTINATION_LOCKED
          - 422 UNPROCESSABLE_ENTITY
          - 423 LOCKED
          - 424 FAILED_DEPENDENCY
          - 425 TOO_EARLY
          - 426 UPGRADE_REQUIRED
          - 428 PRECONDITION_REQUIRED
          - 429 TOO_MANY_REQUESTS
          - 431 REQUEST_HEADER_FIELDS_TOO_LARGE
          - 451 UNAVAILABLE_FOR_LEGAL_REASONS
          - 500 INTERNAL_SERVER_ERROR
          - 501 NOT_IMPLEMENTED
          - 502 BAD_GATEWAY
          - 503 SERVICE_UNAVAILABLE
          - 504 GATEWAY_TIMEOUT
          - 505 HTTP_VERSION_NOT_SUPPORTED
          - 506 VARIANT_ALSO_NEGOTIATES
          - 507 INSUFFICIENT_STORAGE
          - 508 LOOP_DETECTED
          - 509 BANDWIDTH_LIMIT_EXCEEDED
          - 510 NOT_EXTENDED
          - 511 NETWORK_AUTHENTICATION_REQUIRED
          type: string
        subErrors:
          items:
            $ref: '#/components/schemas/EventsApiSubError'
          type: array
        timestamp:
          format: int64
          type: integer
      type: object
    EventsCreateTemplateRequest:
      properties:
        integrationId:
          description: Integration Id
          example: 123e4567-e89b-42d3-a456-55664244
          type: string
        integrationType:
          description: Integration type
          enum:
          - email
          - jira
          - service_now
          example: email
          type: string
        name:
          description: Template name
          example: sample-template
          maxLength: 100
          minLength: 5
          pattern: ^[A-Za-z0-9](.){0,99}$
          type: string
        templateConfig:
          additionalProperties:
            description: Template configuration
            items:
              $ref: '#/components/schemas/EventsNotificationFieldsConfig'
            type: array
          description: Template config
          type: object
      required:
      - integrationType
      - name
      - templateConfig
      type: object
    EventsApiSubError:
      type: object
    EventsFieldConfigOption:
      properties:
        id:
          description: Field option ID
          type: string
        key:
          description: Field option key
          type: string
        name:
          description: Field option name
          type: string
      type: object
  securitySchemes:
    x-redlock-auth:
      description: The x-redlock-auth value is a JSON Web Token (JWT).
      in: header
      name: x-redlock-auth
      type: apiKey