Palo Alto Networks Custom Compliance API

openapi: 3.2.0
info:
  title: Palo Alto Networks Custom Compliance API
  version: '1.0'
  description: 'Operations tagged Custom-Compliance across 4 of this provider''s published API definitions: palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json, palo-alto-compute-openapi-34-04-145-sh-openapi.json, palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json, palo-alto-cwpp-openapi-34-04-145-saas-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: PATH_TO_CONSOLE
tags:
- name: Custom-Compliance
  description: Custom-Compliance. 3 operations in this definition.
  x-description-source: desc/custom-compliance/custom-compliance.md
paths:
  /api/v34.03/custom-compliance:
    get:
      description: 'Get Custom Compliance Checks. GET /api/v34.03/custom-compliance on the Custom-Compliance API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.CustomComplianceCheck'
          description: ''
        default:
          description: ''
      tags:
      - Custom-Compliance
      x-prisma-cloud-target-env:
        permission: policyComplianceCustomRules
      operationId: get-custom-compliance
      summary: Get Custom Compliance Checks
      x-description-source: desc/custom-compliance/get.md
    put:
      description: 'Update Custom Compliance Checks. PUT /api/v34.03/custom-compliance on the Custom-Compliance API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shared.CustomComplianceCheck'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared.CustomComplianceCheck'
          description: CustomComplianceCheck represents a custom compliance check entry
        default:
          description: ''
      tags:
      - Custom-Compliance
      x-prisma-cloud-target-env:
        permission: policyComplianceCustomRules
      operationId: put-custom-compliance
      summary: Update Custom Compliance Checks
      x-description-source: desc/custom-compliance/put.md
  /api/v34.03/custom-compliance/{id}:
    delete:
      description: 'Delete a Custom Compliance Check. DELETE /api/v34.03/custom-compliance/{id} on the Custom-Compliance API. Takes 1 path parameter. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Custom-Compliance
      x-prisma-cloud-target-env:
        permission: policyComplianceCustomRules
      operationId: delete-custom-compliance-id
      summary: Delete a Custom Compliance Check
      x-description-source: desc/custom-compliance/id_delete.md
  /api/v34.04/custom-compliance:
    get:
      description: 'Get Custom Compliance Checks. GET /api/v34.04/custom-compliance on the Custom-Compliance API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.CustomComplianceCheck'
          description: ''
        default:
          description: ''
      tags:
      - Custom-Compliance
      x-prisma-cloud-target-env:
        permission: policyComplianceCustomRules
      operationId: get-custom-compliance
      summary: Get Custom Compliance Checks
      x-description-source: desc/custom-compliance/get.md
    put:
      description: 'Update Custom Compliance Checks. PUT /api/v34.04/custom-compliance on the Custom-Compliance API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/shared.CustomComplianceCheck'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared.CustomComplianceCheck'
          description: CustomComplianceCheck represents a custom compliance check entry
        default:
          description: ''
      tags:
      - Custom-Compliance
      x-prisma-cloud-target-env:
        permission: policyComplianceCustomRules
      operationId: put-custom-compliance
      summary: Update Custom Compliance Checks
      x-description-source: desc/custom-compliance/put.md
  /api/v34.04/custom-compliance/{id}:
    delete:
      description: 'Delete a Custom Compliance Check. DELETE /api/v34.04/custom-compliance/{id} on the Custom-Compliance API. Takes 1 path parameter. Documented responses: 200.'
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Custom-Compliance
      x-prisma-cloud-target-env:
        permission: policyComplianceCustomRules
      operationId: delete-custom-compliance-id
      summary: Delete a Custom Compliance Check
      x-description-source: desc/custom-compliance/id_delete.md
components:
  schemas:
    -_shared.CustomComplianceCheck:
      items:
        $ref: '#/components/schemas/shared.CustomComplianceCheck'
      type: array
    shared.CustomComplianceCheck:
      description: CustomComplianceCheck represents a custom compliance check entry
      properties:
        _id:
          description: 'ID is the compliance check ID.

            '
          type: integer
        disabled:
          description: 'Indicates whether the rule is currently disabled. Values: true (disabled) or false (enabled).

            '
          type: boolean
        modified:
          description: 'Specifies the date and time when the rule was last modified.

            '
          format: date-time
          type: string
        name:
          description: 'Name of the rule.

            '
          type: string
        notes:
          description: 'Describes any noteworthy points for a rule. You can include any text.

            '
          type: string
        owner:
          description: 'User who created or last modified the rule.

            '
          type: string
        previousName:
          description: 'Previous name of the rule. Required for rule renaming.

            '
          type: string
        script:
          description: 'Script is the custom check script.

            '
          type: string
        severity:
          description: 'Severity is the custom check defined severity.

            '
          type: string
        title:
          description: 'Title is the custom check title.

            '
          type: string
      type: object
x-refined-from:
- palo-alto-compute-34-03-openapi-34-03-138-sh-openapi.json
- palo-alto-compute-openapi-34-04-145-sh-openapi.json
- palo-alto-cwpp-34-03-openapi-34-03-138-saas-openapi.json
- palo-alto-cwpp-openapi-34-04-145-saas-openapi.json