Oracle Pluginconfig API

openapi: 3.2.0
info:
  description: 'API for the Oracle Cloud Agent software running on compute instances. Oracle Cloud Agent

    is a lightweight process that monitors and manages compute instances.

    '
  title: Oracle Cloud Agent Pluginconfig API
  version: '20180530'
  x-provenance:
    method: harvested
    first_party: true
    publisher: Oracle
    source: https://docs.oracle.com/en-us/iaas/api/specs/abc54d26544daece6d8f5d23598a268c1ec36b55d8481463fac336c5329097b9.yaml
    harvested: '2026-08-04'
    note: Published by Oracle as the contract for the Oracle Cloud Agent API OCI service and stored verbatim; API Evangelist added only this provenance block.
  x-evidence:
  - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json
    what: Oracle's own index of every OCI service specification
  - url: https://docs.oracle.com/en-us/iaas/api/specs/abc54d26544daece6d8f5d23598a268c1ec36b55d8481463fac336c5329097b9.yaml
    what: the harvested document for Oracle Cloud Agent API
servers:
- url: https://127.0.0.1/20180530
tags:
- name: pluginconfig
paths:
  /instanceagent/availablePlugins:
    get:
      description: Lists the Oracle Cloud Agent plugins that are available for compute instances.
      operationId: ListInstanceagentAvailablePlugins
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/OperatingSystemQueryParam'
      - $ref: '#/components/parameters/OperatingSystemVersionQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - $ref: '#/components/parameters/NameQueryParam'
      responses:
        200:
          description: The plugins matching the query are returned.
          headers:
            opc-next-page:
              description: 'For list pagination. When this header appears in the response, additional pages

                of results remain. For important details about how pagination works, see

                [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

                '
              schema:
                type: string
            opc-request-id:
              description: 'Unique Oracle-assigned identifier for the request. If you need to contact

                Oracle about a particular request, please provide the request ID.

                '
              schema:
                type: string
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/AvailablePluginSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        429:
          $ref: '#/components/responses/429'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListInstanceagentAvailablePlugins
      tags:
      - pluginconfig
      x-related-resource: '#/definitions/Plugin'
components:
  parameters:
    CompartmentIdQueryParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment.
      in: query
      name: compartmentId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
    NameQueryParam:
      description: The plugin name.
      in: query
      name: name
      required: false
      x-default-description: Default is empty
      schema:
        type: string
        maxLength: 64
        minLength: 1
    PaginationTokenQueryParam:
      description: 'For list pagination. The value of the `opc-next-page` response header from the previous "List"

        call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: page
      x-default-description: Default is empty
      schema:
        type: string
        maxLength: 4096
        minLength: 1
    SortByQueryParam:
      description: 'The field to sort by. You can provide one sort order (`sortOrder`). Default order for

        `TIMECREATED` is descending.


        **Note:** In general, some "List" operations (for example, `ListInstances`) let you

        optionally filter by availability domain if the scope of the resource type is within a

        single availability domain. If you call one of these "List" operations without specifying

        an availability domain, the resources are grouped by availability domain, then sorted.

        '
      in: query
      name: sortBy
      required: false
      x-default-description: Default is empty
      schema:
        type: string
        enum:
        - TIMECREATED
        - DISPLAYNAME
    RequestIdHeader:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request,

        please provide the request ID.

        '
      in: header
      name: opc-request-id
      schema:
        type: string
        pattern: '[A-Za-z0-9\-_\.]+'
    PaginationLimitQueryParam:
      description: 'For list pagination. The maximum number of results per page, or items to return in a paginated

        "List" call. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      in: query
      name: limit
      schema:
        type: integer
        default: 1
        maximum: 1000
        minimum: 1
    OperatingSystemVersionQueryParam:
      description: 'The OS version for the instance.


        If no match is found, all plugins are returned.


        Examples: `7.9`, `8` for CentOS and Oracle Linux. `20.04`, `20.04 Minimal` for Canonical Ubuntu.

        `2012 R2 Datacenter`, `2019 Standard` for Windows Server.

        '
      in: query
      name: osVersion
      required: true
      schema:
        type: string
        maxLength: 64
        minLength: 1
    OperatingSystemQueryParam:
      description: 'The image (OS) for the compute instance.


        If no match is found, all plugins are returned.


        Examples: `CentOS`, `Oracle Linux`, `Oracle Autonomous Linux`, `Canonical Ubuntu`, `Windows Server`

        '
      in: query
      name: osName
      required: true
      schema:
        type: string
        maxLength: 64
        minLength: 1
    SortOrderQueryParam:
      description: 'The sort order to use, either ascending (`ASC`) or descending (`DESC`). The `DISPLAYNAME` sort order

        is case sensitive.

        '
      in: query
      name: sortOrder
      required: false
      x-default-description: Default is empty
      schema:
        type: string
        enum:
        - ASC
        - DESC
  responses:
    DefaultError:
      description: An error has occurred.
      headers:
        opc-request-id:
          description: 'Unique Oracle-assigned identifier for the request. If you need to contact

            Oracle about a particular request, please provide the request ID.

            '
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      description: Error response
      properties:
        code:
          description: 'A short error code that defines the error, meant for programmatic parsing. See

            [API Errors](/Content/API/References/apierrors.htm).

            '
          type: string
        message:
          description: A human-readable error string.
          type: string
      required:
      - code
      - message
      type: object
    AvailablePluginSummary:
      description: Information about where a plugin is supported.
      properties:
        isEnabledByDefault:
          description: Whether the plugin is enabled or disabled by default.
          type: boolean
        isSupported:
          description: Whether the plugin is supported.
          type: boolean
        name:
          description: The plugin name.
          type: string
        summary:
          description: A brief description of the plugin's functionality.
          type: string
      required:
      - name
      - isSupported
      - isEnabledByDefault
      type: object
x-anchors:
  x-headers:
    etag:
      description: 'For optimistic concurrency control. See `if-match`.

        '
      type: string
    opc-next-page:
      description: 'For list pagination. When this header appears in the response, additional pages

        of results remain. For important details about how pagination works, see

        [List Pagination](/iaas/Content/API/Concepts/usingapi.htm#nine).

        '
      type: string
    opc-request-id:
      description: 'Unique Oracle-assigned identifier for the request. If you need to contact

        Oracle about a particular request, please provide the request ID.

        '
      type: string
x-oracle-package: com.oracle.pic.compute.ias