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