Palo Alto Networks Agentless API

openapi: 3.2.0
info:
  title: Palo Alto Networks Agentless API
  version: '1.0'
  description: 'Operations tagged Agentless 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: Agentless
  description: Agentless. 6 operations in this definition.
  x-description-source: desc/agentless/agentless.md
paths:
  /api/v34.03/agentless/max-scanners:
    post:
      description: 'AgentlessMaxScanners sets the maximum number of scanners for an agentless account specification

        '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.AgentlessScanMaxScannersOptions'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: post-agentless-max-scanners
      summary: ' Agentless Max Scanners'
  /api/v34.03/agentless/progress:
    get:
      description: 'View the Agentless Scan Progress. GET /api/v34.03/agentless/progress on the Agentless API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.Progress'
          description: ''
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: get-agentless-progress
      summary: View the Agentless Scan Progress
      x-description-source: desc/agentless/get_agentless_progress.md
  /api/v34.03/agentless/scan:
    post:
      description: 'Start Agentless Scan. POST /api/v34.03/agentless/scan on the Agentless API. Documented responses: 200.'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: post-agentless-scan
      summary: Start Agentless Scan
      x-description-source: desc/agentless/post_agentless_scan.md
  /api/v34.03/agentless/scan-statistics:
    get:
      description: 'AgentlessScanStatistics returns the agentless scan statistics

        '
      parameters:
      - description: 'Current indicates whether the current scan cycle statistics should be returned.

          '
        in: query
        name: current
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agentless.ScanStatisticsResponse'
          description: ScanStatisticsResponse represents the response structure for scan statistics
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: get-agentless-scan-statistics
      summary: ' Agentless Scan Statistics'
  /api/v34.03/agentless/stop:
    post:
      description: 'Stop an Ongoing Scan. POST /api/v34.03/agentless/stop on the Agentless API. Documented responses: 200.'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: post-agentless-stop
      summary: Stop an Ongoing Scan
      x-description-source: desc/agentless/post_agentless_stop.md
  /api/v34.03/agentless/templates:
    post:
      description: 'Download Agentless Permission Templates. POST /api/v34.03/agentless/templates on the Agentless API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.AgentlessResourceTemplatesRequest'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: post-agentless-templates
      summary: Download Agentless Permission Templates
      x-description-source: desc/agentless/post_agentless_templates.md
  /api/v34.04/agentless/max-scanners:
    post:
      description: 'AgentlessMaxScanners sets the maximum number of scanners for an agentless account specification

        '
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.AgentlessScanMaxScannersOptions'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: post-agentless-max-scanners
      summary: ' Agentless Max Scanners'
  /api/v34.04/agentless/progress:
    get:
      description: 'View the Agentless Scan Progress. GET /api/v34.04/agentless/progress on the Agentless API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/-_shared.Progress'
          description: ''
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: get-agentless-progress
      summary: View the Agentless Scan Progress
      x-description-source: desc/agentless/get_agentless_progress.md
  /api/v34.04/agentless/scan:
    post:
      description: 'Start Agentless Scan. POST /api/v34.04/agentless/scan on the Agentless API. Documented responses: 200.'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: post-agentless-scan
      summary: Start Agentless Scan
      x-description-source: desc/agentless/post_agentless_scan.md
  /api/v34.04/agentless/scan-statistics:
    get:
      description: 'AgentlessScanStatistics returns the agentless scan statistics

        '
      parameters:
      - description: 'Current indicates whether the current scan cycle statistics should be returned.

          '
        in: query
        name: current
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/agentless.ScanStatisticsResponse'
          description: ScanStatisticsResponse represents the response structure for scan statistics
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: get-agentless-scan-statistics
      summary: ' Agentless Scan Statistics'
  /api/v34.04/agentless/stop:
    post:
      description: 'Stop an Ongoing Scan. POST /api/v34.04/agentless/stop on the Agentless API. Documented responses: 200.'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: monitorHosts
      operationId: post-agentless-stop
      summary: Stop an Ongoing Scan
      x-description-source: desc/agentless/post_agentless_stop.md
  /api/v34.04/agentless/templates:
    post:
      description: 'Download Agentless Permission Templates. POST /api/v34.04/agentless/templates on the Agentless API. Takes an optional request body. Documented responses: 200.'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/types.AgentlessResourceTemplatesRequest'
      responses:
        '200':
          description: OK
        default:
          description: ''
      tags:
      - Agentless
      x-prisma-cloud-target-env:
        permission: manageCreds
      operationId: post-agentless-templates
      summary: Download Agentless Permission Templates
      x-description-source: desc/agentless/post_agentless_templates.md
components:
  schemas:
    cred.Type:
      description: Type specifies the credential type
      enum:
      - - aws
        - azure
        - gcp
        - ibmCloud
        - oci
        - apiToken
        - basic
        - dtr
        - kubeconfig
        - certificate
        - gitlabToken
      type: string
    agentless.ScannedAssets:
      description: ScannedAssets represents the scanned assets statistics
      properties:
        binaries:
          description: 'Binaries is the number of binaries scanned.

            '
          format: int64
          type: integer
        container_images:
          description: 'ContainerImages is the number of container images scanned.

            '
          format: int64
          type: integer
        linux_hosts:
          description: 'LinuxHosts is the number of Linux machines scanned.

            '
          format: int64
          type: integer
        windows_hosts:
          description: 'WindowsHosts is the number of Windows machines scanned.

            '
          format: int64
          type: integer
      type: object
    agentless.SnapshotCreationTime:
      description: SnapshotCreationTime represents the snapshot creation time statistics
      properties:
        avg_sec:
          description: 'AvgSec is the average duration in seconds per snapshot creation.

            '
          format: double
          type: number
        longest_sec:
          description: 'LongestSec is the longest duration in seconds spent creating a single snapshot.

            '
          format: int64
          type: integer
        total_sec:
          description: 'TotalSec is the total duration in seconds spent creating snapshots.

            '
          format: int64
          type: integer
      type: object
    types.AgentlessResourceTemplatesRequest:
      description: 'AgentlessResourceTemplatesRequest is the agentless resource templates request for populating

        templates that are needed to be applied prior to an agentless scan with the credential'
      properties:
        awsRegionType:
          $ref: '#/components/schemas/shared.RegionType'
        credential:
          $ref: '#/components/schemas/cred.Credential'
        credentialID:
          description: '(Required) Specifies the ID for which the templates are generated.

            '
          type: string
      type: object
    agentless.DiskSize:
      description: DiskSize represents the disk size statistics
      properties:
        avg_gb:
          description: 'AvgGB is the average size in GB across all scanned disks.

            '
          format: double
          type: number
        largest_gb:
          description: 'LargestGB is the size in GB of the largest scanned disk.

            '
          format: int64
          type: integer
        total_gb:
          description: 'TotalGB is the total size in GB of all scanned disks.

            '
          format: int64
          type: integer
      type: object
    agentless.RegionStatistics:
      description: RegionStatistics represents the scan statistics for a region
      properties:
        avg_batch_size_per_scanner:
          description: 'AvgBatchSizePerScanner is the average batch size per scanner.

            '
          format: double
          type: number
        deployed_scanners:
          $ref: '#/components/schemas/agentless.DeployedScanners'
        disk_size:
          $ref: '#/components/schemas/agentless.DiskSize'
        region_id:
          description: 'RegionID is the ID of the region.

            '
          type: string
        scanned_assets:
          $ref: '#/components/schemas/agentless.ScannedAssets'
        snapshot_creation_time:
          $ref: '#/components/schemas/agentless.SnapshotCreationTime'
        snapshot_scan_time:
          $ref: '#/components/schemas/agentless.SnapshotScanTime'
        total_scan_time_sec:
          description: 'TotalScanTimeSec Total scan time in seconds (including cleanup time).

            '
          format: int64
          type: integer
      type: object
    agentless.SnapshotScanTime:
      description: SnapshotScanTime represents the snapshot scan time statistics
      properties:
        avg_sec:
          description: 'AvgSec is the average duration in seconds per snapshot scan.

            '
          format: double
          type: number
        longest_sec:
          description: 'LongestSec is the longest duration in seconds spent scanning a single snapshot.

            '
          format: int64
          type: integer
        total_sec:
          description: 'TotalSec is the total duration in seconds spent scanning snapshots.

            '
          format: int64
          type: integer
      type: object
    cred.AzureSPInfo:
      description: AzureSPInfo contains the Azure credentials needed for certificate based authentications
      properties:
        clientId:
          description: 'ClientID is the client identifier.

            '
          type: string
        miType:
          $ref: '#/components/schemas/cred.AzureMIType'
        subscriptionId:
          description: 'SubscriptionID is a GUID that uniquely identifies the subscription to use Azure services.

            '
          type: string
        tenantId:
          description: 'TenantID is the ID of the AAD directory in which the application was created.

            '
          type: string
      type: object
    agentless.DeployedScanners:
      description: DeployedScanners represents the deployed scanner statistics
      properties:
        ondemand:
          description: 'Ondemand is the number of on-demand scanner instances deployed.

            '
          format: int64
          type: integer
        spot:
          description: 'Spot is the number of spot scanner instances deployed.

            '
          format: int64
          type: integer
      type: object
    -_shared.Progress:
      items:
        $ref: '#/components/schemas/shared.Progress'
      type: array
    agentless.ScanStatisticsResponse:
      description: ScanStatisticsResponse represents the response structure for scan statistics
      properties:
        accounts:
          description: 'Accounts holds scan statistics per cloud account.

            '
          items:
            $ref: '#/components/schemas/agentless.AccountStatistics'
          type: array
        total_scan_time_sec:
          description: 'TotalScanTimeSec is the total scan time in seconds.

            '
          format: int64
          type: integer
        update_time:
          description: 'UpdateTime represents the time of statistics update (ISO 8601 format).

            '
          format: date-time
          type: string
      type: object
    string:
      type: string
    common.Secret:
      description: Secret Stores the plain and encrypted version of a value. The plain version is not stored in a database
      properties:
        encrypted:
          description: 'Specifies an encrypted value of the secret.

            '
          type: string
        plain:
          description: 'Specifies the plain text value of the secret.

            '
          type: string
      type: object
    shared.Progress:
      description: Progress displays the scan progress
      properties:
        aisInitialScanInProgress:
          description: 'AISInitialScanInProgress indicates whether agentless next-gen first scheduled scan is in progress.

            '
          type: boolean
        aisOnDemandScanInProgress:
          description: 'AISOnDemandScanInProgress indicates whether agentless next-gen on demand scan is in progress.

            '
          type: boolean
        discovery:
          description: 'Discovery indicates whether the scan is in discovery phase.

            '
          type: boolean
        error:
          description: 'Error is the error that happened during scan.

            '
          type: string
        hostname:
          description: 'Hostname is the hostname for which the progress apply.

            '
          type: string
        id:
          description: 'ID is the ID of the entity being scanned.

            '
          type: string
        onDemand:
          description: 'OnDemand indicates whether the scan was triggered by the user or not (scheduled scan).

            '
          type: boolean
        scanTime:
          description: 'ScanTime is the time of scan.

            '
          format: date-time
          type: string
        scanned:
          description: 'Scanned is the number of entities for which the scan completed.

            '
          type: integer
        title:
          description: 'Title is the progress title (set by the scanning process).

            '
          type: string
        total:
          description: 'Total is the total amount of entities that should be scanned.

            '
          type: integer
        type:
          $ref: '#/components/schemas/shared.ScanType'
      type: object
    shared.RegionType:
      description: RegionType specifies the region type that runs the Amazon services
      enum:
      - - regular
        - gov
        - china
        - all
      type: string
    cred.TemporaryToken:
      description: 'TemporaryToken is a temporary session token for cloud provider APIs

        AWS - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_temp.html

        GCP - https://cloud.google.com/iam/docs/creating-short-lived-service-account-credentials

        Azure - https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/what-is-single-sign-on'
      properties:
        awsAccessKeyId:
          description: 'Specifies a temporary access key.

            '
          type: string
        awsSecretAccessKey:
          $ref: '#/components/schemas/common.Secret'
        duration:
          description: 'Specifies a duration for the token.

            '
          format: int64
          type: integer
        expirationTime:
          description: 'Specifies an expiration time for the token.

            '
          format: date-time
          type: string
        token:
          $ref: '#/components/schemas/common.Secret'
      type: object
    shared.ScanType:
      description: ScanType displays the components for an ongoing scan
      enum:
      - - image
        - ciImage
        - container
        - host
        - agentlessHost
        - registry
        - serverlessScan
        - ciServerless
        - vm
        - tas
        - ciTas
        - cloudDiscovery
        - serverlessRadar
        - serverlessAutoDeploy
        - hostAutoDeploy
        - codeRepo
        - ciCodeRepo
      type: string
    cred.AzureMIType:
      enum:
      - - user-assigned
        - system-assigned
      type: string
    cred.OCICred:
      description: OCICred are additional parameters required for OCI credentials
      properties:
        fingerprint:
          description: 'Fingerprint is the public key signature.

            '
          type: string
        tenancyId:
          description: 'TenancyID is the OCID of the tenancy.

            '
          type: string
      type: object
    types.AgentlessScanMaxScannersOptions:
      description: AgentlessScanMaxScannersOptions holds query options for setting max agentless scanners
      properties:
        account_id:
          description: 'AccountID is the ID of the account to set the max number of scanners.

            '
          type: string
        auto_scale:
          description: 'AutoScale sets maximum number of scanners for the account to auto scale (takes precedence when true).

            '
          type: boolean
        max_scanners:
          description: 'MaxScanners is the maximum number of scanners to be set for the account.

            '
          type: integer
      type: object
    cred.Credential:
      description: Credential specifies the authentication data of an external provider
      properties:
        _id:
          description: 'Specifies the unique ID for credential.

            '
          type: string
        accountGUID:
          description: 'Specifies the unique ID for an IBM Cloud account.

            '
          type: string
        accountID:
          description: 'Specifies the account identifier. Example: a username, access key, account GUID, and so on.

            '
          type: string
        accountName:
          description: 'Specifies the name of the cloud account.

            '
          type: string
        apiToken:
          $ref: '#/components/schemas/common.Secret'
        azureSPInfo:
          $ref: '#/components/schemas/cred.AzureSPInfo'
        caCert:
          description: 'Specifies the CA certificate for a certificate-based authentication.

            '
          type: string
        cloudProviderAccountID:
          description: 'Specifies the cloud provider account ID.

            '
          type: string
        created:
          description: 'Specifies the time when the credential was created (or, when the account ID was changed for AWS).

            '
          format: date-time
          type: string
        description:
          description: 'Specifies the description for a credential.

            '
          type: string
        external:
          description: 'Indicates whether the credential was onboarded from the Prisma platform.

            '
          type: boolean
        global:
          description: 'Indicates whether the credential scope is global.

            Available values are:

            true: Global

            false: Not Global

            Note: For GCP, the credential scope is the organization.

            '
          type: boolean
        lastModified:
          description: 'Specifies the time when the credential was last modified.

            '
          format: date-time
          type: string
        ociCred:
          $ref: '#/components/schemas/cred.OCICred'
        owner:
          description: 'Specifies the user who created or modified the credential.

            '
          type: string
        prismaLastModified:
          description: 'Specifies the time when the account was last modified by Prisma Cloud Compute.

            '
          format: int64
          type: integer
        roleArn:
          description: 'Specifies the Amazon Resource Name (ARN) of the role to be assumed.

            '
          type: string
        secret:
          $ref: '#/components/schemas/common.Secret'
        skipVerify:
          description: 'Indicates whether to skip the certificate verification in TLS communication.

            '
          type: boolean
        stsEndpoints:
          description: 'Specifies a list of specific endpoints for use in STS sessions in various regions.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        tokens:
          $ref: '#/components/schemas/cred.TemporaryToken'
        type:
          $ref: '#/components/schemas/cred.Type'
        url:
          description: 'Specifies the base server URL.

            '
          type: string
        useAWSRole:
          description: 'Indicates whether to authenticate using the IAM Role attached to the instance.

            Available values are:

            true: Authenticate with the attached credentials

            false: Don’t authenticate with the attached credentials.

            '
          type: boolean
        useSTSRegionalEndpoint:
          description: 'Indicates whether to use the regional STS endpoint for an STS session.

            Available values are:

            true: Use the regional STS

            false: Don’t use the regional STS.

            '
          type: boolean
      type: object
    agentless.AccountStatistics:
      description: AccountStatistics represents the scan statistics for an account
      properties:
        account_id:
          description: 'AccountID is the ID of the account.

            '
          type: string
        cloud_provider:
          description: 'CloudProvider is the cloud provider of the account.

            '
          type: string
        configured_max_scanners:
          description: 'ConfiguredMaxScanners is the maximum number of scanners configured for the account.

            '
          format: int64
          type: integer
        regions:
          description: 'Regions holds the scan statistics per region.

            '
          items:
            $ref: '#/components/schemas/agentless.RegionStatistics'
          type: array
        scan_end_time:
          description: 'ScanEndTime holds the account scan end timestamp.

            '
          format: date-time
          type: string
        scan_start_time:
          description: 'ScanStartTime holds the account scan start timestamp.

            '
          format: date-time
          type: string
        total_scan_time_sec:
          description: 'TotalScanTimeSec is the total scan time in seconds.

            '
          format: int64
          type: integer
      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