Palo Alto Networks Statuses API

{'$ref': 'desc/statuses/statuses.md'}

OpenAPI Specification

palo-alto-networks-statuses-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Palo Alto Networks Statuses API
  version: '1.0'
  description: 'Operations tagged Statuses 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: Statuses
  description: Statuses. 2 operations in this definition.
  x-description-source: desc/statuses/statuses.md
paths:
  /api/v34.03/statuses/buildah:
    get:
      description: 'Buildah Feature Status returns the buildah feature status. GET /api/v34.03/statuses/buildah on the Statuses API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.BuildahFeatureStatus'
          description: BuildahFeatureStatus holds the response for the buildah feature status
        default:
          description: ''
      tags:
      - Statuses
      x-prisma-cloud-target-env:
        permission: monitorCI
      operationId: get-statuses-buildah
      summary: Buildah Feature Status returns the buildah feature status
      x-description-source: desc/statuses/buildah_get.md
  /api/v34.03/statuses/registry:
    get:
      description: 'Get Registry Scan Status. GET /api/v34.03/statuses/registry on the Statuses API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/defender.ScanStatus'
          description: ScanStatus represents the status of current scan
        default:
          description: ''
      tags:
      - Statuses
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-statuses-registry
      summary: Get Registry Scan Status
      x-description-source: desc/statuses/registry_get.md
  /api/v34.04/statuses/buildah:
    get:
      description: 'Buildah Feature Status returns the buildah feature status. GET /api/v34.04/statuses/buildah on the Statuses API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api.BuildahFeatureStatus'
          description: BuildahFeatureStatus holds the response for the buildah feature status
        default:
          description: ''
      tags:
      - Statuses
      x-prisma-cloud-target-env:
        permission: monitorCI
      operationId: get-statuses-buildah
      summary: Buildah Feature Status returns the buildah feature status
      x-description-source: desc/statuses/buildah_get.md
  /api/v34.04/statuses/registry:
    get:
      description: 'Get Registry Scan Status. GET /api/v34.04/statuses/registry on the Statuses API. Documented responses: 200.'
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/defender.ScanStatus'
          description: ScanStatus represents the status of current scan
        default:
          description: ''
      tags:
      - Statuses
      x-prisma-cloud-target-env:
        permission: monitorImages
      operationId: get-statuses-registry
      summary: Get Registry Scan Status
      x-description-source: desc/statuses/registry_get.md
components:
  schemas:
    defender.ScanStatus:
      description: ScanStatus represents the status of current scan
      properties:
        completed:
          description: 'Indicates if scanning has successfully completed (true) or not (false).

            '
          type: boolean
        errors:
          description: 'List of errors that occurred during the last scan.

            '
          items:
            $ref: '#/components/schemas/string'
          type: array
        hostname:
          description: 'Name of the host where Defender runs.

            '
          type: string
        scanTime:
          description: 'Datetime of the last completed scan.

            '
          format: date-time
          type: string
        scanning:
          description: 'Indicates whether scanning is in progress (true) or not (false).

            '
          type: boolean
        selective:
          description: 'Indicates if the scan is for a specific resource (true) or not (false).

            '
          type: boolean
      type: object
    string:
      type: string
    api.BuildahFeatureStatus:
      description: BuildahFeatureStatus holds the response for the buildah feature status
      properties:
        enabled:
          description: 'Enabled is the buildah feature enabled/disabled indicator.

            '
          type: boolean
      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