Oracle

Oracle Compute Instance Agent API

The computeInstanceAgent API from Oracle — 4 operation(s) for computeinstanceagent.

GitHub OpenAPI

Documentation

📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/access-governance-cp/20220518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/adm/20220421/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/advisor/20200606/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ai-data-platform/20240831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/analytics/20190331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/announcements/0.0.1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/api-gateway/20190501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-config/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-control-plane/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-synthetic-monitoring/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/apm-trace-explorer/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/audit/20190901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/autoscaling/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bastion/20210331/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/batch/20251031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/bigdata/20190531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/blockchain/20191010/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/budgets/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificates/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/certificatesmgmt/20210224/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cloud-guard/20200131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/clusterplacementgroups/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/compute-cloud-at-customer/20221208/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-instances/20210415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/container-registry/20180419/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/containerengine/20180222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/cost-anomaly/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dashboard/20210731/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-catalog/20190325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-flow/20200129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-integration/20200430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-safe/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/data-science/20190101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-management/20201101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-migration/20230518/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-multicloud-integrations/20240501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools/20201005/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/database-tools-runtime/20230222/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datacc/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling-dp/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/datalabeling/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/delegate-access-control/20230801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/devops/20210630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/digital-assistant/20190506/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/disaster-recovery/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dms/20211101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/dns/20180115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/document-understanding/20221109/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/edsfu/20220528/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildelivery/20170907/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/emaildeliverysubmission/20220926/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/events/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/filestorage/20171215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fleet-management/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functions/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/functionsdocgenpbf/1.0/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/fusion-applications/20211201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents-client/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-agents/20240531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-inference/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai-nl2sql/20260325/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generative-ai/20231130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/generic/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/globally-distributed-database/20250101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/goldengate/20200407/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/healthchecks/20180501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iaas/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-domains/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity-dp/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/identity/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/incidentmanagement/20181231/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/instanceagent/20180530/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/integration/20190131/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/iot/20250531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/itas/v1/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-java-download/20230601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms/20210610/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/jms-utils/20250521/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/kafka/20240901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/key/release/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/language/20221001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/licensemanager/20220430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits-increase/20251101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/limits/20181025/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/loadbalancer/20170115/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logan-api-spec/20200601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-dataplane/20200831/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-management/20200531/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/logging-search/20190909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/lustre/20250228/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managed-access/20220126/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/management-agent/20200202/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/managementdashboard/20200901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/marketplace/20181001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mngdmac/20250320/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/monitoring/20180401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/multicloud-omhub-cp/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/mysql/20190415/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/NetMonitor/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20211001/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/network-firewall/20230501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/networkloadbalancer/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/nosql-database/20190828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/notification/20181201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/OCB/20220509/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occ/20230515/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occds/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/occm/20231107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocicache/20220315/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/ocm/20220919/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opa/20210621/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/opensearch/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operations-insights/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/operatoraccesscontrol/20200630/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/oracle-api-access-control/20241130/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20230401/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/organizations/20200801/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/osmh/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/postgresql/20220915/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/psasvc/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/publisher/20241201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/queue/20210201/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/recovery-service/20210216/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/registry/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-analytics/20241031/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-discovery-monitoring-control-api/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resource-scheduler/20240430/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/resourcemanager/20180917/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/rover/20201210/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/s3objectstorage/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/scanning/20210215/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/search/20180409/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretmgmt/20180608/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secretretrieval/20190301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/secure-desktops/20220618/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/security-attribute/20240815/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/self/20260129/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/service-catalog/20210527/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/serviceconnectors/20200909/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/smp/20210914/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/speech/20220101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/stack-monitoring/20210330/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/streaming/20180418/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/threat-intel/20220901/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage/20200107/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/usage-proxy/20190111/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vision/20220125/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder/20210601/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/visual-builder-studio/20180828/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20200501/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/vmware/20230701/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waa/20211230/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waas/20181116/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/waf/20210930/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/wlms/20241101/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/workrequests/20160918/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing/20240301/
📖
APIReference
https://docs.oracle.com/en-us/iaas/api/#/en/zero-trust-packet-routing-tools/20240301/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/oracle/refs/heads/main/openapi/oracle-computeinstanceagent-api-openapi.yml

OpenAPI Specification

oracle-computeinstanceagent-api-openapi.yml Raw ↑ 
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 Compute Instance Agent 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: computeInstanceAgent
paths:
  /instanceAgentCommandExecutions:
    get:
      description: 'Lists the execution details for Oracle Cloud Agent commands that run on the specified compute

        instance.

        '
      operationId: ListInstanceAgentCommandExecutions
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/InstanceIdQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      - description: A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
        in: query
        name: lifecycleState
        required: false
        x-obmcs-enumref: '#/definitions/InstanceAgentCommandExecutionSummary/lifecycleState'
        schema:
          type: string
      responses:
        200:
          description: The list is being retrieved.
          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/InstanceAgentCommandExecutionSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListInstanceAgentCommandExecutions
      tags:
      - computeInstanceAgent
  /instanceAgentCommands:
    get:
      description: 'Lists the Oracle Cloud Agent commands issued in a compartment.

        '
      operationId: ListInstanceAgentCommands
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/CompartmentIdQueryParam'
      - $ref: '#/components/parameters/PaginationTokenQueryParam'
      - $ref: '#/components/parameters/PaginationLimitQueryParam'
      - $ref: '#/components/parameters/SortByQueryParam'
      - $ref: '#/components/parameters/SortOrderQueryParam'
      responses:
        200:
          description: The list of commands.
          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/InstanceAgentCommandSummary'
                type: array
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: ListInstanceAgentCommands
      tags:
      - computeInstanceAgent
    post:
      description: 'Creates a command or script to run on a compute instance that is managed by Oracle Cloud Agent.


        On Linux instances, the script runs in a bash shell. On Windows instances, the

        script runs in a batch shell.


        Commands that require administrator privileges will run only if Oracle Cloud Agent

        is running with administrator privileges.

        '
      operationId: CreateInstanceAgentCommand
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/RetryTokenHeader'
      responses:
        200:
          description: The command was successfully created.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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:
                $ref: '#/components/schemas/InstanceAgentCommand'
        400:
          $ref: '#/components/responses/400'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: CreateInstanceAgentCommand
      tags:
      - computeInstanceAgent
      x-related-resource: '#/definitions/InstanceAgentCommand'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInstanceAgentCommandDetails'
        description: Create Instance agent command details
        required: true
  /instanceAgentCommands/{instanceAgentCommandId}:
    delete:
      description: 'Cancels a command that is scheduled to run on a compute instance that is managed

        by Oracle Cloud Agent.


        Canceling a command is a best-effort attempt. If the command has already

        completed, it will not be canceled.

        '
      operationId: CancelInstanceAgentCommand
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/IfMatchHeader'
      - $ref: '#/components/parameters/InstanceAgentCommandIdPathParam'
      responses:
        204:
          description: The command is being canceled.
          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
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        412:
          $ref: '#/components/responses/412'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: CancelInstanceAgentCommand
      tags:
      - computeInstanceAgent
      x-related-resource: '#/definitions/InstanceAgentCommand'
    get:
      description: Gets information about an Oracle Cloud Agent command.
      operationId: GetInstanceAgentCommand
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/InstanceAgentCommandIdPathParam'
      responses:
        200:
          description: The command was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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:
                $ref: '#/components/schemas/InstanceAgentCommand'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: GetInstanceAgentCommand
      tags:
      - computeInstanceAgent
  /instanceAgentCommands/{instanceAgentCommandId}/status:
    get:
      description: Gets information about the status of specified instance agent commandId for the given instanceId.
      operationId: GetInstanceAgentCommandExecution
      parameters:
      - $ref: '#/components/parameters/RequestIdHeader'
      - $ref: '#/components/parameters/InstanceAgentCommandIdPathParam'
      - $ref: '#/components/parameters/InstanceIdQueryParam'
      responses:
        200:
          description: The command status was retrieved.
          headers:
            etag:
              description: 'For optimistic concurrency control. See `if-match`.

                '
              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:
                $ref: '#/components/schemas/InstanceAgentCommandExecution'
        401:
          $ref: '#/components/responses/401'
        404:
          $ref: '#/components/responses/404'
        500:
          $ref: '#/components/responses/500'
        default:
          $ref: '#/components/responses/DefaultError'
      summary: GetInstanceAgentCommandExecution
      tags:
      - computeInstanceAgent
components:
  schemas:
    InstanceAgentCommandSummary:
      description: Summary information for a command.
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the command.
          maxLength: 255
          minLength: 1
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique.
          maxLength: 255
          minLength: 1
          type: string
        instanceAgentCommandId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the command.
          type: string
        isCanceled:
          description: Whether a request was made to cancel the command. Canceling a command is a best-effort attempt.
          type: boolean
        timeCreated:
          description: 'The date and time the command was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the command was last updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - instanceAgentCommandId
      - compartmentId
      - timeCreated
      - timeUpdated
      type: object
    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
    InstanceAgentCommandExecution:
      description: A command's execution summary.
      properties:
        content:
          $ref: '#/components/schemas/InstanceAgentCommandExecutionOutputContent'
        deliveryState:
          description: "Specifies the command delivery state.\n * `VISIBLE` - The command is visible to instance.\n * `PENDING` - The command is pending ack from the instance.\n * `ACKED` - The command has been received and acked by the instance.\n * `ACKED_CANCELED` - The canceled command has been received and acked by the instance.\n * `EXPIRED` - The instance has not requested for commands and its delivery has expired.\n"
          enum:
          - VISIBLE
          - PENDING
          - ACKED
          - ACKED_CANCELED
          - EXPIRED
          type: string
        displayName:
          description: The user friendly display name of the command.
          maxLength: 255
          minLength: 1
          type: string
        instanceAgentCommandId:
          description: The OCID of the command
          maxLength: 255
          minLength: 1
          type: string
        instanceId:
          description: The OCID of the instance
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'command execution life cycle state.

            * `ACCEPTED` - The command execution has been accepted to run.

            * `IN_PROGRESS` - The command execution is in progress.

            * `SUCCEEDED` - The command execution is successful.

            * `FAILED` - The command execution has failed.

            * `TIMED_OUT` - The command execution has timedout.

            * `CANCELED` - The command execution has canceled.

            '
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - SUCCEEDED
          - FAILED
          - TIMED_OUT
          - CANCELED
          type: string
        sequenceNumber:
          description: The large non-consecutive number that Run Command Service assigns to each created command.
          format: int64
          type: integer
        timeCreated:
          description: The command creation date
          format: date-time
          type: string
        timeUpdated:
          description: The command last updated at date.
          format: date-time
          type: string
      required:
      - instanceAgentCommandId
      - instanceId
      - deliveryState
      - lifecycleState
      - content
      - timeCreated
      - timeUpdated
      - sequenceNumber
      type: object
    InstanceAgentCommandOutputDetails:
      description: The output destination for the command.
      discriminator:
        propertyName: outputType
      properties:
        outputType:
          default: TEXT
          description: 'The output type for the command. The following values are supported:


            - `TEXT` - the command output is returned as plain text.

            - `OBJECT_STORAGE_URI` - the command output is saved to an Object Storage URL.

            - `OBJECT_STORAGE_TUPLE` - the command output is saved to an Object Storage bucket.


            For background information about Object Storage buckets and URLs, see

            [Overview of Object Storage](/Content/Object/Concepts/objectstorageoverview.htm).

            '
          enum:
          - TEXT
          - OBJECT_STORAGE_URI
          - OBJECT_STORAGE_TUPLE
          type: string
      required:
      - outputType
      type: object
    InstanceAgentCommandExecutionSummary:
      description: Execution details for a command.
      properties:
        content:
          $ref: '#/components/schemas/InstanceAgentCommandExecutionOutputContent'
          description: The execution output from a command.
        deliveryState:
          description: "The command delivery state.\n * `VISIBLE` - The command is visible to the instance.\n * `PENDING` - The command is pending acknowledgment from the instance.\n * `ACKED` - The command has been received and acknowledged by the instance.\n * `ACKED_CANCELED` - The canceled command has been received and acknowledged by the instance.\n * `EXPIRED` - The instance has not requested for commands and the command's delivery has expired.\n"
          enum:
          - VISIBLE
          - PENDING
          - ACKED
          - ACKED_CANCELED
          - EXPIRED
          type: string
        displayName:
          description: A user-friendly name. Does not have to be unique.
          maxLength: 255
          minLength: 1
          type: string
        instanceAgentCommandId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the command.
          maxLength: 255
          minLength: 1
          type: string
        instanceId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the instance.
          maxLength: 255
          minLength: 1
          type: string
        lifecycleState:
          description: 'The command execution lifecycle state.

            * `ACCEPTED` - The command has been accepted to run.

            * `IN_PROGRESS` - The command is in progress.

            * `SUCCEEDED` - The command was successfully executed.

            * `FAILED` - The command failed to execute.

            * `TIMED_OUT` - The command execution timed out.

            * `CANCELED` - The command execution was canceled.

            '
          enum:
          - ACCEPTED
          - IN_PROGRESS
          - SUCCEEDED
          - FAILED
          - TIMED_OUT
          - CANCELED
          type: string
        sequenceNumber:
          description: A large, non-consecutive number that Oracle Cloud Agent assigns to each created command.
          format: int64
          type: integer
        timeCreated:
          description: 'The date and time the command was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the command was last updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - instanceAgentCommandId
      - instanceId
      - deliveryState
      - lifecycleState
      - content
      - timeCreated
      - timeUpdated
      - sequenceNumber
      type: object
    InstanceAgentCommandContent:
      description: The contents of the command.
      properties:
        output:
          $ref: '#/components/schemas/InstanceAgentCommandOutputDetails'
          description: The output destination for the command.
        source:
          $ref: '#/components/schemas/InstanceAgentCommandSourceDetails'
          description: The source of the command.
      required:
      - source
      type: object
    CreateInstanceAgentCommandDetails:
      description: Creation details for an Oracle Cloud Agent command.
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment to create the command in.
          maxLength: 255
          minLength: 1
          type: string
        content:
          $ref: '#/components/schemas/InstanceAgentCommandContent'
          description: The contents of the command.
        displayName:
          description: 'A user-friendly name for the command. It does not have to be unique.

            Avoid entering confidential information.


            Example: `Database Backup Script`

            '
          maxLength: 255
          minLength: 1
          type: string
        executionTimeOutInSeconds:
          description: 'The amount of time that Oracle Cloud Agent is given to run the command on the instance before timing

            out. The timer starts when Oracle Cloud Agent starts the command. Zero means no timeout.

            '
          maximum: 86400
          minimum: 0
          type: integer
        target:
          $ref: '#/components/schemas/InstanceAgentCommandTarget'
          description: The target instance to run the command on.
      required:
      - compartmentId
      - executionTimeOutInSeconds
      - target
      - content
      type: object
    InstanceAgentCommandExecutionOutputContent:
      description: The execution output from a command.
      discriminator:
        propertyName: outputType
      properties:
        exitCode:
          default: 0
          description: The exit code for the command. Exit code `0` indicates success.
          type: integer
        message:
          description: 'An optional status message that Oracle Cloud Agent can populate for additional troubleshooting.

            '
          maxLength: 255
          type: string
        outputType:
          description: 'The output destination type for the command. The following values are supported:


            - TEXT - the command output is returned as plain text.

            - OBJECT_STORAGE_URI - the command output is saved to an Object Storage URL.

            - OBJECT_STORAGE_TUPLE - the command output is saved to an Object Storage bucket.


            For background information about Object Storage buckets and URLs, see

            [Overview of Object Storage](/Content/Object/Concepts/objectstorageoverview.htm).

            '
          enum:
          - TEXT
          - OBJECT_STORAGE_URI
          - OBJECT_STORAGE_TUPLE
          type: string
      required:
      - outputType
      - exitCode
      type: object
    InstanceAgentCommand:
      description: The command payload.
      properties:
        compartmentId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the command.
          maxLength: 255
          minLength: 1
          type: string
        content:
          $ref: '#/components/schemas/InstanceAgentCommandContent'
          description: The contents of the command.
        displayName:
          description: A user-friendly name. Does not have to be unique. Avoid entering confidential information.
          maxLength: 255
          minLength: 1
          type: string
        executionTimeOutInSeconds:
          description: 'The amount of time that Oracle Cloud Agent is given to run the command on the instance before timing

            out. The timer starts when Oracle Cloud Agent starts the command. Zero means no timeout.

            '
          maximum: 86400
          minimum: 0
          type: integer
        id:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the command.
          maxLength: 255
          minLength: 1
          type: string
        isCanceled:
          default: false
          description: Whether a request was made to cancel the command. Canceling a command is a best-effort attempt.
          type: boolean
        target:
          $ref: '#/components/schemas/InstanceAgentCommandTarget'
          description: The target instance that the command runs on.
        timeCreated:
          description: 'The date and time the command was created, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
        timeUpdated:
          description: 'The date and time the command was last updated, in the format defined by

            [RFC3339](https://tools.ietf.org/html/rfc3339).

            '
          format: date-time
          type: string
      required:
      - id
      - compartmentId
      - target
      - content
      type: object
    InstanceAgentCommandSourceDetails:
      description: The source of the command.
      discriminator:
        propertyName: sourceType
      properties:
        sourceType:
          default: TEXT
          description: 'The source type for the command. The following values are supported:


            - `TEXT` - uses a plain text command that is specified inline with the request.

            - `OBJECT_STORAGE_URI` - imports a command from an Object Storage URL.

            - `OBJECT_STORAGE_TUPLE` - imports a command from an Object Storage bucket.


            For background information about Object Storage buckets and URLs, see

            [Overview of Object Storage](/Content/Object/Concepts/objectstorageoverview.htm).

            '
          enum:
          - TEXT
          - OBJECT_STORAGE_URI
          - OBJECT_STORAGE_TUPLE
          type: string
      required:
      - sourceType
      type: object
    InstanceAgentCommandTarget:
      description: The target instance that the command runs on.
      properties:
        instanceId:
          description: The [OCID](/Content/General/Concepts/identifiers.htm) of the target instance.
          maxLength: 255
          minLength: 1
          type: string
      type: object
  parameters:
    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
    InstanceIdQueryParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the instance.
      in: query
      name: instanceId
      required: true
      schema:
        type: string
    IfMatchHeader:
      description: 'For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match`

        parameter to the value of the etag from a previous GET or POST response for that resource.  The resource

        will be updated or deleted only if the etag you provide matches the resource''s current etag value.

        '
      in: header
      name: if-match
      schema:
        type: string
    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
    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
    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
    RetryTokenHeader:
      description: 'A token that uniquely identifies a request so it can be retried in case of a timeout or

        server error without risk of executing that same action again. Retry tokens expire after 24

        hours, but can be invalidated before then due to conflicting operations (for example, if a resource

        has been deleted and purged from the system, then a retry of the original creation request

        may be rejected).

        '
      in: header
      name: opc-retry-token
      schema:
        type: string
        maxLength: 64
        minLength: 1
    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\-_\.]+'
    InstanceAgentCommandIdPathParam:
      description: The [OCID](/Content/General/Concepts/identifiers.htm) of the command.
      in: path
      name: instanceAgentCommandId
      required: true
      schema:
        type: string
        maxLength: 255
        minLength: 1
  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'
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