Palo Alto Networks Log Profile API

openapi: 3.2.0
info:
  contact: {}
  description: "Log entries contain properties, activities, or behaviors associated with the logged event, such as the application type or the IP address of an attacker.  \n\nCloud NGFW can captures threat, traffic, and decryption profiles. For more information, see [Configure logging for Cloud NGFW on AWS](https://docs.paloaltonetworks.com/cloud-ngfw/aws/cloud-ngfw-on-aws/create-cloud-ngfw-instances-and-endpoints/configure-logging-for-the-cloud-ngfw-on-aws).\n\n### Permission Policies\n\n| Action                         | Local Firewall Administrator  | Local Rulestack Administrator | Global Rulestack Administrator |\n| ------------------------------ | :---------------------------: | :---------------------------: | :----------------------------: |\n| Update Log Profile             | **☑**                   | ☐                       | ☐                        |\n| Read Log Profile               | **☑**                   | **☑**                   | **☑**                    | \n"
  title: Manage Log Profiles Log Profile API
  version: 1.0.0
servers:
- url: https://api.us-east-1.aws.cloudngfw.paloaltonetworks.com
tags:
- name: LogProfile
paths:
  /v1/config/ngfirewalls/{ngfirewallname}/logprofile:
    get:
      description: 'Retrieve the log destination for a specific NGFW.

        '
      operationId: get-v1-config-ngfirewalls-ngfirewallname-logprofile
      parameters:
      - description: 'The name of the NGFW.

          '
        in: path
        name: ngfirewallname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ReadFWResourceLogProfileRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ReadFWResourceLogProfileResponse'
          description: OK
      summary: Retrieve log profile
      tags:
      - LogProfile
    put:
      description: 'Update the log destination for a specific NGFW. The destination is Fluentd; commit is not required.

        '
      operationId: put-v1-config-ngfirewalls-ngfirewallname-logprofile
      parameters:
      - description: 'The name of the NGFW.

          '
        in: path
        name: ngfirewallname
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateFWResourceLogProfileRequest'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateFWResourceLogProfileResponse'
          description: OK
      summary: Update log profile
      tags:
      - LogProfile
components:
  schemas:
    UpdateFWResourceLogProfileRequest.LogProfileConfig:
      additionalProperties: false
      properties:
        LogDestination:
          title: Logdestination
          type: string
        LogDestinationType:
          title: Logdestinationtype
          type: string
        LogType:
          title: Logtype
          type: string
      required:
      - LogDestination
      - LogDestinationType
      - LogType
      title: LogProfileConfig
      type: object
    ReadFWResourceLogProfileResponse.ResponseData:
      properties:
        AccountId:
          title: Accountid
          type: string
        CloudWatchMetricNamespace:
          title: Cloudwatchmetricnamespace
          type: string
        FirewallName:
          title: Firewallname
          type: string
        LogDestinationConfigs:
          items:
            $ref: '#/components/schemas/ReadFWResourceLogProfileResponse.LogProfileConfig'
          title: Logdestinationconfigs
          type: array
      title: ResponseData
      type: object
    ReadFWResourceLogProfileResponse.LogProfileConfig:
      additionalProperties: false
      properties:
        LogDestination:
          title: Logdestination
          type: string
        LogDestinationType:
          title: Logdestinationtype
          type: string
        LogType:
          title: Logtype
          type: string
      required:
      - LogDestination
      - LogDestinationType
      - LogType
      title: LogProfileConfig
      type: object
    UpdateFWResourceLogProfileResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/UpdateFWResourceLogProfileResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/UpdateFWResourceLogProfileResponse.Result'
      title: UpdateFWResourceLogProfileResponse
      type: object
    UpdateFWResourceLogProfileResponse.LogProfileConfig:
      additionalProperties: false
      properties:
        LogDestination:
          title: Logdestination
          type: string
        LogDestinationType:
          title: Logdestinationtype
          type: string
        LogType:
          title: Logtype
          type: string
      required:
      - LogDestination
      - LogDestinationType
      - LogType
      title: LogProfileConfig
      type: object
    UpdateFWResourceLogProfileRequest:
      additionalProperties: false
      properties:
        AccountId:
          title: Accountid
          type: string
        LogDestinationConfigs:
          items:
            $ref: '#/components/schemas/UpdateFWResourceLogProfileRequest.LogProfileConfig'
          title: Logdestinationconfigs
          type: array
      required:
      - LogDestinationConfigs
      title: UpdateFWResourceLogProfileRequest
      type: object
    ReadFWResourceLogProfileResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    UpdateFWResourceLogProfileResponse.Result:
      additionalProperties: false
      properties:
        ErrorCode:
          default: 0
          title: Errorcode
          type: integer
        Reason:
          title: Reason
          type: string
      title: Result
      type: object
    ReadFWResourceLogProfileResponse:
      additionalProperties: false
      properties:
        Response:
          $ref: '#/components/schemas/ReadFWResourceLogProfileResponse.ResponseData'
        ResponseStatus:
          $ref: '#/components/schemas/ReadFWResourceLogProfileResponse.Result'
      title: ReadFWResourceLogProfileResponse
      type: object
    UpdateFWResourceLogProfileResponse.ResponseData:
      properties:
        FirewallName:
          title: Firewallname
          type: string
        LogDestinationConfigs:
          items:
            $ref: '#/components/schemas/UpdateFWResourceLogProfileResponse.LogProfileConfig'
          title: Logdestinationconfigs
          type: array
      title: ResponseData
      type: object
    ReadFWResourceLogProfileRequest:
      additionalProperties: false
      properties:
        AccountId:
          title: Accountid
          type: string
      required:
      - AccountId
      title: ReadFWResourceLogProfileRequest
      type: object