openapi: 3.2.0 info: description: API for Oracle Cloud Bridge service. title: Oracle Cloud Bridge Ocb Agent Svc API version: '20220509' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/c321f3149c29b4ca6e4030a39208852a1148785c372d569ef4b147e313ee18a3.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the Oracle Cloud Bridge 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/c321f3149c29b4ca6e4030a39208852a1148785c372d569ef4b147e313ee18a3.yaml what: the harvested document for Oracle Cloud Bridge API servers: - url: http://127.0.0.1/20220509 - url: https://127.0.0.1/20220509 tags: - name: ocbAgentSvc paths: /agentDependencies: get: description: 'Returns a list of AgentDependencies such as AgentDependencyCollection. ' operationId: ListAgentDependencies parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/AgentIdQueryParam' - $ref: '#/components/parameters/EnvironmentIdQueryParam' - $ref: '#/components/parameters/AgentDependencyLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page with AgentDependencySummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/AgentDependencyCollection' 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/default' summary: Gets a list of all AgentDependencies in a compartment. tags: - ocbAgentSvc x-related-resource: '#/definitions/AgentDependencyCollection' post: description: 'Creates an AgentDependency. ' operationId: CreateAgentDependency parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The create AgentDependency request is accepted. headers: etag: 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/AgentDependency' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates an AgentDependency. tags: - ocbAgentSvc x-related-resource: '#/definitions/AgentDependency' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAgentDependencyDetails' description: Details for the new AgentDependency. required: true /agentDependencies/{agentDependencyId}: delete: description: Deletes the AgentDependency resource based on an identifier. operationId: DeleteAgentDependency parameters: - $ref: '#/components/parameters/AgentDependencyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: The deletion of AgentDependency is successful. 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a provisioned AgentDependency. tags: - ocbAgentSvc x-related-resource: '#/definitions/AgentDependency' get: description: Gets an AgentDependency by identifier. operationId: GetAgentDependency parameters: - $ref: '#/components/parameters/AgentDependencyIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the AgentDependency with the given ID. 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/AgentDependency' 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/default' summary: Gets an AgentDependency. tags: - ocbAgentSvc put: description: Updates the AgentDependency. operationId: UpdateAgentDependency parameters: - $ref: '#/components/parameters/AgentDependencyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The AgentDependency will be updated. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the AgentDependency identified by the ID. tags: - ocbAgentSvc x-related-resource: '#/definitions/AgentDependency' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAgentDependencyDetails' description: The information to be updated. required: true /agentDependencies/{agentDependencyId}/actions/changeCompartment: post: description: Moves a AgentDependency resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeAgentDependencyCompartment parameters: - $ref: '#/components/parameters/AgentDependencyIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: Retrieves the AgentDependency resource with the new compartment. 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' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - ocbAgentSvc x-related-resource: '#/definitions/AgentDependency' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAgentDependencyCompartmentDetails' description: The information to be updated. required: true /agents: get: description: 'Returns a list of Agents. ' operationId: ListAgents parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/EnvironmentIdQueryParam' - $ref: '#/components/parameters/AgentLifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/AgentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page with AgentSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/AgentCollection' 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/default' summary: Gets a list of all Agents in a compartment. tags: - ocbAgentSvc x-related-resource: '#/definitions/AgentCollection' post: description: 'Creates an Agent. ' operationId: CreateAgent parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: create ocbAgent success. 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/Agent' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates an Agent. tags: - ocbAgentSvc x-related-resource: '#/definitions/Agent' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateAgentDetails' description: Details of the new Agent. required: true /agents/{agentId}: delete: description: Deletes an Agent resource identified by an identifier. operationId: DeleteAgent parameters: - $ref: '#/components/parameters/AgentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 204: description: The deletion of Agent is successful. 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a provisioned Agent. tags: - ocbAgentSvc x-related-resource: '#/definitions/Agent' get: description: Gets an Agent by identifier. operationId: GetAgent parameters: - $ref: '#/components/parameters/AgentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the Agent with the given ID. 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/Agent' 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/default' summary: Gets an Agent. tags: - ocbAgentSvc put: description: Updates the Agent. operationId: UpdateAgent parameters: - $ref: '#/components/parameters/AgentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The update of Agent is successful. 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/Agent' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the Agent identified by the ID. tags: - ocbAgentSvc x-related-resource: '#/definitions/Agent' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAgentDetails' description: The information to be updated. required: true /agents/{agentId}/actions/changeCompartment: post: description: Moves an Agent resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeAgentCompartment parameters: - $ref: '#/components/parameters/AgentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The Agent resource will be moved into a different compartment. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - ocbAgentSvc x-related-resource: '#/definitions/Agent' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeAgentCompartmentDetails' description: The information to be updated. required: true /agents/{agentId}/plugins/{pluginName}: get: description: Gets a plugin by identifier. operationId: GetPlugin parameters: - $ref: '#/components/parameters/AgentIdentifierPathParam' - $ref: '#/components/parameters/PluginIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the plugin with the given name. 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/Plugin' 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/default' summary: Gets a plugin by identifier. tags: - ocbAgentSvc /applianceImages: get: description: 'Returns a list of Appliance Images. ' operationId: ListApplianceImages parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' responses: 200: description: A page with of ApplianceImageSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/ApplianceImageCollection' 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/default' summary: Gets a list of all Appliance Images. tags: - ocbAgentSvc x-related-resource: '#/definitions/ApplianceImageCollection' /environments: get: description: 'Returns a list of source environments. ' operationId: ListEnvironments parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/DisplayNameQueryParam' - $ref: '#/components/parameters/EnvironmentIdQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A page with of EnvironmentSummary objects. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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/EnvironmentCollection' 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/default' summary: Gets a list of all source environments in a compartment. tags: - ocbAgentSvc x-related-resource: '#/definitions/EnvironmentCollection' post: description: 'Creates a source environment. ' operationId: CreateEnvironment parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The source create environment is created successfully. 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/Environment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Creates source environment. tags: - ocbAgentSvc x-related-resource: '#/definitions/Environment' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEnvironmentDetails' description: Details of for the new source environment. required: true /environments/{environmentId}: delete: description: Deletes a the source environment resource identified by an identifier. operationId: DeleteEnvironment parameters: - $ref: '#/components/parameters/EnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 204: description: Deletion of the environment is successful. 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 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Deletes a provisioned source environment. tags: - ocbAgentSvc x-related-resource: '#/definitions/Environment' get: description: Gets a source environment by identifier. operationId: GetEnvironment parameters: - $ref: '#/components/parameters/EnvironmentIdentifierPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Retrieves the environment with the given id ID. 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/Environment' 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/default' summary: Gets a source environment. tags: - ocbAgentSvc put: description: Updates the source environment. operationId: UpdateEnvironment parameters: - $ref: '#/components/parameters/EnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 200: description: The source update environment is updated successfully. 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/Environment' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 405: $ref: '#/components/responses/405' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Updates the source environment identified by the id ID. tags: - ocbAgentSvc x-related-resource: '#/definitions/Environment' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEnvironmentDetails' description: The information to be updated. required: true /environments/{environmentId}/actions/addAgentDependency: post: description: Add a dependency to the environment. When provided, If-Match is checked against ETag values of the resource. operationId: AddAgentDependency parameters: - $ref: '#/components/parameters/EnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: add agentDependency is added to the environment successfully. 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/Environment' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Add a dependency to the environment. tags: - ocbAgentSvc x-related-resource: '#/definitions/Environment' requestBody: content: application/json: schema: $ref: '#/components/schemas/AddAgentDependencyDetails' description: The information to be updated. required: true /environments/{environmentId}/actions/changeCompartment: post: description: Moves a source environment resource from one compartment identifier to another. When provided, If-Match is checked against ETag values of the resource. operationId: ChangeEnvironmentCompartment parameters: - $ref: '#/components/parameters/EnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/RetryTokenHeader' responses: 202: description: Accepted the request. The source environment resource will be moved into a different compartment. 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Moves a resource into a different compartment. tags: - ocbAgentSvc x-related-resource: '#/definitions/Environment' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeEnvironmentCompartmentDetails' description: The information to be updated. required: true /environments/{environmentId}/actions/removeAgentDependency: post: description: Adds a dependency to the source environment. When provided, If-Match is checked against ETag values of the resource. operationId: RemoveAgentDependency parameters: - $ref: '#/components/parameters/EnvironmentIdentifierPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: remove agentDependency is removed from the environment successfully. 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/Environment' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' summary: Adds a dependency to the source environment. tags: - ocbAgentSvc x-related-resource: '#/definitions/Environment' requestBody: content: application/json: schema: $ref: '#/components/schemas/RemoveAgentDependencyDetails' description: The information to be updated. required: true components: schemas: AgentDependencyCollection: description: Results of an AgentDependency list. Contains both AgentDependency items and other information, such as metadata. properties: items: description: List of EnvironmentDependencies. items: $ref: '#/components/schemas/AgentDependencySummary' type: array required: - items type: object CreateAgentDetails: description: Information about the new Agent. properties: agentType: description: Agent identifier. type: string x-obmcs-enumref: '#/definitions/Agent/agentType' agentVersion: description: Agent identifier. maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Agent identifier. maxLength: 255 minLength: 1 type: string environmentId: description: Environment identifier. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object osVersion: description: OS version. maxLength: 255 minLength: 1 type: string required: - displayName - agentType - agentVersion - environmentId - osVersion - compartmentId type: object Error: description: Error Information. properties: code: description: A short error code that defines the error, meant for programmatic parsing. type: string message: description: A human-readable error string. type: string required: - code - message UpdateEnvironmentDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Environment identifier. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object ChangeEnvironmentCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object UpdateAgentDependencyDetails: description: The information about new AgentDependency. properties: bucket: description: Object storage bucket where the dependency is uploaded. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object dependencyName: description: Name of the dependency type. This should match the whitelisted enum of dependency names. type: string dependencyVersion: description: Version of the Agent dependency. type: string description: description: Description about the Agent dependency. type: string displayName: description: Display name of the Agent dependency. type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object namespace: description: Object storage namespace associated with the customer's tenancy. type: string objectName: description: Name of the dependency object uploaded by the customer. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object type: object EnvironmentCollection: description: Results of an environment search. Contains both EnvironmentSummary items and other information, such as metadata. properties: items: description: List of all source environments. items: $ref: '#/components/schemas/EnvironmentSummary' type: array required: - items type: object ChangeAgentDependencyCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object AgentCollection: description: Displays results of an Agent search. Contains both AgentSummary items and other information, such as metadata. properties: items: description: List of Agents. items: $ref: '#/components/schemas/AgentSummary' type: array required: - items type: object CreateEnvironmentDetails: description: The information about the new source environment. properties: compartmentId: description: Compartment identifier. maxLength: 255 minLength: 1 type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Environment identifier. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object required: - compartmentId type: object Environment: description: Description of the source environment. properties: compartmentId: description: Compartment identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Environment identifier, which can be renamed. type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the source environment. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCreated: description: The time when the source environment was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the source environment was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object UpdateAgentDetails: description: The information to be updated. properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Agent identifier. maxLength: 255 minLength: 1 type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object type: object CreateAgentDependencyDetails: description: The information about new AgentDependency. properties: bucket: description: Object storage bucket where the dependency is uploaded. type: string compartmentId: description: Compartment identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object dependencyName: description: Name of the dependency type. This should match the whitelisted enum of dependency names. type: string dependencyVersion: description: Version of the Agent dependency. type: string description: description: Description about the Agent dependency. type: string displayName: description: Display name of the Agent dependency. type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object namespace: description: Object storage namespace associated with the customer's tenancy. type: string objectName: description: Name of the dependency object uploaded by the customer. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object required: - displayName - dependencyName - namespace - bucket - objectName - compartmentId type: object AgentDependencySummary: description: Description of the AgentDependency, which is a sub-resource of the external environment. properties: bucket: description: Object storage bucket where the Agent dependency is uploaded. type: string checksum: description: The checksum associated with the dependency object returned by Object Storage. type: string compartmentId: description: Compartment identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object dependencyName: description: Name of the dependency type. This should match the whitelisted enum of dependency names. type: string dependencyVersion: description: Version of the Agent dependency. type: string description: description: Description about the Agent dependency. type: string displayName: description: Display name of the Agent dependency. type: string eTag: description: The eTag associated with the dependency object returned by Object Storage. type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the external environment. type: string x-obmcs-enumref: '#/definitions/AgentDependency/lifecycleState' namespace: description: Object storage namespace associated with the customer's tenancy. type: string objectName: description: Name of the dependency object uploaded by the customer. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCreated: description: The time when the AgentDependency was created. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - displayName - dependencyName - namespace - bucket - objectName type: object AgentSummary: description: Summary of the Agent. properties: agentType: description: Type of Agent. type: string x-obmcs-enumref: '#/definitions/Agent/agentType' agentVersion: description: Agent identifier. maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Agent identifier, which can be renamed. type: string environmentId: description: Environment identifier. type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object heartBeatStatus: description: Current heartbeat status of the Agent based on its timeLastSyncReceived value. type: string x-obmcs-enumref: '#/definitions/Agent/heartBeatStatus' id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Agent. type: string x-obmcs-enumref: '#/definitions/Agent/lifecycleState' osVersion: description: OS version. maxLength: 255 minLength: 1 type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCreated: description: The time when the Agent was created. An RFC3339 formatted datetime string. format: date-time type: string timeLastSyncReceived: description: The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the Agent was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - agentType - agentVersion - osVersion - lifecycleState - lifecycleDetails - timeCreated - timeUpdated - displayName - environmentId - freeformTags - definedTags type: object ApplianceImageSummary: description: Description of the ApplianceImage. properties: checksum: description: The checksum of the image file. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: The name of the image to be displayed. type: string downloadUrl: description: The URL from which the appliance image can be downloaded. type: string fileName: description: The name of the appliance Image file. type: string format: description: The file format of the image file. type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleState: description: The current state of the appliance image. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string platform: description: The virtualization platform that the image file supports. type: string sizeInMBs: description: The size of the image file in megabytes. type: string timeCreated: description: The time when the appliance image was created.An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the appliance image was last updated. An RFC3339 formatted datetime string. format: date-time type: string version: description: The version of the image file. type: string required: - id - fileName - displayName - version - sizeInMBs - checksum - platform - format - timeCreated - timeUpdated - downloadUrl type: object AgentDependency: description: Description of the AgentDependency, which is a sub-resource of the external environment. properties: bucket: description: Object storage bucket where the Agent dependency is uploaded. type: string checksum: description: The checksum associated with the dependency object returned by Object Storage. type: string compartmentId: description: Compartment identifier type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object dependencyName: description: Name of the dependency type. This should match the whitelisted enum of dependency names. type: string dependencyVersion: description: Version of the Agent dependency. type: string description: description: Description about the Agent dependency. type: string displayName: description: Display name of the Agent dependency. type: string eTag: description: The eTag associated with the dependency object returned by Object Storage. type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of AgentDependency. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string namespace: description: Object storage namespace associated with the customer's tenancy. type: string objectName: description: Name of the dependency object uploaded by the customer. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCreated: description: The time when the AgentDependency was created. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - displayName - dependencyName - namespace - bucket - objectName type: object Agent: description: Description of Agent. properties: agentPubKey: description: Resource principal public key. type: string agentType: description: Type of the Agent. enum: - APPLIANCE type: string agentVersion: description: Agent identifier. maxLength: 255 minLength: 1 type: string compartmentId: description: Compartment identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Agent identifier, can be renamed. type: string environmentId: description: Environment identifier. type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object heartBeatStatus: description: The current heartbeat status of the Agent based on its timeLastSyncReceived value. enum: - HEALTHY - UNHEALTHY - FAILED - INACTIVE type: string id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state of the Agent in more detail. For example, it can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the Agent. enum: - CREATING - ACTIVE - INACTIVE - DELETED - FAILED type: string osVersion: description: OS version. maxLength: 255 minLength: 1 type: string pluginList: description: List of plugins associated with the agent. items: $ref: '#/components/schemas/PluginSummary' type: array systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCreated: description: The time when the Agent was created. An RFC3339 formatted datetime string. format: date-time type: string timeExpireAgentKeyInMs: description: The time since epoch for when the public key will expire. An RFC3339 formatted datetime string. format: date-time type: string timeLastSyncReceived: description: The time when the last heartbeat of the Agent was noted. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the Agent was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - agentType - agentVersion - osVersion - lifecycleState - timeCreated - displayName - freeformTags - definedTags - environmentId type: object Plugin: description: Description of plugin properties: agentId: description: Agent identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object desiredState: description: State to which the customer wants the plugin to move to. enum: - ENABLED - DISABLED type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the plugin. enum: - UPDATING - ACTIVE - INACTIVE - NEEDS_ATTENTION - DELETED type: string name: description: Plugin identifier, which can be renamed. type: string pluginVersion: description: Plugin version. type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCreated: description: The time when the Agent was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the Agent was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - agentId - pluginVersion - lifecycleState - timeCreated - name type: object EnvironmentSummary: description: Summary of a source environment. properties: compartmentId: description: Compartment identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object displayName: description: Environment identifier, which can be renamed. type: string freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the source environment. type: string x-obmcs-enumref: '#/definitions/Environment/lifecycleState' systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object timeCreated: description: The time when the source environment was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the source environment was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - id - compartmentId - lifecycleState - timeCreated - displayName - freeformTags - definedTags type: object PluginSummary: description: Summary of the plugin in an Agent. properties: agentId: description: Agent identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object lifecycleDetails: description: A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in Failed state. type: string lifecycleState: description: The current state of the plugin. type: string x-obmcs-enumref: '#/definitions/Plugin/lifecycleState' name: description: Plugin identifier, which can be renamed. type: string pluginVersion: description: Plugin version. type: string timeCreated: description: The time when the plugin was created. An RFC3339 formatted datetime string. format: date-time type: string timeUpdated: description: The time when the plugin was updated. An RFC3339 formatted datetime string. format: date-time type: string required: - agentId - pluginVersion - lifecycleState - timeCreated - name - freeformTags - definedTags type: object ApplianceImageCollection: description: Results of an ApplianceImage search. properties: items: description: List of appliance images. items: $ref: '#/components/schemas/ApplianceImageSummary' type: array required: - items type: object RemoveAgentDependencyDetails: description: The information to be updated. properties: agentDependencyId: description: The OCID of the agentDependency that should be removed from the source environment. maxLength: 255 minLength: 1 type: string required: - agentDependencyId type: object ChangeAgentCompartmentDetails: description: The information to be updated. properties: compartmentId: description: 'The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment into which the resource should be moved. ' maxLength: 255 minLength: 1 type: string required: - compartmentId type: object AddAgentDependencyDetails: description: The information to be updated. properties: agentDependencyId: description: The OCID of the agentDependency, which is added to the source environment. maxLength: 255 minLength: 1 type: string required: - agentDependencyId type: object parameters: PaginationTokenQueryParam: description: A token representing the position at which to start retrieving results. This must come from the `opc-next-page` header field of a previous response. in: query name: page x-default-description: 'null' schema: type: string minLength: 1 SortByQueryParam: description: 'The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. ' in: query name: sortBy schema: type: string enum: - timeCreated - timeUpdated - displayName default: timeCreated EnvironmentIdentifierPathParam: description: Unique environment identifier. in: path name: environmentId required: true schema: type: string EnvironmentIdQueryParam: description: A filter to return only resources that match the given environment ID. in: query name: environmentId x-default-description: 'null' schema: type: string CompartmentIdQueryParam: description: The ID of the compartment in which to list resources. in: query name: compartmentId 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 required: false schema: type: string PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 10 maximum: 100 minimum: 1 LifecycleStateQueryParam: description: A filter to return only resources where their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Environment/lifecycleState' schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder x-default-description: 'The default value depends upon `sortBy`, and in general is ''DESC'' when sorting by time and ''ASC'' otherwise. ' x-obmcs-top-level-enum: '#/definitions/SortOrders' schema: type: string enum: - ASC - DESC AgentDependencyIdentifierPathParam: description: A unique AgentDependency identifier. in: path name: agentDependencyId required: true schema: type: string AgentDependencyLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/AgentDependency/lifecycleState' schema: type: string 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 the same action again. Retry tokens expire after 24 hours, but can be invalidated before 24 hours due to conflicting operations. For example, if a resource has been deleted and purged from the system, a retry of the original creation request might be rejected. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 AgentLifecycleStateQueryParam: description: A filter to return only resources their lifecycleState matches the given lifecycleState. in: query name: lifecycleState required: false x-default-description: 'null' x-obmcs-enumref: '#/definitions/Agent/lifecycleState' schema: type: string DisplayNameQueryParam: description: A filter to return only resources that match the entire display name given. in: query name: displayName x-default-description: 'null' schema: type: string maxLength: 255 minLength: 1 PluginIdentifierPathParam: description: Unique plugin identifier path parameter. in: path name: pluginName required: true schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string AgentIdentifierPathParam: description: Unique Agent identifier path parameter. in: path name: agentId required: true schema: type: string AgentIdQueryParam: description: A filter to return only resources that match the given Agent ID. in: query name: agentId x-default-description: 'null' schema: type: string responses: default: description: Unknown Error 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-allowed-tenancies: - ocid1.tenancy.oc1..aaaaaaaaygoijofmkbtcrutsh5qo6ov3ksxa52ao7sthgr7yf4y25qea3ygq - ocid1.tenancy.oc1..aaaaaaaay323a6sswz6cuw2mr5eedczmeorn5yycybkhfwvbgmgy2ct3ybua - ocid1.tenancy.oc1..aaaaaaaaxwkwm64osdnmhpvu3vpd4ob2s3eewy2kmnztq7nbgo57ablx5bzq - ocid1.tenancy.oc1..aaaaaaaapynjgyvwaxdms7czbrcsuntvvzhex452aebkzo5cqa5jaycjvpzq - ocid1.tenancy.oc1..aaaaaaaahr2xcduf4knzkzhkzt442t66bpqt3aazss6cy2ll6x4xj3ci7tiq - ocid1.tenancy.oc1..aaaaaaaaz6poe72rkvim33pokoivtpx7obta5bi5vew54oneuc7tw7bs2sva - ocid1.tenancy.oc4..aaaaaaaatarbopzhejne3w73ekmxdl4rigfpgk2tql2axozj6nrq2oqn3mtq - ocid1.tenancy.oc4..aaaaaaaatyktwbyjeub6snw6pgyfqiwgcjq4q5kr6tg6x6ovw52neelfwq4a - ocid1.tenancy.oc5..aaaaaaaab7gdnudsz6r4jeeuaxxdqy6wvqotjirsclweuve2ywe6il2jl3ta - ocid1.tenancy.oc5..aaaaaaaacm62wd4rfb7t2sshbwci5dzwnm665weqvxbqtnysiwwtxiwgj4ha - ocid1.tenancy.oc8..aaaaaaaamkdo3htfnq7mxc5rhneeza6xkidayiofslkjcnwh3lac7rbfk2eq - ocid1.tenancy.oc8..aaaaaaaa43mogprfdapygtbdodvaikhxaigudltod2ekl7ocyej6jyvpfkfq - ocid1.tenancy.oc9..aaaaaaaa7noxantrtqaih4xnkdkhvzoayh77ucxb753n65bo5a4lzlvssoca - ocid1.tenancy.oc9..aaaaaaaai7tpd5tl57zpha3qeaxgugbdnspll5efpjtncxn53idak6ol7vxa - ocid1.tenancy.oc10..aaaaaaaam7lxohmjck47huobhkivar2kgwwkoyuhenijydso3n3ldndoboea - ocid1.tenancy.oc10..aaaaaaaapzu7l23jbz4ya77nrzzw7mk26zggkznp4ivndnhad2cf7cmxn2oa - ocid1.tenancy.oc14..aaaaaaaa6hfipjujgte4r2zpjv3kl2qvt3c77c5in5nfa3tul7lr26f7qggq - ocid1.tenancy.oc14..aaaaaaaa2waiw7okanpguwhf5gb7vvnri37hvn3tessqv6sc5iu4xp6evxha - ocid1.tenancy.oc16..aaaaaaaaazv5l7zbx6ubpvcwvmp2zvdtey6j6an4sdzzgpe4d755tvx2z2lq - ocid1.tenancy.oc16..aaaaaaaansltu2vnzmp6tcg43pgmkdpss6myb5tqloobqpilmemge5fxxtgq - ocid1.tenancy.oc17..aaaaaaaa4a46zl5lftaa67j4esbjhgaomgyor4i4ouok3e2bxiokymt7t72a - ocid1.tenancy.oc17..aaaaaaaafsquc4pej5zt4yhqykfbrigniieknyt3abj7p23jfuqckynug55q - ocid1.tenancy.oc19..aaaaaaaaocdn6ywf5j2k27vfbayhzc52rl4p5ssu4p2h2u7xjiefw4qhhl4a - ocid1.tenancy.oc19..aaaaaaaa7h4h3ntmiwvvoa3ekca5cmw55cxtk2z7gyu6pjvlqyk7ewy2opfa - ocid1.tenancy.oc20..aaaaaaaaam73fgmj7pdxokgfyomvhdckjar5sm6e465mh3maqyhat3iinunq - ocid1.tenancy.oc20..aaaaaaaaujxvjssx77l42dq6ptcaerm7kavzdpypdbi56zvsxwxmritqp65a - ocid1.tenancy.region1..aaaaaaaaann26zl32kkth2yxmf33csbrgnjrmyat44olp5gno4emdhktcwva - ocid1.tenancy.region1..aaaaaaaada63ksfiw33rfvlluvysfvqfwkeeu5t2ka3hbzqaxmltcwnwmyla - ocid1.tenancy.oc1..aaaaaaaaasnr5i3j7qqxr64fbzxf363nxzcyxyu3ctoffojyx4wdn5p6vzaq - ocid1.tenancy.oc1..aaaaaaaa5d2dju6cfnxmiydob6wobvw5l4wdalb4tgqiyqdh2vovhqfzhbma - ocid1.tenancy.oc1..aaaaaaaachdpgyy6f4kigtezapgualiuanek5am2voulsdzvawwgxqjtj5da - ocid1.tenancy.oc1..aaaaaaaafc225uqmgx2oma5z442fce3nh3jjnb75xygogmajw47njezolzia - ocid1.tenancy.oc4..aaaaaaaaph7jhogsn2xrs6suzih7tqvj3tfbbjbaxiu2aneabwuc42br4noa - ocid1.tenancy.oc4..aaaaaaaa4hhw6fkd3e26ixnpn3vrsnn7queu4vfzsmvimi3qt2uoytf6gana - ocid1.tenancy.oc5..aaaaaaaats7kk6ddqard5w4wbsctkc2xrhqu27gf3m6dt2kwoiypay64th5q - ocid1.tenancy.oc5..aaaaaaaalhu4qomiyar5phvtksgoga23hmrpr4et566wgys7tzx5tt3wr53q - ocid1.tenancy.oc8..aaaaaaaajgrnesy2mqz2hdf5bu2ao6njraxjjcniqpyimd2uwtbbri3zvnlq - ocid1.tenancy.oc8..aaaaaaaa5gyygmmwi4nnqrekiewalxcvc4gszsxe5ynp7dxobykgrwin7vtq - ocid1.tenancy.oc9..aaaaaaaakq5rqxkpxlreim5wwzsjszx7pe5hgb5o5wph4kitlwzn66qzzdwq - ocid1.tenancy.oc9..aaaaaaaa2l3nlgpsqekuwj6elgo3oxq5peafobx5dokqoexif5efi3unr3ya - ocid1.tenancy.oc10..aaaaaaaaatitljwoun5csbwn5cxfnatdlud4on4akbedlbitgced2iqvp5ra - ocid1.tenancy.oc10..aaaaaaaahwel42yh5nx2zfkhh2b5z4osz4mnewnxtfffpnl7amrpqqlkhubq - ocid1.tenancy.oc14..aaaaaaaatubnqwmu7chcrwon6t3bs67xnfwkc64qmlsmftygnih2a2ztf24q - ocid1.tenancy.oc14..aaaaaaaabhlq6agzsw6miuwhin27ygx5ukrmwxbrqhkf2irgosuo4b3a7szq - ocid1.tenancy.oc16..aaaaaaaaxkt4ckjowgj3m5oxuvitpd3vx6fei5epup6gp2t3ppleeao6lhba - ocid1.tenancy.oc16..aaaaaaaa2uklh7ekvzyw462mglzj3o2fkv7p6oxwcvyikc6frarz2xwuf72a - ocid1.tenancy.oc17..aaaaaaaanyrio4kmt2nj5lcmbnoa3lkouyg6z35qsuazbumirncq6iyyfcsa - ocid1.tenancy.oc17..aaaaaaaaz6mh4y3uzwcscgaeprwqg6hkigxweeyl3rkdmcgm6ev56iry3wna - ocid1.tenancy.oc19..aaaaaaaawbsimpiwwrb74ushxhxp2fn7f7oabxwm35hljlzpamrlg5trotvq - ocid1.tenancy.oc19..aaaaaaaaenqiv7qsi7cpcw326pwbdl46356byjqoa2tsmqamqemdl36d7koq - ocid1.tenancy.oc20..aaaaaaaabhdl6ztoavfdst5gipqtotk66qnfdhoyurhlrfoomeqfkkvzvohq - ocid1.tenancy.oc20..aaaaaaaam2e3sdkgg42ctapcwk3wdo4nrfmvbx5gtzinuezo556vgj3ofoxq - ocid1.tenancy.region1..aaaaaaaaghe2rzfj245axceigol3iko2lbmztp7i2jk4uuifqsrwkpvius5q - ocid1.tenancy.region1..aaaaaaaa4fqzmpqa5wlv7memcteya5jhqjgioarjpebglghgrgkphnbvw6aq - ocid1.tenancy.oc1..aaaaaaaaic463fmg625fezvzeosmm4f6wiexdgnasm5xhinhm575wuyml7ea - ocid1.tenancy.oc1..aaaaaaaartv6j5muce2s4djz7rvfn2vwceq3cnue33d72isntnlfmi7huv7q - ocid1.tenancy.oc4..aaaaaaaaykurmmyfjwsrnm2gcjwr7vvgwsdyzoyhxllabjavrbpk6us3tk2q - ocid1.tenancy.oc5..aaaaaaaamtu46djvokzv4zw7wj32blz4ftbjnp6wo5hozemt7mrgkucivcra - ocid1.tenancy.oc8..aaaaaaaamkxizodo6t3wnqzymrjgyjxu4bhnmd65awz3x2isaxkm4gkkpyza - ocid1.tenancy.oc9..aaaaaaaaimlhydjbpwwyfbuem3hhwf3j5jjfyhgjn5sbkqcoqko53wf77iqq - ocid1.tenancy.oc10..aaaaaaaayqfholaircj7jfgg5ywqlapv4oylugev5olwu6si3mmnkmirnfya - ocid1.tenancy.oc14..aaaaaaaajfujnvfdzqf2pi3lwugr2nayovmectesygake4sscdop65upusva - ocid1.tenancy.oc16..aaaaaaaagmong2nldsdc3ksfxx5pckgyf23mz2krhivmnhvxd62gviuf43ba - ocid1.tenancy.oc17..aaaaaaaakfug5hc2mkd6evrjgiqfzlfao3hupdx52bt4cdecybrnyj2si64a - ocid1.tenancy.oc19..aaaaaaaamgknwl7bxuwuodcytylxngeic4xj66tlr5rzqjx425iljpm5aita - ocid1.tenancy.oc20..aaaaaaaau4ils255vwllbgtil4ybgy45qtaw6v5ni2phbvaowmczp7wogfeq - ocid1.tenancy.region1..aaaaaaaacubxsqf4fqbsld7l4cne3wprluuxyu7l7k7jpukfxc63iirbwuka x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string location: description: URL of the newly asynchronously created resource. You can use this to query its status. type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' 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 opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: A decimal number representing the number of seconds the client should wait before polling this endpoint again. type: integer x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The defined tags associated with this resource, if any. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}` ' type: object freeformTags: additionalProperties: type: string description: 'The freeform tags associated with this resource, if any. Each tag is a simple key-value pair with no predefined name, type, or namespace/scope. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` ' type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'The system tags associated with this resource, if any. The system tags are set by Oracle cloud infrastructure services. Each key is predefined and scoped to namespaces. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{orcl-cloud: {free-tier-retain: true}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: com.oracle.pic.cloudbridge